Skip to content
⚠️ This article was written in 2018. Some content may be outdated.

Webpack 公共代碼提取和 SplitChunks

隨着項目頁面增多,多個頁面都用到的代碼會被重複打包。SplitChunks 可以把公共代碼提取出來,讓瀏覽器緩存複用。

為什麼需要代碼分割

項目有 A、B、C 三個頁面,都用了 lodash 和 Vue
如果不提取:
  pageA.js = pageA代碼 + lodash + Vue
  pageB.js = pageB代碼 + lodash + Vue
  pageC.js = pageC代碼 + lodash + Vue
  → lodash 和 Vue 被下載了 3 次!

提取後:
  vendor.js = lodash + Vue(只下載一次,長期緩存)
  common.js = A/B/C 共用的業務代碼
  pageA.js = pageA 自己的代碼(很小)

Webpack 4 的 SplitChunks

javascript
// webpack.config.js
module.exports = {
  optimization: {
    splitChunks: {
      chunks: "all", // 對所有 chunks 生效(async/initial/all)

      cacheGroups: {
        // 第三方庫單獨打包
        vendors: {
          test: /[\\/]node_modules[\\/]/,
          name: "vendors",
          chunks: "all",
          priority: 20,
        },

        // 公共業務代碼
        common: {
          name: "common",
          minChunks: 2, // 至少被 2 個 chunk 引用
          chunks: "all",
          priority: 10,
          reuseExistingChunk: true,
        },
      },
    },
  },
};

更細粒度的分割

javascript
cacheGroups: {
  // Vue 框架單獨打包(很少變化,長期緩存)
  vue: {
    test: /[\\/]node_modules[\\/](vue|vue-router|vuex)[\\/]/,
    name: 'vue',
    chunks: 'all',
    priority: 30
  },

  // Element UI 單獨打包(比較大,單獨緩存)
  elementUI: {
    test: /[\\/]node_modules[\\/]element-ui[\\/]/,
    name: 'element-ui',
    chunks: 'all',
    priority: 25
  },

  // 其他第三方庫
  vendors: {
    test: /[\\/]node_modules[\\/]/,
    name: 'vendors',
    chunks: 'all',
    priority: 20
  },

  // 項目公共代碼
  common: {
    name: 'common',
    minChunks: 2,
    chunks: 'all',
    priority: 10
  }
}

runtime chunk

javascript
optimization: {
  // 把 webpack 的運行時代碼單獨提取
  // 避免 vendor hash 因為 runtime 變化而改變
  runtimeChunk: {
    name: "runtime";
  }
}

緩存策略配合

javascript
output: {
  // contenthash:內容不變則 hash 不變,瀏覽器可以長期緩存
  filename: 'js/[name].[contenthash:8].js',
  chunkFilename: 'js/[name].[contenthash:8].chunk.js'
}

分割策略:

runtime.js    → 很小,每次構建可能變化
vendor.js     → 第三方庫,幾乎不變,長期緩存
common.js     → 業務公共代碼,偶爾變化
pageA.js      → 頁面代碼,經常變化

Vue CLI 的默認配置

Vue CLI 已經做了合理的默認配置,通常不需要手動改:

javascript
// vue.config.js(只在默認不滿足需求時調整)
module.exports = {
  chainWebpack(config) {
    config.optimization.splitChunks({
      cacheGroups: {
        vendors: {
          name: "chunk-vendors",
          test: /[\\/]node_modules[\\/]/,
          priority: -10,
          chunks: "initial",
        },
      },
    });
  },
};

效果

在我們的項目裏,分割優化後:

優化前:
  app.js:1.2MB(首次和後續每頁都要下載)

優化後:
  vendor.js:600KB(首次下載,後續所有頁面緩存複用)
  common.js:100KB
  各頁面 chunk:30-80KB

首次總量差不多,但後續頁面跳轉只需要下載 page chunk

小結

  • splitChunks.chunks: 'all' 對所有代碼生效
  • cacheGroups 定義不同的提取策略
  • 第三方庫按頻率分組:核心框架、大型UI庫、其他
  • contenthash 確保緩存在內容不變時有效
  • Vue CLI 有合理默認值,先跑 bundle analyzer 再決定要不要調整

MIT Licensed