webpack使用DllPlugin和DllReferencePlugin提取公共插件提升打包效率

项目在发布测试和生产环境前需要打包,而webpack默认使用commonChunkPlugin,该插件虽然可以将第三方库提取到vendor中,但每次打包时都会重新被打包一次,而这些第三方库一般是不会产生变化的,这也就意味着每次打包时都会花费一部分时间来生成相同的vendor.js文件,这无异于是一种资源浪费。
好在webpack中提供了DllPlugin和DllReferencePlugin来提升打包效率。
我们先来看package.json中"dependencies"部分的组件[1]

"dependencies": {
    "axios": "^0.18.0",
    "vue": "^2.5.2",
    "vue-router": "^3.0.1",
    "vuex": "^3.1.1"
  },

dependencies中第三方插件没有变化的话,使用commonChunkPlugin插件打包出来的vendor.js文件基本不会有变化,我们完全可以把此处使用到的代码提取出来,这样打包就能减少很多时间。
在此之前,我们先执行下npm run build看看打包出的文件大小和时长。

npm run build的结果.png

可以看出,使用commonChunkPlugin打包项目代码花了大概8.3s。
接下来我们对项目进行改造,使用DllPlugin和DllReferencePlugin。
build目录下新建webpack.dll.conf.js文件,里面内容如下:

const path = require('path')
const webpack = require('webpack')

module.exports = {
  entry: {
    vendor: [
      'vue/dist/vue.esm.js',
      'vuex/dist/vuex.esm.js',
      'vue-router/dist/vue-router.esm.js',
      'axios',
    ]
  },
  output: {
    path: path.resolve('./static/js'),
    filename: '[name].dll.js',
    library: '[name]_library'
  },
  plugins: [
    new webpack.DllPlugin({
      path: path.resolve('.', '[name]-manifest.json'),
      name: '[name]_library'
    })
  ]
}

细心的朋友可能会发现entry中引用vue、vuex等插件引用的都是esm版本,这是因为像import Vue from 'vue'这类import引用的就是vue/dist/vue.esm.js文件,但此文件中若直接引用vue的话无法被正确映射为vue.esm.js,所以此处做手动指定处理。如果有朋友最后发现项目代码莫名的比改造前大了许多,可以回过头来看此处,看看是不是因为第三方插件引用版本不统一导致打包两个版本代码到同一项目中了。

package.json文件添加npm run build:dll命令如下:

"build:dll": "webpack --config build/webpack.dll.conf.js"

运行npm run build:dll命令结果如下:

npm run build:dll的结果.png

可以看到,static文件夹下的js文件夹有个vendor.dll.js文件,根目录下有一个vendor-mainfest.json文件。
不过我们发现这个vendor.dll.js似乎有些大,482kb,这大小后期在添加提取几个第三方插件的话这个文件岂不是轻轻松松的有几兆大小。我们都知道正常情况下发布生产环境的代码都是经过压缩的,我们再次也可以对代码进行压缩。
参照webpack.prod.conf.js,使用UglifyJsPlugin对代码进行压缩,此时webpack.dll.conf.js的内容如下:

const path = require('path')
const webpack = require('webpack')
const UglifyJsPlugin = require('uglifyjs-webpack-plugin')
const env = require('../config/prod.env')

module.exports = {
  entry: {
    vendor: [
      'vue/dist/vue.esm.js',
      'vuex/dist/vuex.esm.js',
      'vue-router/dist/vue-router.esm.js',
      'axios',
    ]
  },
  output: {
    path: path.resolve('./static/js'),
    filename: '[name].dll.js',
    library: '[name]_library'
  },
  plugins: [
    new webpack.DefinePlugin({
      'process.env': env
    }),
    new UglifyJsPlugin({
      uglifyOptions: {
        compress: {
          warnings: false
        }
      },
      sourceMap: false,
      parallel: true
    }),
    new webpack.DllPlugin({
      path: path.resolve('.', '[name]-manifest.json'),
      name: '[name]_library'
    })
  ]
}

再次执行npm run build:dll后发现,新生成的vendor.dll.js的大小仅为146kb,这个算是正常大小了。

npm run build:dll开启压缩后的结果.png

接下来,开始改造打包生产环境代码用的webpack.prod.conf.js文件,将CommonChunkPlugin生成vendor.js和manifest.js文件的配置注释或者删除。

    // new webpack.optimize.CommonsChunkPlugin({
    //   name: 'vendor',
    //   minChunks (module) {
    //     // any required modules inside node_modules are extracted to vendor
    //     return (
    //       module.resource &&
    //       /\.js$/.test(module.resource) &&
    //       module.resource.indexOf(
    //         path.join(__dirname, '../node_modules')
    //       ) === 0
    //     )
    //   }
    // }),
    // new webpack.optimize.CommonsChunkPlugin({
    //   name: 'manifest',
    //   minChunks: Infinity
    // }),

然后添加plugins:

  new webpack.DllReferencePlugin({
    manifest: require(path.resolve(__dirname, '../vendor-manifest.json'))
  }),

index.html模板添加script标签,引入vendor.dll.js文件,具体位置如下:

<div id="app"></div>
<!-- built files will be auto injected -->
<script type='text/javascript' src='./static/js/vendor.dll.js'></script>

执行npm run build后发现,此次打包的时间只花了大概4.5s,比之前几乎少了一半,且生成的文件大小都很正常。

004.png

dist目录下开启静态资源服务,如http-server,访问后发现正常。
至此,将第三方插件提取出来防止重复打包的目的算是圆满达成。
但细想一下,还是存在一个小问题,那就是开发环境访问项目的话也会存在一个引用vendor.dll.js的script标签,我们应该只在构建生产环境的HTML时才需要引入此资源。
解决这个问题的方法有很多种,下面介绍几种:

  1. 使用ejs模板语法。
    执行npm install -S -D ejs安装ejs,然后将index.html的扩展名改为.ejs
    打开webpack.prod.conf.js,找到HtmlWebpackPlugin的配置项,添加自定义参数insertJs: ['/static/js/vendor.dll.js']
      new HtmlWebpackPlugin({
          filename: config.build.index,
          template: 'index.ejs',
          inject: true,
          insertJs: ['/static/js/vendor.dll.js'],
          minify: {
            removeComments: true,
    
    然后对index.ejs做如下处理:
    <div id="app"></div>
    <!-- built files will be auto injected -->
    <script type='text/javascript' src='./static/js/vendor.dll.js'></script>
    <% if (htmlWebpackPlugin.options.insertJs && htmlWebpackPlugin.options.insertJs.length > 0) { %>
      <% htmlWebpackPlugin.options.insertJs.forEach(function(item){ %>
        <script type='text/javascript' src='<%= item %>'></script>
      <% }); %>
    <% } %>
    
    再执行npm run build会发现生产环境index.html中成功的引入了vendor.dll.js,而开发环境并没有此js。
    此方法其实可以引申出其他的一些用法,比如说区分环境加载cdn资源。
  2. 使用插件add-asset-html-webpack-plugin(NOTE: This plugin requires html-webpack-plugin@^2.10.0)
    webpack3.0版本的环境貌似用这个插件老是报错,原因未知,具体使用方法可以参照add-asset-html-webpack-plugin

再次强调一下,有些朋友可能做到最后发现vendor.dll.js中指定的第三方插件是被打包进来了,但这些插件在改造后的npm run build下,又一遍被打包进了app.js之类的文件中。为了清楚此类情况,需要仔细排查项目中对第三方插件引用的版本是否统一。


  1. 为了突出改造前后的对比效果,项目暂且只安装这几个插件。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,445评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,889评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,047评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,760评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,745评论 5 367
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,638评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,011评论 3 398
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,669评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,923评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,655评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,740评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,406评论 4 320
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,995评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,961评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,197评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,023评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,483评论 2 342

推荐阅读更多精彩内容

  • 写在开头 先说说为什么要写这篇文章, 最初的原因是组里的小朋友们看了webpack文档后, 表情都是这样的: (摘...
    Lefter阅读 5,273评论 4 31
  • 版权声明:本文为博主原创文章,未经博主允许不得转载。 webpack介绍和使用 一、webpack介绍 1、由来 ...
    it筱竹阅读 11,027评论 0 21
  • 记得2004年的时候,互联网开发就是做网页,那时也没有前端和后端的区分,有时一个网站就是一些纯静态的html,通过...
    阳阳阳一堆阳阅读 3,270评论 0 5
  • GitChat技术杂谈 前言 本文较长,为了节省你的阅读时间,在文前列写作思路如下: 什么是 webpack,它要...
    萧玄辞阅读 12,671评论 7 110
  • 一年一度的春天又来了,春光明媚,鲜花盛开,正是踏春的好时候。特选了几首诗,供大家诵读,看看这些诗符合你的见闻吗? ...
    judyjia0508阅读 503评论 0 0