详细介绍webpack的插件ProvidePlugin

2023-09-21 13:42:37

下面我将详细介绍下 webpack插件ProvidePlugin的使用和优缺点

参考地址 实用webpack插件之ProvidePlugin

现代化前端的全局引入是一个很有趣的东西。
先来看下以下几个场景:

  • 在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引入实践

    • 为什么这个是最推荐的呢?

    • 那为什么不挂载到data上呢?

    • webpack的plugins中增加$_的配置

    • eslint的globals增加$_的配置

    • 在Vue中如何使用$_

    • 在Vue的template中使用的注意事项

    • 思考

      • 使用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.jsimport $_ from 'lodash';// b.jsimport $_ from 'lodash';// c.jsimport $_ from 'lodash';// d.jsimport $_ from 'lodash';// e.jsimport $_ from 'lodash';// f.jsimport $_ from 'lodash';
    ...// z.jsimport $_ from 'lodash';

    这样做有以下几个弊端

    • 要乖乖引入26次

    • import进来之后的自定义名称可能会不统一,导致全局搜索困难

    比如说下面这种场景,对于代码可读性是很不好的。

    // a.jsimport $_ from 'lodash';// b.jsimport _ from 'lodash';

    使用ProvidePlugin引入实践

    • webpack的plugins中增加$_的配置

    • eslint的globals增加$_的配置

    • 在Vue中如何使用$_

    • 在Vue的template中使用的注意事项

    webpack的plugins中增加$_的配置

    // webpack.base.config.jsplugins: [    new webpack.ProvidePlugin({      $_: 'lodash',
        }),
    ],

    eslint的globals增加$_的配置

    // .eslintrc.jsglobals: {    $_: '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 "$" 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重复引入的问题”有没有更加优雅的实现方式?“就迎刃而解啦。


    • 2021-02-03 16:57:34

      iOS中的动态库和静态库分析

      由于最近研究组件化后调试时二进制映射源码的功能,发现需要对开发中的动态库和静态库需要有一些了解。所以就有了这篇文章,由于只是了解,并没有深入到编译层面,所以本篇文章只是简单了解一些库的知识,并不深入。

    • 2021-02-03 16:58:39

      iOS静态库与动态库的区别与打包

      这篇主要是记录一下 iOS 下静态库与动态库的打包流程,以便以后用到时快速查阅,供自己也供大家学习记录。同时也简述了一下 动态库 与 静态库 的区别。

    • 2021-02-03 16:59:59

      iOS 静态库和动态库全分析

      库就是程序代码的集合,将 N 个文件组织起来,是共享程序代码的一种方式。从本质上来说是一种可执行代码的二进制格式,可以被载入内存中执行。

    • 2021-02-03 17:01:30

      iOS库 .a与.framework区别

      静态库:连接时完整地拷贝至可执行文件中,被屡次使用就有多份冗余拷贝。 动态库:连接时不复制,程序运行时由系统动态加载到内存,供程序调用,系统只加载一次,多个程序共用,节省内存。

    • 2021-02-03 17:13:58

      iOS - 封装静态库

      静态库:链接时完整的拷贝至可执行文件中,被多次使用就有多份冗余拷贝,.a的静态库 .framework的静态库

    • 2021-02-03 17:16:07

      iOS 中的动态库、静态库和 framework

      首先来看什么是库,库(Library)说白了就是一段编译好的二进制代码,加上头文件就可以供别人使用。 什么时候我们会用到库呢?一种情况是某些代码需要给别人使用,但是我们不希望别人看到源码,就需要以库的形式进行封装,只暴露出头文件。另外一种情况是,对于某些不会进行大的改动的代码,我们想减少编译的时间,就可以把它打包成库,因为库是已经编译好的二进制了,编译的时候只需要 Link 一下,不会浪费编译时间。

    • 2021-02-03 17:17:53

      iOS 同一个工程下打包不同的app

      应用图标,启动画面,应用启动后的首页都不一样。 有些课程(例如公务员考试和高考)是有目标考试的概念,不同的目标考试大纲是不一样的。拿高考来举例,北京的高考和上海的高考,就有着完全不一样的考试大纲。高考的文科和理科,又有着完全不同的考试科目。 有些课程会有一些自定义的界面,例如高考的应用可以设置昵称,有些课程的真题练习中是有推荐真题模块的,而有些课程又没有。 有些课程有扫描答题卡功能,有些课程有考前冲刺功能,有些课程有大题专项查看功能,而有些课程又没有上述功能。另外还有一些微小细节,但是解决方法和类似,所以就不一一展开说明。

    • 2021-02-04 14:02:30

      window软件界面找不到了跑到屏幕外面去了

      一般可以这样操作,按Alt+空格,然后按M,然后用上下左右键把窗口移动到能看到的地方,再按回车。有些第三方的软件可能不能用,大部分都可以这样做。

    • 2021-02-04 14:08:13

      基于 Electron 的爬虫框架 Nightmare

      Electron 可以让你使用纯 JavaScript 调用 Chrome 丰富的原生的接口来创造桌面应用。你可以把它看作一个专注于桌面应用的 Node.js 的变体,而不是 Web 服务器。其基于浏览器的应用方式可以极方便的做各种响应式的交互,接下来介绍下关于 Electron 上衍生出的框架 Nightmare