深入浅出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使用办法
Apr 01 Javascript
jQuery DOM插入节点操作指南
Mar 03 Javascript
asp知识整理笔记3(问答模式)
Sep 27 Javascript
javascript闭包(Closure)用法实例简析
Nov 30 Javascript
js+html5实现canvas绘制椭圆形图案的方法
May 21 Javascript
jQuery实现为LI列表前3行设置样式的方法【2种方法】
Sep 04 Javascript
详解vue-router和vue-cli以及组件之间的传值
Jul 04 Javascript
微信小程序实现展示评分结果功能
Feb 15 Javascript
vue-cli在 history模式下的配置详解
Nov 26 Javascript
jquery实现上传文件进度条
Mar 26 jQuery
vue接口请求加密实例
Aug 11 Javascript
基于VUE实现简单的学生信息管理系统
Jan 13 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实现文件下载简单示例(代码实现文件下载)
2014/03/10 PHP
php+redis消息队列实现抢购功能
2018/02/08 PHP
php适配器模式简单应用示例
2019/10/23 PHP
jQuery下的几个你可能没用过的功能
2010/08/29 Javascript
jquery常用技巧及常用方法列表集合
2011/04/06 Javascript
js动态添加删除,后台取数据(示例代码)
2013/11/25 Javascript
jquery解析JSON数据示例代码
2014/03/17 Javascript
基于MVC4+EasyUI的Web开发框架形成之旅之界面控件的使用
2015/12/16 Javascript
AngularJs基本特性解析(一)
2016/07/21 Javascript
jQuery实用小技巧_输入框文字获取和失去焦点的简单实例
2016/08/25 Javascript
用nodeJS搭建本地文件服务器的几种方法小结
2017/03/16 NodeJs
nodejs读取并去重excel文件
2018/04/22 NodeJs
vue3.0 CLI - 2.4 - 新组件 Forms.vue 中学习表单
2018/09/14 Javascript
axios携带cookie配置详解(axios+koa)
2018/12/28 Javascript
vue+koa2实现session、token登陆状态验证的示例
2019/08/30 Javascript
layer提示框添加多个按钮选择的实例
2019/09/12 Javascript
vue学习笔记之过滤器的基本使用方法实例分析
2020/02/01 Javascript
[02:35]DOTA2英雄基础教程 末日使者
2013/12/04 DOTA
Python多进程同步Lock、Semaphore、Event实例
2014/11/21 Python
Python实现的数据结构与算法之双端队列详解
2015/04/22 Python
实例讲解Python编程中@property装饰器的用法
2016/06/20 Python
Python内置函数reversed()用法分析
2018/03/20 Python
Python自定义函数实现求两个数最大公约数、最小公倍数示例
2018/05/21 Python
Django如何实现网站注册用户邮箱验证功能
2019/08/14 Python
使用批处理脚本自动生成并上传NuGet包(操作方法)
2019/11/19 Python
html5+CSS3+JS实现七夕言情功能代码
2017/08/28 HTML / CSS
HTML5的标签的代码的简单介绍 HTML5标签的简介
2012/05/28 HTML / CSS
奶茶专卖店创业计划书
2014/01/18 职场文书
致长跑运动员加油稿
2014/02/20 职场文书
大学军训感言200字
2014/02/26 职场文书
乡镇总工会学雷锋活动总结
2014/03/01 职场文书
婚内房产协议书范本
2014/10/02 职场文书
乒乓球比赛通知
2015/04/27 职场文书
python基于scrapy爬取京东笔记本电脑数据并进行简单处理和分析
2021/04/14 Python
分享Python异步爬取知乎热榜
2022/04/12 Python
USB TYPE-C 或将成为所有智能手机充电标准
2022/04/21 数码科技