webpack引入第三方库的方式，以及注意事项

时间 2019-11-08

标签 webpack 引入第三方方式以及注意事项繁體版

原文原文链接

通常状况下，咱们不用担忧所使用的第三方库，在npm管理仓库中找不到。css

若是须要某一个库，如：jquery，能够直接运行npm install jquery脚本命令来安装这个项目所须要的依赖；html

而后，在使用jquery的模块文件中，经过import $ from 'jquery'或者var $ = require('jquery')来引入。node

这是经常使用的在webpack构建的项目中引入第三方库的方式。jquery

注：为了更好的演示示例代码，示例是在nodemon这篇文章的基础上操做的。webpack

可是，在不一样的场景下，对webpack构建的项目有不一样的需求:git

项目的体积足够小(cdn)

若是是webapck的处理方式，可参考webapck——实现构建输出最小这篇文章。github

使用非webapck的处理方式，如：CDN。web

操做也很简单，若是使用html-webpack-plugin直接在模板文件template/index.html中引入某个cdn（如：boot CDN）上的某个第三方库（如：jquery），参考代码以下：npm

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>third party</title>
</head>
<body>
    <script src="https://cdn.bootcss.com/jquery/3.3.1/jquery.min.js"></script>
</body>
</html>

而后，在module.js中使用jquery便可，参考代码以下：浏览器

require('./module.css');
module.exports = function() {
    $(document.body).append('<h1>hello webpack</h1>')    
}

最后，运行npm run test，构建结束后，你会在浏览器中看到hello webpack字样，背景是红色的页面效果。

全局环境下使用第三方库（provide-plugin or imports-loader）

为了不每次使用第三方库，都须要用import或者require()引用它们，能够将它们定义为全局的变量。

而webpack的ProvidePlugin内置的插件，能够解决这个问题。详情可参考ProvidePlugin这篇文章的介绍。

避免于cdn引用的jquery冲突，这里使用lodash。

首先，安装lodash依赖，命令以下：

yarn add lodash --dev

而后，在webpack.config.js中，添加以下代码：

new webpack.ProvidePlugin({
        _: 'lodash'
}),

其次，在module.js中添加以下代码：

...
var arr = [1, 2, 3, 4, 5 ,6];
// provide-plugin
$(document.body).append('<h1>' + _.concat(arr, '~') + '</h1');
...

最后，运行npm run test脚本命令，构建完成后，你就能够浏览器的页面中增长了1,2,3,4,5,6,~。

若是，你想指定lodash的某个工具函数能够全局使用，如：_.concat，

首先，像下面这样修改webapck.config.js，代码以下：

...
new webpack.ProvidePlugin({
        // _: 'lodash',
        _concat: ['lodash', 'concat']
}),
...

而后，修改module.js，代码以下：

...
var arr = [1, 2, 3, 4, 5 ,6];
// provide-plugin
// $(document.body).append('<h1>' + _.concat(arr, '~') + '</h1');
$(document.body).append('<h1>' + _concat(arr, '~') + '</h1');
...

若是不喜欢用插件的，也能够考虑使用import-loader，它也能够实现相同的目的。

为了不没必要要的干扰，可使用underscore来演示。

首先，安装imports-loader依赖，命令以下：

yarn add imports-loader --dev

而后，安装underscore依赖，命令以下：

yarn add underscore

其次，在webapck.config.js中添加以下代码：

...
module: {
        rules: [
                {
                        test: require.resolve('underscore'),
                        use: 'imports-loader?_=underscore'
                },
                ...
        ]
},
...

注：underscore和lodash都是用的是单例的模式开发的，它们实例化的构造函数的名字都是_，为了做区分，须要对其中一个作一下改变。imports-loader对这个标识起别名有点儿困难，而provide-plugin则没有这个问题，能够定一个个性化的别名。

修改webpack.config.js，代码以下：

new webpack.ProvidePlugin({
        // _: 'lodash',
        // _concat: ['lodash', 'concat'],
        __: 'lodash'
}),

能够为lodash定义为__与underscore的_做区分。

而后，修改module.js，代码以下：

...
// provide-plugin
// $(document.body).append('<h1>' + _.concat(arr, '~') + '</h1');
// $(document.body).append('<h1>' + _concat(arr, '~') + '</h1');
$(document.body).append('<h1>' + __.concat(arr, '~') + '</h1');
...

最后，保存全部的文件，能够下浏览器中看到类似的结果（保存后，nodemon自启动浏览器）。

cdn与externals

以前遇到了一些externals的问题，为何要详细的说，是由于不少人不明白它到底用来干什么的。

场景再现：

以前，有一个项目使用了jquery，因为这个库的比较经典，它在应用的各个模块中被频繁引用。使用的方式以下：

import $ from 'jquery'

或者

var $ = require('jquery')

结果是构建结束后，文件比较大。那么考虑使用cdn，如上文描述的那样。这样须要删除import或require的引用，同时删除安装的jquery依赖，可是因为项目结构比较乱，模块比较多，为了不形成少改或者漏改的问题，会形成应用出错。该怎么办呢？

有的人说，不删除jquery依赖，那么使用cdn的目的就没有意义了。而使用external则能够解决这个问题。

能够在module.js文件中添加以下代码：

...
var $ = require('jquery')
...

而后，保存文件，发现构建输出提示以下的错误：

ERROR in ./module.js
Module not found: Error: Can't resolve 'jquery' in 'E:\workspace\me\webpack-play\demo\example-1'
 @ ./module.js 3:0-23
 @ ./main.js
 @ multi (webpack)-dev-server/client?http://localhost:8080 ./main.js

模块module.js中的jquery不能被解析。

紧接着，在webpack.config.js中添加以下代码：

externals: {

jquery: 'jQuery',
    jquery: '$'

其中jquery表明的是require('jquery')中的jquery，而jQuery和$表明的是jquery这个库自身提供的但是实例化的标识符。其它的库的cdn化，修改相似jquery。

可是，若是在项目一开始就决定用cdn的话，就不要在使用jquery的模块中，使用var $ = require('jquery') 或 import $ from 'jquery';，虽然这样作不会报错，可是若是出于某方面的考虑，后期可能会引入jquery依赖，那么就必须使用var $ = require('jquery') 或 import $ from 'jquery';。

参考源代码