webpack external模块的具体使用


Posted in Javascript onMarch 10, 2018

这篇文章讨论Webpack打包library时经常需要用到的一个选项external,它用于避免将一些很通用的模块打包进你发布的library里,而是选择把它们声明成external的模块,在你的library被上层使用后,在最后阶段由Webpack统一把这个external的依赖模块打包进来。

external选项一般都是用在打包library上面,如果不是library而是一个最终的app的发布JS文件,那external也没有什么意义。关于Webpack打包library的分析和一些选项的作用,我在前一篇文章做了讨论。

external选项

我们仍然使用前一篇文章的例子,定义一个库util.js:

import $ from 'jquery'

function hideImages() {
 $('img').hide();
}

export default {
 "hideImages": hideImages
}

我们使用Webpack打包发布这个库:

// 入口文件
entry: {
 util: './util.js',
}

// 输出文件
output: {
 path: './dist',
 filename: '[name].dist.js'

 library: 'util',
 libraryTarget: commonjs2,
 targetExport: 'default'
}

这样打包出来的util.dist.js文件会把jquery的代码完整地注入进去,因为你的源代码使用到了它。但是这往往并不是我们希望的,因为jquery是很通用的模块,在一个app中,很可能其它的库也会用到它,最顶层的入口文件app也可能用到它,如果每一个库模块的发布版本都将jquery原封不动地打包进了自己的bundle,最后拼到一起,在最终的app发布代码里就会有很多份jquery的复制,当然这可能并不会影响它的正常功能,但是会占据很大的代码体积。

所以通常情况下当你的库需要依赖到例如jquery,bootstrap这样的通用JS模块时,我们可以不将它打包进bundle,而是在Webpack的配置中声明external:

externals: {
 jquery: {
  root: 'jquery',
  commonjs: 'jquery',
  commonjs2: 'jquery',
  amd: 'jquery',
 },
},

这就是在告诉Webpack:请不要将这个模块注入编译后的JS文件里,对于我源代码里出现的任何import/require这个模块的语句,请将它保留。

我们可以看一下编译后的bundle文件的结构:

module.exports = (function(modules) {
 var installedModules = {};
 function webpack_require(moduleId) {
   // ...
 }
 return webpack_require('./util.js');
}) ({
 './util.js': generated_util,
 // '/path/to/jquery.js': generated_jquery 原本有这一行,现在被删去。
});

可以看到jquery模块没有被打包进bundle文件,而对于util,它的生成代码即generated_util函数中关于import jquery相关的语句也被保留了原意:

function generated_util(module, exports, webpack_require) {
 var $ = require('jquery');
 // util的其它源代码
 // ...
}

当然也并非完全没有修改,例如将import的改回了传统的require关键词,因为我们这里用的是CommonJS风格的打包方式。不过这些都是次要的,关键是它保留了require这个关键词,而没有使用webpack_require将jquery真的引入进来。这就是说,当前的这个JS文件的模块管理系统中是没有jquery的,它是一个external的模块,需要在这个JS文件被其它人引用并且在上层编译时,jquery才可能被真的引入进来,到那个时候这里的require关键词才会被替换为webpack_require。

对于external的依赖模块,通常你可以这样做,例如你使用npm发布你的库,你可以将jquery在package.json文件中添加到dependencies,这样别人npm install你发布的库时,jquery也会被自动下载到node_modules供别人打包使用。

umd格式下的打包

如果我们使用umd格式打包,我们可以看到在不同环境中,external模块是如何发挥作用的:

(function webpackUniversalModuleDefinition(root, factory) {
 if(typeof exports === 'object' && typeof module === 'object') // commonjs2
  module.exports = factory(require('jquery'));
 else if(typeof define === 'function' && define.amd)
  define("util", ['jquery'], factory); // amd
 else if(typeof exports === 'object')
  exports["util"] = factory(require('jquery')); // commonjs
 else
  root["util"] = factory(root['jquery']); // var
}) (window, function(__webpack_external_module_jquery__) {
 return (function(modules) {
  var installedModules = {};
  function webpack_require(moduleId) {
    // ...
  }
  return webpack_require('./util.js');
 }) ({
  './util.js': generated_util,
 });
}

而generated_util也相应地增加一个参数__webpack_external_module_jquery__:

function generated_util(module, exports, webpack_require,
            __webpack_external_module_jquery__) {
 var $ = __webpack_external_module_jquery__;
 // util的其它源代码
 // ...
}

这样的写法似乎结构和上面的CommonJS的编译版本不太一样,但实际上本质是一样的。因为现在umd要照顾到不同的运行环境,所以它把require('jquery')提前了,作为factory的参数传入。对于每种运行环境,各有各的做法:

  1. CommonJS:保留require('jquery')语句。
  2. AMD:在define中将jquery定义为依赖模块。
  3. Var:从全局域中取出jquery变量,这需要jquery在该模块之前就已经被加载。

然后不管是哪种情况,它们都将载入后的jquery模块作为参数传入factory函数,这样就能正确加载util模块了。

以上涉及到Webpack生成代码的部分可能有点绕,需要你比较了解Webpack打包模块的机制和原理,关于这部分我在这篇文章里做了详细讨论。

总结

以上就是关于Webpack的external选项的使用,并且从编译后的JS代码分析了它到底是如何起作用的。我想阅读Webpack相关的生成代码还是很重要的,这样才算是真正地理解了external的机制,在碰到一些坑时才能知道怎么去debug。

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

Javascript 相关文章推荐
window.open以post方式将内容提交到新窗口
Dec 26 Javascript
Node.js插件的正确编写方式
Aug 03 Javascript
JavaScript基本语法讲解
Jun 03 Javascript
JavaScript中Function函数与Object对象的关系
Dec 17 Javascript
详解AngularJS中的http拦截
Feb 09 Javascript
jQuery length 和 size()区别总结
Apr 26 jQuery
vue axios数据请求get、post方法及实例详解
Sep 11 Javascript
vue+elementUI 复杂表单的验证、数据提交方案问题
Jun 24 Javascript
Vue中img的src是动态渲染时不显示的解决
Nov 14 Javascript
原生javascript单例模式的应用实例分析
Feb 23 Javascript
js实现飞机大战小游戏
Aug 26 Javascript
小程序自定义弹框效果
Nov 16 Javascript
webpack组织模块打包Library的原理及实现
Mar 10 #Javascript
浅谈webpack组织模块的原理
Mar 10 #Javascript
Vuex实现计数器以及列表展示效果
Mar 10 #Javascript
在vue中使用css modules替代scroped的方法
Mar 10 #Javascript
redux-saga 初识和使用
Mar 10 #Javascript
JS获取input[file]的值并显示在页面的实现方法
Mar 09 #Javascript
vue获取当前点击的元素并传值的实例
Mar 09 #Javascript
You might like
留言板翻页的实现详解
2006/10/09 PHP
一个取得文件扩展名的函数
2006/10/09 PHP
php无限遍历目录示例
2014/02/21 PHP
php强制更新图片缓存的方法
2015/02/11 PHP
PHP对象的浅复制与深复制的实例详解
2017/10/26 PHP
源码分析 Laravel 重复执行同一个队列任务的原因
2017/12/25 PHP
JavaScript RegExp方法获取地址栏参数(面向对象)
2009/03/10 Javascript
javascript 异常处理使用总结
2009/06/21 Javascript
JavaScript 创建运动框架的实现代码
2013/05/08 Javascript
Javascript基础教程之while语句
2015/01/18 Javascript
12个非常实用的JavaScript小技巧【推荐】
2016/05/18 Javascript
div中文字内容溢出常见的解决方法
2017/03/16 Javascript
JavaScript设计模式之单例模式详解
2017/06/09 Javascript
vue.js组件之间传递数据的方法
2017/07/10 Javascript
Gulp实现静态网页模块化的方法详解
2018/01/09 Javascript
vue使用ajax获取后台数据进行显示的示例
2018/08/09 Javascript
微信小程序如何实现五星评价功能
2019/10/15 Javascript
微信小程序实现简单的select下拉框
2020/11/23 Javascript
[01:17]Ti4 循环赛第一日回顾
2014/07/11 DOTA
Python编写屏幕截图程序方法
2015/02/18 Python
Python中将字典转换为XML以及相关的命名空间解析
2015/10/15 Python
Python实现mysql数据库更新表数据接口的功能
2017/11/19 Python
python3实现随机数
2018/06/25 Python
Python实现简单石头剪刀布游戏
2021/01/20 Python
Django uwsgi Nginx 的生产环境部署详解
2019/02/02 Python
python批量爬取下载抖音视频
2019/06/17 Python
Python爬虫小例子——爬取51job发布的工作职位
2020/07/10 Python
机械制造专业个人的自我评价
2013/12/28 职场文书
大二学生自我检讨书
2014/10/23 职场文书
机关干部四风问题自查报告及整改措施
2014/10/26 职场文书
2014小学语文教师个人工作总结
2014/12/03 职场文书
运动会通讯稿600字
2015/07/20 职场文书
vue实现同时设置多个倒计时
2021/05/20 Vue.js
解决pycharm安装scrapy DLL load failed:找不到指定的程序的问题
2021/06/08 Python
Windows11性能真的上涨35%? 桌面酷睿i9实测结果公开
2021/11/21 数码科技
git中cherry-pick命令的使用教程
2022/06/25 Servers