资讯专栏INFORMATION COLUMN

上云采购季！| 爆款云服务器低至4.6元/月，首单享0.9折

免费试用
首页/文章专栏/实现element-ui的按需引入，按需打包加载

实现element-ui的按需引入，按需打包加载

TesterHome / 1551人阅读

摘要：简单说明原理使用实现按需引入打包。这里采用多入口配置，实现各个功能模块分别打包成一个文件，并使用将样式进行抽离后，按入口进行打包为对应的文件。只要在指定入口名为。这个相关配置已经发布了包。

简单说明原理： 
使用babel-plugin-component实现按需引入、打包。
将webpack配置成多入口，保证最终打包的目录结构符合babel-plugin-component插件的要求，实现按需加载
element源码关于按需引入的研究：

1、build目录中是cooking配置文件，cooking是饿了么前端研发的基于webpack的前端构建工具，我们使用原始的webpack实现。此处源码忽略。

2、example中是element项目的例子存放，打开element网页，可看见的项目入口。

3、packages目录中，是所有的功能模块，以alert模块为例，分析目录结构

alert模块目录，有一个index.js作为模块入口，在入口处，引入src目录中的主要组件，再对该组件进行拓展，增加install方法，我们知道，在对vue进行扩展，使用vue.use(...)时，vue内部会调用插件的install方法，此处给alert组件增加install方法，则最终打包完成后，按需引入alert功能组件时，可以使用vue.use(alert)进行注册组件到全局。
其他功能模块的目录结构也大同小异，在入口处对组件进行install扩展。

4、src目录中存放一些公共的mixin等工具和一个index.js入口文件，这个入口文件是打包后兼具所有功能组件的入口，上源码，一个一个分析：

首先将packages中的各个功能模块引入


定义一个install方法，在此方法中，将所有的功能模块进行注册。

components.map(component => {
    Vue.component(component.name, component);
});

遍历注册

Vue.prototype.$loading = Loading.service;
Vue.prototype.$msgbox = MessageBox;
Vue.prototype.$alert = MessageBox.alert;
Vue.prototype.$confirm = MessageBox.confirm;
Vue.prototype.$prompt = MessageBox.prompt;
Vue.prototype.$notify = Notification;
Vue.prototype.$message = Message;

Vue.prototype.$ELEMENT = ELEMENT;

对vue原型进行扩展，使vue实例中可直接使用this.$alert等便捷方法。


最后，将所有功能模块和install方法一起导出。这样当引入element-ui时，便可以使用vue.use(element-ui)进行注册，即将所有的功能组件进行全局注册。

5、lib目录是按babel-plugin-component插件要求打包后存放最终代码的目录。
详细看看这个目录中的结构

目录中，将各个功能模块打包成了一个.js文件，在theme-chalk中，存放这名称和功能模块相同的.css文件。为何要这样打包？？这就进入了我们的重点，看看babel-plugin-component插件的文档：


import { Button } from "antd" 会被解析成同时引入antd/lib/button/index.js和引入lib/button/style.css
这就是这个插件为我们带来的按需引入的功能。插件会去解析你的代码，当你引入的是配置的modules中的某一部分时，自动为你解析，只为你的项目引入你指定的部分。
这个插件有几种目录结构的配置方案，刚刚解释的只是其中一种，我们来看element-ui采用的也是我们要使用的一种：

在lib下，存在几个模块componentA、componentB，当引入import {componentA} from "..."时，会被解析成从lib/componentA,此时，这个componentA若是目录，则进入目录找目录入口，也就是index.js，若componentA是个.js文件，则直接引入这个文件。
样式文件会通过你的bablerc配置，从lib中指定的目录中去引入同名文件
看看bablerc中的相关配置：


在plugins中，增加component配置，component相关option配置：


看看element官网说明的配置：


配置了libraryName和styleLibraryName。

好，到此element的分析及babel-plugin-componentbable插件的说明暂时告一段落。
咱们继续看我们如何去实现。

个人实现，按需引入
目录结构：

项目是用vue-cli搭建的项目：
1、build中是webpack相关配置
2、example目录是开发时调试用
3、src目录中components中是各个功能模块，各功能模块的入口中同element一样，对组件进行扩展，增加install方法，将组件进行全局注册，index.js是入口，其中引入所有功能模块，同时导出模块和install方法，将所有模块进行注册。
4、lib中是最终打包的目标目录
5、增加components.json文件


记录将要打包的功能模块名称和路径

webpack相关配置更改

规划中，需要将各个模块打包至lib，一个功能模块为一个.js文件，并且在theme目录中存在一个同名的.css文件，这样使用时借助babel-plugin-component插件就可实现按需引入。还需要一个总的index.js包含所有的功能模块，和一个index.css包含所有的样式。
这里采用多入口(entry)配置，实现各个功能模块分别打包成一个.js文件，并使用extract-text-webpack-plugin将样式进行抽离后，按入口chunk进行打包为对应的.css文件。
当将需要打包至一起是，使用单个入口，抽离所有css到一个css文件。
所以完成打包目标需要执行两个打包命令，看package.json相关配置：

"scripts": {
    "dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js",
    "start": "npm run dev",
    "build": "node build/build.js",
    "build_all": "node build/build.js all"
 }

npm run build进行将各个模块打包为各自的.js文件，样式文件也同时抽离处理为同名的.css，npm run build_all将所有的功能打包为index.js和index.css

上webpack详细配置更改代码：


首先在config中将assetsRoot，output的路径设置为lib

在build.js中，获取命令行参数，根据参数判断需要进行的打包任务，下面详细介绍webpack.prod.conf和webpack.prodAll.conf文件

webpack.prod.conf


1、删除HtmlWebpackPlugin相关配置，这里只需打包为js文件和css文件，不涉及html
2、引入components.json，根据配置的模块及路径配置入口entrys，配置完后，将入口写入entry配置
3、ExtractTextPlugin插件是进行css抽离的，这里不用处理
4、ouput中，出口.js文件的名称不能写死

5、在plugins插件配置处，ExtractTextPlugin相关配置，filename不能写死，需要根据chunk名称自动生成对应名称。这里设置为"/theme/[name].css"指定目录lib/theme存放

webpack.prodAll.conf

1、同样删除html相关配置


注意入口配置，设置为src/index.js这个文件中引入了所有的功能模块。
output和抽离css的配置中的filename写死成index也可，写成[name]按chunk名也可，因为入口只有一个。只要在entry指定入口名为index。

到此，webpack配置就差不多完成了。最后上一个打包完成后的目录结构：


这样，在使用时，只需要引入babel-plugin-component插件，并进行配置，配置中，指定libraryName为库名，指定styleLibraryName为theme即可。

这个相关配置已经发布了npm包。其中只有两个功能组件，一个upload，一个input。
有读者想要试按需引入功能的可以按如下配置：
1、bable配置：

2、引入时：

本文完成啦，希望能对你有所帮助～～学无止境，大家共勉

特别说明 
1、相关代码已经发布至github，地址：https://github.com/yuanalina/installAsRequired
2、打包时需要注意名称命名需要使用kebab-case (短横线分隔命名)格式，例如：button-model,在components.json配置中，需要使用短横线分隔命名；
3、在后续的配置中我进行了优化，把整体打包和各组件分离打包整合到了一起，更改的地方为：在components.json中增加"index": "./src/index.js"即可。详见github
服务器托管 云服务器 cdn按需打包js 按需加载 按需加载javascript webpack按需加载

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/96595.html

相关文章

  • Vue组件库开发总结

    摘要：组件库开发总结由于工作需要，最近在学习怎么开发一个组件库。按需打包的使用要使用按需打包，不仅组件库的打包需要做处理，项目中也需要做处理。 Vue组件库开发总结 由于工作需要，最近在学习怎么开发一个Vue组件库。主要需要实现以下点：1.组件使用npm包引入2.实现按需引入及按需打包项目中许多实现是参考的element-ui，特别是webpack打包部分 组织项目 项目生成 项目生成是直接...

    longshengwang 评论0 收藏0

  • vue2首页加载慢的问题

    摘要：开发完了，并部署到服务器后，就遇到了一个非常明显的问题。所以可以利用按需加载来进一步缩小文件的体积。另外图片还可以去下面这个网上压缩一下经过上述的几步，首页的加载速度已经比较快了，项目经理也比较满意。初步结束了首页加载慢的问题的研究。 本次开发的项目中使用了vue2.5.2和自带的vue-cli生成了前端的基本架构。随后在项目开发当中，添加了自己写的UI组件，和复杂的业务逻辑。整个项目...

    canopus4u 评论0 收藏0

  • webpack+vue项目实战（三，配置功能操作页和组件的按需加载）

    摘要：但是实际上，回款管理和开票管理的组件文件也是加载了。所以下面引用按需加载来处理。是不是小很多了，然后和是按需加载的，就是需要的时候才加载。 1.前言 上篇文章（webpack+vue项目实战（二，开发管理系统主页面）），实现了，侧边栏的一个操作，点击侧边栏的一些操作，最重要的就是路由的切换。看了上一篇的伙伴也不难发现，除了点击侧边栏‘首页’之外，点击其它的都是白色的一片。原因我想大家都...

    endless_road 评论0 收藏0

  • 使用nuxt开发博客后台管理系统（一）element ui的使用

    摘要：进入主题使用我们在创建项目时已经选择安装了，安装完就能使用了。 注：文章中的nuxt为2.0.0版本 众所周知vue单页面应用的seo很不友好，每次打开页面先获取的节点也就是一个,而这对想用vue做spa又想拥有友好搜索引擎seo优化的人来说就好比鸡肋。好在vue的官方出了nuxt，既能让我们使用spa又能拥有良好的搜索引擎优化；nuxt介绍->https://zh.nuxtjs.or...

    Freeman 评论0 收藏0

  • 教你搭建按需加载的Vue组件库

    摘要：先来看看是怎么做的，官方的的快速手上使用一个了插件，作用就是代码转换转换为到这我们可以知道，要搭建一个按需加载的组件库。 按需加载的原理 按需加载，本质上是把一个组件库的不同组件拆分成不同文件，按照需要引用对应的文件，而该文件暴露一个install方法，供Vue.use使用。比如：我只想引用element库里的一个Button组件 import Button from element-...

    宋华 评论0 收藏0

发表评论

登陆后可评论

0条评论

TesterHome

男|高级讲师
我要私信

TA的文章

阅读更多
最新活动
阅读需要支付1元查看
<