webpack 代碼分離快速指北

⭐️ 更多前端技術和知識點，搜索訂閱號 JS 菌 訂閱

分離代碼文件

在此以前，首先要知道常常配置的 output 中有關 filename 和 chunkFilename 的區別；簡單來講在 entry 定義的入口文件走的就是 filename 配置項，在入口文件內部引入的一般狀況下是 chunk，走 chunkFilename 的配置

因此不少時候分離代碼文件就是將不一樣的 chunk 分離開來，生產環境中有利於瀏覽器緩存，加快二次訪問的速度

代碼分離的時候，optimization 中配置的 splitChunks 默認就是 async，默認對異步代碼進行分離；因此一般狀況下能用異步的用異步 import；配合 prefetching 和 preloading 可以產生很好的效果

filename 和 chunkFilename 的區別

output: {
  filename: '[name].js',
  chunkFilename: '[name].chunk.js'
}

舉個例子

若是入口文件是 main.js

那麼打包後生成的文件是 main.js

若是 main.js 中引入了其餘模塊，好比引入了 lodash 那麼可能會生成一個名爲 lodash.chunk.js 文件

基本概念瞭解了，接下來開始對 js 和 css 文件進行分離的操做：

js 代碼分離

js 代碼的分離操做，首先要考慮的就是對異步代碼的分離。這裏使用 dynamicImport

dynamicImport

可使用 magic comment 來修改動態 import 導出的 chunkname，語法規則以下：

import('/* webpackChunkName: "lodash" */' 'lodash').then(//...)

若是須要使用這種註釋的寫法，應該安裝模塊 @babel/plugin-syntax-dynamic-import，並在 babelrc 中引入這個插件，使用方法很簡單這裏很少說了

splitChunks

splitChunk 的相關配置參數

建議將公共使用的第三方類庫顯式地配置爲公共的部分，而不是 webpack 本身去判斷處理

• chunks: 表示顯示塊的範圍，有三個可選值：initial(初始塊)、async(按需加載塊)、all(所有塊)，默認爲all;
• minSize: 表示在壓縮前的最小模塊大小，默認爲0；
• minChunks: 表示被引用次數，默認爲1；
• maxAsyncRequests: 最大的按需(異步)加載次數，默認爲1；
• maxInitialRequests: 最大的初始化加載次數，默認爲1；
• name: 拆分出來塊的名字(Chunk Names)，默認由塊名和hash值自動生成；
• cacheGroups: 緩存組。

緩存組中還有其餘幾個參數：

• priority: 表示緩存的優先級；
• test: 緩存組的規則，表示符合條件的的放入當前緩存組，值能夠是function、boolean、string、RegExp，默認爲空；
• reuseExistingChunk: 表示可使用已經存在的塊，即若是知足條件的塊已經存在就使用已有的，再也不建立一個新的塊。

webpack4——SplitChunksPlugin使用指南

module.exports = {
  entry: {
    vendor: ["react", "lodash", "angular", ...], // 指定公共使用的第三方類庫
  },
  optimization: {
    splitChunks: {
      cacheGroups: {
        vendor: {
          chunks: "initial",
          test: "vendor",
          name: "vendor", // 使用 vendor 入口做爲公共部分
          enforce: true,
        },
      },
    },
  },
  // ... 其餘配置
}

或者：

optimization: {
    splitChunks: {
      name: true, // 自動處理文件名
      chunks: 'all',
      minChunks: 1, // 至少 import 1 次的即須要打包
      automaticNameDelimiter: '-',
      cacheGroups: {
        vendors: {
          test: /axios|lodash/, // 將這兩個第三方模塊單獨提取打包
          chunks: 'initial',
        }
      }
    }
  },

optimization-splitchunks

chunks 的配置

注意 ⚠️

若是是動態 import，import('/* webpackChunkName: "lodash" */' 'lodash').then() 那麼 splitChunks 設置爲 async，代碼分離將會起做用。

若是是同步加載 import, import _ from 'lodash' 那麼 splitChunks 設置爲 async 將不起做用，若是設置爲 all，那麼還須要配置 cacheGroups

cacheGroups 的配置

vendors 緩存組的配置能夠檢測第三方模塊是否在 node_modules 中，若是存在則該 splitChunks 生效，將會分離到 vendors~... 這樣的文件中

配置 filename 則會打包成 [filename] 命名的文件中

runtimeChunk 的做用

這個 runtimeChunk 實際上就是連接業務邏輯和第三方類庫之間的關係的 manifest。須要將其提取出來，不然使用 contenthash 的狀況下有可能會致使模塊內容沒發生改變的狀況下出現 contenthash 屢次打包出現不一致的狀況（實際上就是存在在業務邏輯和模塊中的 manifest 發生了改變）

// v4版本的 webpack 不用配置，但最好也提取出來
optimization: {
  runtimeChunk: {
    name: 'runtime'
  }
}

reuseExistingChunk:

若是 a 模塊使用了 b，b 模塊又使用了 a；a 被打包到 common.js 中，打包 b 時將直接使用已經打包好的 common.js 中的 a；這就是 reuseExistingChunk 的做用：

default: {
  reuseExistingChunk: true,
  filename: 'common.js'
}

他的含義就是隻要其中一個模塊使用了 import $ from 'jquery'，其餘文件中就可直接使用 $ 變量，webpack 會自動在打包過程當中 import 這個模塊

css 代碼分離

css 部分分離代碼文件 直接使用 extract-text-webpack-plugin 便可

一個 JS 文件，加載頁面時雖然只須要加載一個 JS 文件，但代碼一旦改變，用戶訪問新的頁面時就須要從新加載一個新的 JS 文件。有些狀況下，咱們只是單獨修改了樣式，這樣也要從新加載整個應用的 JS 文件，至關不划算。

多個組件共用一部分樣式，若是分離開來，第二個頁面就有了 CSS 文件的緩存，訪問速度天然會加快

MiniCssExtractPlugin

新版本的 webpack 使用這個插件

注意，在引入樣式文件 import './style.css' 的時候，若是配置了 treeshaking，應當在 package.json 中配置：

"sideEffects": [
  "*.css"
]

⚠️ 注意，另外在 vue 中若是有 style 標籤，還須要在 sideEffects 中加入 *.vue 的配置項。沒必要擔憂 vue 中的 script 部分會被 treeShaking 掉。

插件的相關配置

filename 指的是若是該 css 文件會直接被插入 html 中那麼走的就是 filename 的配置

plugins: [
  new MiniCssExtractPlugin({
    filename: '[name].css',
    chunkFilename: '[name].chunk.css'
  })
]

既然有分離那就有合併，這裏順便說起一下 css 代碼合併

若是有多個入口，想把多個入口引入的樣式文件所有打包到一個地方，那麼可使用 optimization 配置項的 splitChunks，因此這個配置項不只僅只做用於 js，css 也是能夠的：

optimization: {
  splitChuns: {
    cacheGroups: {
      styles: {
        name: 'style', // 將多個入口文件中的樣式文件所有合併打包
        test: /\.css$/,
        chunks: 'all',
        enforce: true
      }
    }
  }
}

css 代碼根據入口分別打包

還能夠根據入口的不一樣，來分別打包 css 文件，文檔已經講的很詳細了，這部分比較簡單能夠直接戳文檔 https://webpack.js.org/plugins/mini-css-extract-plugin

請關注個人訂閱號，不按期推送有關 JS 的技術文章，只談技術不談八卦 😊