webpack splitChunks的功能在nuxt2中的应用

 nuxt升级到v2之后,终于可以使用webpack 4了,喜大普奔。新版本的webpack给构建项目提供更多的优化。具体的webpack 4 的介绍可以参看官网(https://webpack.js.org/)。 这里主要介绍的是利用webpakc 4中的splitChunks优化nuxt build之后产生模块体积。

1. 问题背景

 为了便于理解,我建立了一个简单的项目,下面是基本的配置文件nuxt.config.js

module.exports = {
  /*
  ** Headers of the page
  */
  head: {
    title: 'starter',
    meta: [
      { charset: 'utf-8' },
      { name: 'viewport', content: 'width=device-width, initial-scale=1' },
      { hid: 'description', name: 'description', content: 'Nuxt.js project' }
    ],
    link: [
      { rel: 'icon', type: 'image/x-icon', href: '/favicon.ico' },
      { rel: 'stylesheet', href: 'https://unpkg.com/element-ui/lib/theme-chalk/index.css'}
    ]
  },
  apollo: {
    clientConfigs: {
      default: {
        httpEndpoint: 'http://localhost:4000',
      }
    }
  },
  /*
  ** Global CSS
  */
  css: ['~/assets/css/main.css'],
  plugins: ['~/plugins/vuetify.js', '~plugins/axios.js', '~/plugins/element-ui.js'],
  /*
  ** Add axios globally
  */
  build: {
    analyze: true,
    /*
    ** Run ESLINT on save
    */
    extend (config, ctx) {
      if (ctx.isDev && ctx.isClient) {
        config.module.rules.push({
          enforce: 'pre',
          test: /\.(js|vue)$/,
          loader: 'eslint-loader',
          exclude: /(node_modules)/
        })
      }
    }
  },
  modules: ['@nuxtjs/apollo']
}

 通过config文件,不难发现本项目需要的依赖包括vuetify, axios, element-ui, 还有@nuxtjs/apollo。这些模块,尤其是vuetifyelement-ui都是体积比较大的模块。nuxt build之后,在.nuxt/dist目录下产生了clientserver两个文件夹,分别包含了前后端需要的文件。下图是控制台输出的client中文件信息,

 上图中明显标出, vendors.app.js的体积为1.13M,超出了推荐值,警告会影响性能。而下图更加直观的给出了每个bundle中包含的模块信息。很明显的,vendors.app.js中的vuetifyelement-ui占据了很大的空间,是造成vendors.app.js超大体积的主要原因。


 在实际应用中,加载较大体积的资源耗费的时间也会相对较大,尤其在网速不给力的时候,会对页面性能造成很大的影响。因此,将这些模块拆分成更小的模块是非常必要的。

2. Nuxt基本打包原理

Nuxt 2中是用webpack 4进行打包,对应的config文件都在template\node_modules\nuxt\lib\builder\webpack目录下。其中,base.js提供了webpack的基本配置,而client.jsserver.js提供了打包前后端时的具体配置项。下面,我们来仔细研究client.js来推导vendors.app.js生成原理。在client.js中定义了入口文件。

 config.entry = {
      app: [path.resolve(this.options.buildDir, 'client.js')]
    }

 最终直接打包出来的文件由四个部分组成,

runtime.js
commons.app.js
vendors.app.js
app.js

 除了runtime.js,其他文件名字中均包含app单词。之所以最后拆分成四个js文件,是因为nuxt 2中启用了webpack 4splitChunks功能。顾名思义,就是把拆分模块。对应的源码如下,

optimization() {
    const optimization = super.optimization()

    // Small, known and common modules which are usually used project-wise
    // Sum of them may not be more than 244 KiB
    if (
      this.options.build.splitChunks.commons === true &&
      optimization.splitChunks.cacheGroups.commons === undefined
    ) {
      optimization.splitChunks.cacheGroups.commons = {
        test: /node_modules[\\/](vue|vue-loader|vue-router|vuex|vue-meta|core-js|@babel\/runtime|axios|webpack|setimmediate|timers-browserify|process|regenerator-runtime|cookie|js-cookie|is-buffer|dotprop|nuxt\.js)[\\/]/,
        chunks: 'all',
        priority: 10,
        name: true
      }
    }

    return optimization
  }

 上述源码表示开启了optimization的功能,其中还增加了一个cacheGroup,将符合test正则表达式的模块过滤出来,单独打包成common.app.js,而剩下的则是打包进了vendor.app.js。而这里的optimization是继承自base.js中的optimization配置,在进行进一步配置。追根溯源,最开始传入的配置都来源于template\node_modules\nuxt\lib\common\nuxt.config.js。事实上这里的nuxt.config.js提供了所有可能的配置,是很好的参考。这里我们重点关注关于optimizationsplitChunks选项,对应代码如下。

export default {
  ...
  build: {
    ...
    optimization: {
      runtimeChunk: 'single',
      minimize: undefined,
      minimizer: undefined,
      splitChunks: {
        chunks: 'all',
        automaticNameDelimiter: '.',
        name: undefined,
        cacheGroups: {}
        }
      },
      splitChunks: {
        layouts: false,
        pages: true,
        commons: true
    },
  }
}

3. 配置nuxt.config.js以提取大体积模块

 因此,我们可以在自己项目中的nuxt.config.js中添加cacheGroups选项,将一些体积较大的模块过滤出来生成单独的文件。我在nuxt.config.js中增加了两个cacheGroups分别打包vuetifyelement-ui。由于这两个的cacheGroupspriority20,高于commons,所以某一模块即使符合commonstest的正则表达式,也会优先被打包进去vuetifyelement-ui中。

build: {
  ...
    optimization: {
      splitChunks: {
        chunks: 'all',
        automaticNameDelimiter: '.',
        maxAsyncRequests: 7,
        cacheGroups: {
          vuetify: {
            test: /node_modules[\\/]vuetify/,
            chunks: 'all',
            priority: 20,
            name: true
          },
          elementui: {
            test: /node_modules[\\/]element-ui/,
            chunks: 'all',
            priority: 20,
            name: true
          }
        }
      }
    },
}

 下面两张是修改后的nuxt.config.jsbuild出来的结果,

 显然,vendors.app.js的体积已经由1.13M缩小到233K,而最中app构成的模块中多了elementui.app.jsvuetify.app.js两个。可以说我们已经成功的将模块进行了更小一步的拆分。

4. 结尾

 在实际项目中,可以根据项目中依赖模块的实际情况,进行分组,使得打包出来的模块尽可能小。

 事实上,上述修改后打包结果并不是最优,elementui.app.jsvuetify.app.js都超过了最优值,分别为562K360k。从bundle analyzer图发现,这两个文件中都包含了一个体积较大的单个文件,因此难以再拆分。针对这种情况,我们可以将其放在cdn上,作为外部资源引用。
 以后,我们将介绍如何在nuxt 2中巧妙引用外部资源来减小项目体积,加速页面速度。敬请期待~

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

推荐阅读更多精彩内容