百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术分类 > 正文

实用webpack插件之ProvidePlugin(webpackdefineplugin)

ztj100 2024-11-12 14:22 28 浏览 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

努力成为优秀前端工程师!

相关推荐

sharding-jdbc实现`分库分表`与`读写分离`

一、前言本文将基于以下环境整合...

三分钟了解mysql中主键、外键、非空、唯一、默认约束是什么

在数据库中,数据表是数据库中最重要、最基本的操作对象,是数据存储的基本单位。数据表被定义为列的集合,数据在表中是按照行和列的格式来存储的。每一行代表一条唯一的记录,每一列代表记录中的一个域。...

MySQL8行级锁_mysql如何加行级锁

MySQL8行级锁版本:8.0.34基本概念...

mysql使用小技巧_mysql使用入门

1、MySQL中有许多很实用的函数,好好利用它们可以省去很多时间:group_concat()将取到的值用逗号连接,可以这么用:selectgroup_concat(distinctid)fr...

MySQL/MariaDB中如何支持全部的Unicode?

永远不要在MySQL中使用utf8,并且始终使用utf8mb4。utf8mb4介绍MySQL/MariaDB中,utf8字符集并不是对Unicode的真正实现,即不是真正的UTF-8编码,因...

聊聊 MySQL Server 可执行注释,你懂了吗?

前言MySQLServer当前支持如下3种注释风格:...

MySQL系列-源码编译安装(v5.7.34)

一、系统环境要求...

MySQL的锁就锁住我啦!与腾讯大佬的技术交谈,是我小看它了

对酒当歌,人生几何!朝朝暮暮,唯有己脱。苦苦寻觅找工作之间,殊不知今日之事乃我心之痛,难道是我不配拥有工作嘛。自面试后他所谓的等待都过去一段时日,可惜在下京东上的小金库都要见低啦。每每想到不由心中一...

MySQL字符问题_mysql中字符串的位置

中文写入乱码问题:我输入的中文编码是urf8的,建的库是urf8的,但是插入mysql总是乱码,一堆"???????????????????????"我用的是ibatis,终于找到原因了,我是这么解决...

深圳尚学堂:mysql基本sql语句大全(三)

数据开发-经典1.按姓氏笔画排序:Select*FromTableNameOrderByCustomerNameCollateChinese_PRC_Stroke_ci_as//从少...

MySQL进行行级锁的?一会next-key锁,一会间隙锁,一会记录锁?

大家好,是不是很多人都对MySQL加行级锁的规则搞的迷迷糊糊,一会是next-key锁,一会是间隙锁,一会又是记录锁。坦白说,确实还挺复杂的,但是好在我找点了点规律,也知道如何如何用命令分析加...

一文讲清怎么利用Python Django实现Excel数据表的导入导出功能

摘要:Python作为一门简单易学且功能强大的编程语言,广受程序员、数据分析师和AI工程师的青睐。本文系统讲解了如何使用Python的Django框架结合openpyxl库实现Excel...

用DataX实现两个MySQL实例间的数据同步

DataXDataX使用Java实现。如果可以实现数据库实例之间准实时的...

MySQL数据库知识_mysql数据库基础知识

MySQL是一种关系型数据库管理系统;那废话不多说,直接上自己以前学习整理文档:查看数据库命令:(1).查看存储过程状态:showprocedurestatus;(2).显示系统变量:show...

如何为MySQL中的JSON字段设置索引

背景MySQL在2015年中发布的5.7.8版本中首次引入了JSON数据类型。自此,它成了一种逃离严格列定义的方式,可以存储各种形状和大小的JSON文档,例如审计日志、配置信息、第三方数据包、用户自定...

取消回复欢迎 发表评论: