详解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控制css中的float的代码
Aug 16 Javascript
在js(jquery)中获得文本框焦点和失去焦点的方法
Dec 04 Javascript
iframe窗口高度自适应的实现方法
Jan 08 Javascript
JavaScript获取网页表单提交方式的方法
Apr 02 Javascript
BootStrap智能表单实战系列(四)表单布局介绍
Jun 13 Javascript
JS图片定时翻滚效果实现方法
Jun 21 Javascript
jQuery中的AjaxSubmit使用讲解
Sep 25 Javascript
react.js使用webpack搭配环境的入门教程
Aug 14 Javascript
AngularJS实现的获取焦点及失去焦点时的表单验证功能示例
Oct 25 Javascript
vue watch监听对象及对应值的变化详解
Feb 24 Javascript
es6 filter() 数组过滤方法总结
Apr 03 Javascript
Openlayers实现测量功能
Sep 25 Javascript
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
php zend解密软件绿色版测试可用
2008/04/14 PHP
PHP验证码生成原理和实现
2016/01/24 PHP
php数组分页实现方法
2016/04/30 PHP
JavaScript setTimeout和setInterval的使用方法 说明
2010/03/25 Javascript
jquery判断字符输入个数(数字英文长度记为1,中文记为2,超过长度自动截取)
2010/10/15 Javascript
Jquery对象和Dom对象的区别分析
2014/11/20 Javascript
浅谈Javascript Base64 加密解密
2014/12/28 Javascript
JS实现文字放大效果的方法
2015/03/03 Javascript
JavaScript控制listbox列表框的项目上下移动的方法
2015/03/18 Javascript
jQuery的事件委托实例分析
2015/07/15 Javascript
基于jQuery实现选取月份插件附源码下载
2015/12/28 Javascript
JS中使用DOM来控制HTML元素
2016/07/31 Javascript
Backbone中View之间传值的学习心得
2016/08/09 Javascript
jQuery实现6位数字密码输入框
2016/12/29 Javascript
详解vue.js2.0父组件点击触发子组件方法
2017/05/10 Javascript
基于Vuejs和Element的注册插件的编写方法
2017/07/03 Javascript
React Native 真机断点调试+跨域资源加载出错问题的解决方法
2018/01/18 Javascript
详解webpack4多入口、多页面项目构建案例
2018/05/25 Javascript
Vue之mixin全局的用法详解
2018/08/22 Javascript
elementUI Vue 单个按钮显示和隐藏的变换功能(两种方法)
2018/09/04 Javascript
js+html实现周岁年龄计算器
2019/06/25 Javascript
js实现录音上传功能
2019/11/22 Javascript
typescript配置alias的详细步骤
2020/08/12 Javascript
[00:59]DOTA2背景故事第二期之四大基本法则
2020/07/07 DOTA
python实现中文分词FMM算法实例
2015/07/10 Python
python与php实现分割文件代码
2017/03/06 Python
python画出三角形外接圆和内切圆的方法
2018/01/25 Python
Python决策树和随机森林算法实例详解
2018/01/30 Python
微信小程序python用户认证的实现
2019/07/29 Python
详解HTML5中的元素与元素
2015/08/17 HTML / CSS
护士节演讲稿开场白
2014/08/25 职场文书
邀请函格式范文
2015/02/02 职场文书
审美与表现自我评价
2015/03/09 职场文书
情侣餐厅的创业计划书范本!
2019/07/26 职场文书
Python函数中apply、map、applymap的区别
2021/11/27 Python
我去timi了,一起去timi是什么意思?
2022/04/13 杂记