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


Posted in Javascript onJanuary 15, 2019

一般情况下,我们不用担心所使用的第三方库,在npm管理仓库中找不到。

如果需要某一个库,如:jquery,可以直接运行npm install jquery脚本命令来安装这个项目所需要的依赖;

然后,在使用jquery的模块文件中,通过import $ from 'jquery'或者var $ = require('jquery')来引入。

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

注:为了更好的演示示例代码,示例是在nodemon这篇文章的基础上操作的。

但是,在不同的场景下,对webpack构建的项目有不同的需求:

项目的体积足够小(cdn)

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

使用非webapck的处理方式,如:CDN。

操作也很简单,如果使用html-webpack-plugin直接在模板文件template/index.html中引入某个cdn(如:boot CDN)上的某个第三方库(如:jquery),参考代码如下:

<!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';

参考源代码

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
js类的静态属性和实例属性的理解
Oct 01 Javascript
加载jQuery后$冲突的解决办法
Jul 09 Javascript
jquery 缓存问题的几个解决方法
Nov 11 Javascript
JS实现获取键盘按下的按键并显示在页面上的方法
Nov 04 Javascript
JS弹出窗口的运用与技巧大全
Nov 01 Javascript
Webpack打包慢问题的完美解决方法
Mar 16 Javascript
JQuery form表单提交前验证单选框是否选中、删除记录时验证经验总结(整理)
Jun 09 jQuery
JS实现图片手风琴效果
Apr 17 Javascript
AngularJS表单验证功能
Oct 19 Javascript
搭建基于express框架运行环境的方法步骤
Nov 15 Javascript
jQuery Migrate 插件用法实例详解
May 22 jQuery
如何解决jQuery 和其他JS库的冲突
Jun 22 jQuery
JS高阶函数原理与用法实例分析
Jan 15 #Javascript
JS立即执行函数功能与用法分析
Jan 15 #Javascript
vue-cli 目录结构详细讲解总结
Jan 15 #Javascript
webpack file-loader和url-loader的区别
Jan 15 #Javascript
jQuery+vue.js实现的多选下拉列表功能示例
Jan 15 #jQuery
Element输入框带历史查询记录的实现示例
Jan 15 #Javascript
微信小程序实现多选删除列表数据功能示例
Jan 15 #Javascript
You might like
PHP4与PHP3中一个不兼容问题的解决方法
2006/10/09 PHP
php精确的统计在线人数的方法
2015/10/21 PHP
最简单的js图片切换效果实现代码
2011/09/24 Javascript
setInterval()和setTimeout()的用法和区别示例介绍
2013/11/17 Javascript
js清除input中type等于file的值域(示例代码)
2013/12/24 Javascript
toggle()隐藏问题的解决方法
2014/02/17 Javascript
在Node.js应用中使用Redis的方法简介
2015/06/24 Javascript
javascript常用经典算法实例详解
2015/11/25 Javascript
JavaScript中eval()函数用法详解
2015/12/14 Javascript
jQuery easyui刷新当前tabs的方法
2016/09/23 Javascript
百度搜索框智能提示案例jsonp
2016/11/28 Javascript
深入理解Nodejs Global 模块
2017/06/03 NodeJs
AngularJS 验证码60秒倒计时功能的实现
2017/06/05 Javascript
解决jquery appaend元素中id绑定事件失效的问题
2017/09/12 jQuery
JS中判断某个字符串是否包含另一个字符串的五种方法
2018/05/03 Javascript
微信小程序之自定义组件的实现代码(附源码)
2018/08/02 Javascript
vue-froala-wysiwyg 富文本编辑器功能
2019/09/19 Javascript
[01:50]2014DOTA2西雅图邀请赛 专访欢乐周宝龙
2014/07/08 DOTA
[01:53]2016完美“圣”典风云人物:Maybe专访
2016/12/05 DOTA
python通过ElementTree操作XML获取结点读取属性美化XML
2013/12/02 Python
Python编程实现双击更新所有已安装python模块的方法
2017/06/05 Python
Flask解决跨域的问题示例代码
2018/02/12 Python
Python中使用Counter进行字典创建以及key数量统计的方法
2018/07/06 Python
使用python实现抓取腾讯视频所有电影的爬虫
2019/04/15 Python
Python函数参数匹配模型通用规则keyword-only参数详解
2019/06/10 Python
使用 Python 清理收藏夹里已失效的网站
2019/12/03 Python
如何给Python代码进行加密
2020/01/10 Python
django rest framework serializers序列化实例
2020/05/13 Python
keras 如何保存最佳的训练模型
2020/05/25 Python
英国音乐设备和乐器商店:Gear4music
2017/10/16 全球购物
行政主管职责范本
2014/03/07 职场文书
元宵节主持词
2014/03/25 职场文书
酒店开业主持词
2015/07/02 职场文书
优质服务标语口号
2015/12/26 职场文书
使用Redis做预定库存缓存功能
2022/04/02 Redis
tree shaking对打包体积优化及作用
2022/07/07 Java/Android