深入浅出webpack之externals的使用


Posted in Javascript onDecember 04, 2017

我们通常在做项目时可能会把第三方库打包到bundle中,比如下面这张图

深入浅出webpack之externals的使用

如果不想把第三方库打包到bundle中,这就有了externals。官方的使用externals比较简单

externals

官网文档解释的很清楚,就是webpack可以不处理应用的某些依赖库,使用externals配置后,依旧可以在代码中通过CMD、AMD或者window/global全局的方式访问。

只需三步——

1.在HTML中引入第三方库的cdn

2.在webpack中配置externals

externals: {
 jquery: "jQuery",
}

3.在js中引用

const $ = require("jquery");
$("#content").html("<h1>hello world</h1>");

好,现在我们可以随心所欲的使用jquery插件并保证不会打包到bundle中。external是怎么办到的呢?下面我们通过bundle的源码来分析下原理。

深入浅出webpack之externals的使用

这里的/* 0 */和__webpack_require__分别指打包前js对应的模块函数,这里就不细说了。这里可以看到module.exports = jQuery,就是说我们externals中的key指的是require的东西,value指的就是它,就是说“当require的参数是jquery的时候,使用jQuery这个全局变量引用它”。这种最简洁的externals配置方式为默认的global模式,就是在window上挂一个全局变量,然后直接可以使用这个变量。具体的流程是这样,我们在源码中使用require('jquery')后,可以直接把jquery加到externals中,得到一个打包的trunk.js,但是在引入这个trunkjs之前,肯定要先引入jquery这个库文件,这个库文件会创建一个全局变量jQuery,而咱们的trunkjs中externals的jquery是global模式,所以实际上trunkjs引入jquery的时候,就会从全局变量中引用,即module.export = jQuery

深入浅出webpack之externals的使用

当然,既然是通过这种externals方式,其实我们可以不用require引入,直接使用全局变量也是可以的。

jQuery("#content").html("<h1>hello world</h1>");

大家如果注意到我刚说过的global模式的话,没错,你也许已经猜到了,我可以任意的使用不同的输出方式。如果打包文件我想运行到node环境下,我得使用commonjs规范,所以你要这么写。

externals: {
 jquery: "commonjs2 jQuery",
}

打包后会是这样子。

深入浅出webpack之externals的使用

然后我的项目中还用到了lodash,也想把它从bundle中移除,之前我的代码是这样子,引的是npm包

深入浅出webpack之externals的使用

深入浅出webpack之externals的使用

现在我们的externals配置如下

externals: {
  jquery: "jQuery",
  _: "lodash"

}

深入浅出webpack之externals的使用

我们必须要去掉这个const ,否则的话会报一个错误 lodash is not defined。为什么会这样呢?因为我们的lodash输出是global格式的,我在这里先卖一个关子,我们先统一一下输出格式,加一个libraryTarget字段

深入浅出webpack之externals的使用

这个东西是干嘛用的呢?

他是我们输出文件的模块化规范,想想我们上面配置的commonjs jquery是运行在node下,总之记住一句话——我们最长使用的模块化方案是commonjs2和umd,前者是为node环境,后者是为浏览器环境。一共有这几种规范:

"var" - Export by setting a variable: var Library = xxx (default)

"this" - Export by setting a property of this: this["Library"] = xxx
"commonjs" - Export by setting a property of exports: exports["Library"] = xxx
"commonjs2" - Export by setting module.exports: module.exports = xxx
"amd" - Export to AMD (optionally named - set the name via the library option)
"umd" - Export to AMD, CommonJS2 or as property in root

深入浅出webpack之externals的使用

然后报这个错误,也就是说我们的模块没有正确的输出,回到我们的externals,它更多的是指定当你引用一个包的时候,这个包(lodash)应该遵循哪种模块化方式(common,root,amd等等)引入,这意思就是说,打包的时候不需要关心他到底怎么输出。

externals: {
  jquery: "jQuery",
  lodash: {
   commonjs: 'lodash',
   commonjs2: 'lodash',
   amd: 'lodash',
   root: '_'
  }
 },

ok,记得要将之前的覆盖掉,替换成下面的require,因为在externals中我们规范的commmonjs规范为lodash

深入浅出webpack之externals的使用

也就是说,这就是我们最初的代码,即没有用过externals时候的代码,看,也就是说我们只需要配置externals和libraryTarget就可以,其他的业务逻辑代码不需要改变。包括我们的项目中还用了echarts,这个通通不用改变!!!!!

深入浅出webpack之externals的使用

也就是说最终的代码是externals配合libraryTarget一起使用,如果去掉umd的话,会报这个错误

深入浅出webpack之externals的使用

相应的源码是这样子

深入浅出webpack之externals的使用

就是说我不知道通过那种方式输出,所以我应该告诉webpack,我通过umd方式输出,即将你的 lodash 暴露为所有的模块定义下都可运行的方式。它将在 CommonJS, AMD 环境下运行,或将模块导出到 global 下的变量.加上umd的源码如下

深入浅出webpack之externals的使用

看到了吧,我通过require('lodash')引入模块,输出走的是commonjs规范,贴下最终的配置

entry: {
  main: './src/index.js'
 },
 externals: {
  jquery: "jQuery",
  lodash: {
   commonjs: 'lodash',
   commonjs2: 'lodash',
   amd: 'lodash',
   root: '_'
  }
 },
 output: {
  filename: '[name].[chunkhash].js',
  path: path.resolve(__dirname,'dist'),
  libraryTarget: 'umd'
 },

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

Javascript 相关文章推荐
JS 页面自动加载函数(兼容多浏览器)
May 18 Javascript
jQuery ctrl+Enter shift+Enter实现代码
Feb 07 Javascript
处理及遍历XML文档DOM元素属性及方法整理
Aug 23 Javascript
Ext修改GridPanel数据和字体颜色、css属性等
Jun 13 Javascript
JS+CSS实现的竖向简洁折叠菜单效果代码
Oct 22 Javascript
javascript多物体运动实现方法分析
Jan 08 Javascript
vue生命周期和react生命周期对比【推荐】
Sep 19 Javascript
VSCode使用之Vue工程配置eslint
Apr 30 Javascript
解决layui批量传值到后台操作时出现传值为空的问题
Sep 28 Javascript
jQuery实现小火箭返回顶部特效
Feb 03 jQuery
如何利用javascript接收json信息并进行处理
Aug 06 Javascript
vue使用v-model进行跨组件绑定的基本实现方法
Apr 28 Vue.js
基于js 字符串indexof与search方法的区别(详解)
Dec 04 #Javascript
基于JavaScript中字符串的match与replace方法(详解)
Dec 04 #Javascript
基于JSONP原理解析(推荐)
Dec 04 #Javascript
利用Javascript获取选择文本所在的句子详解
Dec 03 #Javascript
微信小程序图片选择区域裁剪实现方法
Dec 02 #Javascript
vue中eventbus被多次触发以及踩过的坑
Dec 02 #Javascript
Angular之toDoList的实现代码示例
Dec 02 #Javascript
You might like
PHP 手机归属地查询 api
2010/02/08 PHP
PHP生成UTF8文件的方法
2010/05/15 PHP
PHP保留两位小数的几种方法
2019/07/24 PHP
PHP扩展类型及安装方式解析
2020/04/27 PHP
Vue.js实现简单动态数据处理
2017/02/13 Javascript
详解Vue2+Echarts实现多种图表数据可视化Dashboard(附源码)
2017/03/21 Javascript
Javascript实现数组中的元素上下移动
2017/04/28 Javascript
layui table 参数设置方法
2018/08/14 Javascript
Vue中的基础过渡动画及实现原理解析
2018/12/04 Javascript
小程序登录/注册页面设计的实现代码
2019/05/24 Javascript
vue 实现单选框设置默认选中值
2019/11/07 Javascript
基于Vue+ElementUI的省市区地址选择通用组件
2019/11/20 Javascript
Python面向对象编程基础解析(一)
2017/10/26 Python
python决策树之CART分类回归树详解
2017/12/20 Python
TensorFlow实现创建分类器
2018/02/06 Python
基于python list对象中嵌套元组使用sort时的排序方法
2018/04/18 Python
Python使用selenium实现网页用户名 密码 验证码自动登录功能
2018/05/16 Python
python实现RabbitMQ的消息队列的示例代码
2018/11/08 Python
python 根据时间来生成唯一的字符串方法
2019/01/14 Python
python argparse传入布尔参数false不生效的解决
2020/04/20 Python
Django ORM 查询表中某列字段值的方法
2020/04/30 Python
Django之全局使用request.user.username的实例详解
2020/05/14 Python
Python 抓取数据存储到Redis中的操作
2020/07/16 Python
基于HTML5超酷摄像头(HTML5 webcam)拍照功能实现代码
2012/12/13 HTML / CSS
Paper Cape官网:美国婴儿和儿童服装品牌
2019/11/02 全球购物
渗透攻击的测试步骤
2014/06/07 面试题
一套软件开发工程师笔试题
2015/05/18 面试题
计算机专业推荐信范文
2013/11/27 职场文书
满月酒答谢词
2014/01/14 职场文书
小加工厂管理制度
2014/01/21 职场文书
企业车辆管理制度
2014/01/24 职场文书
教师开学感言
2014/02/14 职场文书
《永远的白衣战士》教学反思
2014/04/25 职场文书
党政领导班子四风问题对照检查材料思想汇报
2014/10/02 职场文书
个人创业事迹材料
2014/12/30 职场文书
在HTML5 localStorage中存储对象的示例代码
2021/04/21 Javascript