实用webpack插件之ProvidePlugin(webpackdefineplugin)
ztj100 2024-11-12 14:22 14 浏览 0 评论
现代化前端的全局引入是一个很有趣的东西。 先来看下以下几个场景:
- 在webpack中,我们可以在resolve的alias中定义一个层级较高的目录为一个自定义变量。例如resolve: { alias: { '@': path.join(__dirname, '..', 'src') }}。
- 在webpack中,我们也可以通过DefinePlugin将配置文件按照环境变量进行区分,高效的完成配置文件的按环境引入,无论是开发构建还是生产构建,都十分有用。
- 在vue中,我们可以将一个常用的方法或者库定义在Vue.ptototye上,可以通过直写属性,也可以通过vue中的plugin install上去。例如Vue.prototype.$_ = lodash,在应用了vue的应用上下文中,可以通过this.$_获得对lodash的引用。
- 在vue中,还有mixins,inject以及vuex等等这些全局绑定或者叫混入、注入方式的全局引入的实现。
来思考一个问题:
如果我们再Vue.prototype上绑定了太多,太大的第三方库,会不会导致root vue过大?
答案是肯定的。
有没有办法解决这个问题?
你可能会说,我不用this.xxx。用到的vue单文件组件直接import或者require就好了。
如果数以百计,数以千计甚至是数以万计的.vue文件中用到了呢?一直引入吗?
可以一直引入。但是会造成不必要的工作量。
有没有更加优雅的解决办法?
再来思考一个问题:
如果我要在一个webpack打包覆盖的地方的xxx.js文件中用到lodash,该怎么做?
通常来讲,我们会直接`import _ from' lodash'`或者`const _ = require('lodash')`。
如果和.vue一样,有很多很多js文件需要引入呢?一直引入吗?
可以一直引入。同样会造成不必要的工作量。
有没有更加优雅的实现方式?
看一张一直引入moment,引了99次的图先来感受一下:
虽然我的项目中是在优化moment的引入,但是为了直观明了,我将以引入lodash为例。
- 使用ProvidePlugin的三种方式
- 为何一直引入造成不必要工作量
- 使用ProvidePlugin引入实践
- webpack的plugins中增加$_的配置
- eslint的globals增加$_的配置
- 在Vue中如何使用$_
- 在Vue的template中使用的注意事项
- 为什么这个是最推荐的呢?
- 那为什么不挂载到data上呢?
- 思考
- 使用ProvidePlugin后会比一直引入减小打包体积吗?
- 使用ProvidePlugin有哪些注意事项?
- 注入的ProvidePlugin是一个什么东西?
使用ProvidePlugin的三种方式
// 语法
new webpack.ProvidePlugin({
identifier: 'module1',
// identifier: ['module1', 'property1'],
});
- module.exports
- 直接引入
- 引入某个函数
- export default
module.exports
直接引入
new webpack.ProvidePlugin({
$_: 'lodash',
});
引入某个函数
new webpack.ProvidePlugin({
$_uniqBy: ['lodash','uniqBy']
});
export default
new webpack.ProvidePlugin({
Vue: ['vue/dist/vue.esm.js', 'default']
});
为何一直引入造成不必要工作量
加入我们有a~z,a.js到z.js总结26个js文件,每个文件都需要引入lodash。
// a.js
import $_ from 'lodash';
// b.js
import $_ from 'lodash';
// c.js
import $_ from 'lodash';
// d.js
import $_ from 'lodash';
// e.js
import $_ from 'lodash';
// f.js
import $_ from 'lodash';
...
// z.js
import $_ from 'lodash';
这样做有以下几个弊端
- 要乖乖引入26次
- import进来之后的自定义名称可能会不统一,导致全局搜索困难
比如说下面这种场景,对于代码可读性是很不好的。
// a.js
import $_ from 'lodash';
// b.js
import _ from 'lodash';
使用ProvidePlugin引入实践
- webpack的plugins中增加$_的配置
- eslint的globals增加$_的配置
- 在Vue中如何使用$_
- 在Vue的template中使用的注意事项
webpack的plugins中增加$_的配置
// webpack.base.config.js
plugins: [
new webpack.ProvidePlugin({
$_: 'lodash',
}),
],
eslint的globals增加$_的配置
// .eslintrc.js
globals: {
$_: 'readonly', // 或者true
},
配置为readonly是因为我们不会改写lodash,仅仅是调用其方法。
在Vue中如何使用$_
假设在a.js中。 删除单独的lodash引入 _ :import _ from 'lodash' script中直接使用:‘_.uniqBy(...)` template的使用事项可以看下文。
在Vue的template中使用的注意事项
ProvidePlugin注入的全局变量,在script中是完全没有问题的,但是在template中使用时会有一些小问题。
例如下面这样:
<p>{{$_(...)}</p>
data() {
return {
$_,
}
}
遇到这种情况是什么原因呢? Vue的模板语法中,不支持直接对以$或者_开头的自定义data属性,目的是避免与Vue的内部冲突。
[Vue warn]:
Property "$_" must be accessed with "$data.$_".
Because properties starting with "#34; or "_" are not proxied in the Vue instance to prevent conflicts with Vue internals
有以下几种方式解决这个问题:
- 通过$data.$_访问
- data中重命名后绑定
- methods中绑定(最推荐)
通过$data.$_访问
<p>{{$data.$_(...)}</p>
data中重命名后绑定
<p>{{globalLodash(...)}</p>
data() {
return {
globalLodash: $_,
}
}
methods中绑定(最推荐)
<p>{{$_(...)}</p>
methods: {
$_
}
为什么这个是最推荐的呢?
这是因为ProvidePlugin最终返回给我们的,是一个hooks函数。
hooks () {
return hookCallback.apply(null, arguments);
}
既然是一个函数,那么它其实就是一个method。 由于需要在vue的template中使用,所以需要将其挂载到vue实例上。 因此直接在methods中绑定,挂载到vue示例。
那为什么不挂载到data上呢?
避免额外的无用的开销。 这是因为data是用来定义一些响应式的数据的,我们的$_只是一个工具函数,不会有双向绑定的事情发生在它身上,因此也不需要定义在data中,vue不用为其定义单独的watcher,dep,getter,setter等等。
思考
注入的ProvidePlugin是一个什么东西?
是一个hooks函数。
hooks () {
return hookCallback.apply(null, arguments);
}
使用ProvidePlugin后会比一直引入减小打包体积吗?
不会。 反而会略微增大一些,0.0X KB。 这是我自己对比使用ProvidePlugin前和使用ProvidePlugin后打包文件体积大小得出的结论。
使用ProvidePlugin有哪些注意事项?
这些注意事项其实主要是为了增强代码可读性和可维护性。
- 尽量定义出唯一性高的全局变量,例如,?moment
- 同一个前端小组的成员都采用全局变量的方式引入
- 最好是能维护一个全局变量的文档,在新人入职时特殊强调
看到这里,文章开头Vue.prototype.xxx和import和require重复引入的问题”有没有更加优雅的实现方式?“就迎刃而解啦。
快到你的项目中试试ProvidePlugin吧~
期待和大家交流,共同进步,欢迎大家加入我创建的与前端开发密切相关的技术讨论小组:
SegmentFault专栏:趁你还年轻,做个优秀的前端工程师
知乎专栏:趁你还年轻,做个优秀的前端工程师
Github博客: 趁你还年轻233的个人博客
微信公众号: 大大大前端 / excellent_developers
努力成为优秀前端工程师!
相关推荐
- 再说圆的面积-蒙特卡洛(蒙特卡洛方法求圆周率的matlab程序)
-
在微积分-圆的面积和周长(1)介绍微积分方法求解圆的面积,本文使用蒙特卡洛方法求解圆面积。...
- python创建分类器小结(pytorch分类数据集创建)
-
简介:分类是指利用数据的特性将其分成若干类型的过程。监督学习分类器就是用带标记的训练数据建立一个模型,然后对未知数据进行分类。...
- matplotlib——绘制散点图(matplotlib散点图颜色和图例)
-
绘制散点图不同条件(维度)之间的内在关联关系观察数据的离散聚合程度...
- python实现实时绘制数据(python如何绘制)
-
方法一importmatplotlib.pyplotaspltimportnumpyasnpimporttimefrommathimport*plt.ion()#...
- 简单学Python——matplotlib库3——绘制散点图
-
前面我们学习了用matplotlib绘制折线图,今天我们学习绘制散点图。其实简单的散点图与折线图的语法基本相同,只是作图函数由plot()变成了scatter()。下面就绘制一个散点图:import...
- 数据分析-相关性分析可视化(相关性分析数据处理)
-
前面介绍了相关性分析的原理、流程和常用的皮尔逊相关系数和斯皮尔曼相关系数,具体可以参考...
- 免费Python机器学习课程一:线性回归算法
-
学习线性回归的概念并从头开始在python中开发完整的线性回归算法最基本的机器学习算法必须是具有单个变量的线性回归算法。如今,可用的高级机器学习算法,库和技术如此之多,以至于线性回归似乎并不重要。但是...
- 用Python进行机器学习(2)之逻辑回归
-
前面介绍了线性回归,本次介绍的是逻辑回归。逻辑回归虽然名字里面带有“回归”两个字,但是它是一种分类算法,通常用于解决二分类问题,比如某个邮件是否是广告邮件,比如某个评价是否为正向的评价。逻辑回归也可以...
- 【Python机器学习系列】拟合和回归傻傻分不清?一文带你彻底搞懂
-
一、拟合和回归的区别拟合...
- 推荐2个十分好用的pandas数据探索分析神器
-
作者:俊欣来源:关于数据分析与可视化...
- 向量数据库:解锁大模型记忆的关键!选型指南+实战案例全解析
-
本文较长,建议点赞收藏,以免遗失。更多AI大模型应用开发学习视频及资料,尽在...
- 用Python进行机器学习(11)-主成分分析PCA
-
我们在机器学习中有时候需要处理很多个参数,但是这些参数有时候彼此之间是有着各种关系的,这个时候我们就会想:是否可以找到一种方式来降低参数的个数呢?这就是今天我们要介绍的主成分分析,英文是Princip...
- 神经网络基础深度解析:从感知机到反向传播
-
本文较长,建议点赞收藏,以免遗失。更多AI大模型应用开发学习视频及资料,尽在...
- Python实现基于机器学习的RFM模型
-
CDA数据分析师出品作者:CDALevelⅠ持证人岗位:数据分析师行业:大数据...
你 发表评论:
欢迎- 一周热门
- 最近发表
- 标签列表
-
- idea eval reset (50)
- vue dispatch (70)
- update canceled (42)
- order by asc (53)
- spring gateway (67)
- 简单代码编程 贪吃蛇 (40)
- transforms.resize (33)
- redisson trylock (35)
- 卸载node (35)
- np.reshape (33)
- torch.arange (34)
- npm 源 (35)
- vue3 deep (35)
- win10 ssh (35)
- vue foreach (34)
- idea设置编码为utf8 (35)
- vue 数组添加元素 (34)
- std find (34)
- tablefield注解用途 (35)
- python str转json (34)
- java websocket客户端 (34)
- tensor.view (34)
- java jackson (34)
- vmware17pro最新密钥 (34)
- mysql单表最大数据量 (35)