很多團隊第一次認真折騰 webpack,都是在「上線之後用戶還是拿到舊 JS」的那一刻開始的。本文以一個最常見的場景切入:項目裡用了 lodash,打包後所有代碼塞進同一個 bundle.js,然後我們一步步把它拆開、加上 hash、最後把緩存問題徹底解決。
var path = require('path');
module.exports = {
entry: './src/index.js',
output: {
filename: 'bundle.js',
path: path.resolve(__dirname, 'dist')
}
}
入口文件裡引進了 lodash:
import _ from 'lodash';
function component() {
var element = document.createElement('div');
element.innerHTML = _.join(['Hello', 'webpack'], ' ');
return element;
}
document.body.appendChild(component());
打包結果只有一個 bundle.js。問題很直觀:用戶每次訪問頁面,都要重新下載幾百 KB 根本不會變動的 lodash。
網絡帶寬和延遲都是成本,所以瀏覽器會主動緩存靜態資源,避免每次打開頁面都走一輪網絡請求。但緩存也帶來了反面問題:如果我們發佈新版本時文件名保持不變,瀏覽器很可能認為資源沒更新,繼續命中本地副本,用戶就一直看著舊界面。
於是我們要同時解決兩件事:
const path = require('path');
const webpack = require('webpack');
module.exports = {
entry: {
common: ['lodash'],
app: './src/index.js'
},
output: {
filename: '[name].[hash].js',
path: path.resolve(__dirname, 'dist')
},
plugins: [
new webpack.optimize.CommonsChunkPlugin({
name: 'common' // 指代 index.js 引入的 lodash 庫
})
]
}
關鍵改動有兩處:
打包後,業務代碼變成 app.[hash].js,lodash 變成 common.[hash].js。看上去很美好,但新問題緊接著出現。
第一次打包:

改動 index.js 之後再次打包:

注意 Asset 列表:不僅 app 的 hash 變了,common 的 hash 也跟著變了,而且兩個 hash 值居然完全一樣。
這不是我們想要的。業務代碼的 hash 變化是必要的,但如果連 lodash 這種幾乎永遠不變的 chunk 也換了名字,用戶每次發版都要重新下載一遍大文件,帶寬白白浪費。
順帶一提:反覆打包會在 dist 目錄堆積大量廢棄文件,實戰中通常會引入 CleanWebpackPlugin 來清理。
new CleanWebpackPlugin(['dist']) // 每次打包前清空輸出目錄
把 output 中的 [hash] 改為 [chunkhash],讓每個 chunk 依據自身內容生成獨立 hash:
const path = require('path');
const webpack = require('webpack');
module.exports = {
entry: {
common: ['lodash'],
app: './src/index.js'
},
output: {
filename: '[name].[chunkhash].js',
path: path.resolve(__dirname, 'dist')
},
plugins: [
new CleanWebpackPlugin(['dist']),
new webpack.optimize.CommonsChunkPlugin({
name: 'common'
})
]
}
提醒一句:開發環境不要用 chunkhash。它會拖慢增量編譯,而且和 HotModuleReplacementPlugin 一起使用會直接編譯失敗。合理做法是把配置拆成 development 與 production 兩套,開發用 [name].js,生產用 [name].[chunkhash].js。
打包結果:

app 與 common 的 hash 終於不一樣了。可是隨意改一下 index.js 再打包:

奇怪的事情發生了:common 的 hash 竟然還是變了。
原因在 webpack 的模塊標識機制。為了壓縮體積,webpack 打包時用短小的數字標識符代替模塊名,並把「標識符 → 模塊」的映射表放進一個叫 chunk manifest 的 JS 對象裡。
而當我們用 CommonsChunkPlugin 分離代碼時,被剝離出的代碼會默認掛到 entry 中最後一個入口上,chunk manifest 也會跟著一起被打進 common。於是只要業務代碼一改,映射表就變,common 的內容跟著變,基於內容的 chunkhash 自然也不得不變——長效緩存就這麼被廢掉了。
解法是再配一個 CommonsChunkPlugin,用一個 entry 裡並不存在的名字,讓 webpack 把 manifest 單獨抽出來:
const path = require('path');
const webpack = require('webpack');
module.exports = {
entry: {
common: ['lodash'],
app: './src/index.js'
},
output: {
filename: '[name].[chunkhash].js',
path: path.resolve(__dirname, 'dist')
},
plugins: [
new CleanWebpackPlugin(['dist']),
new webpack.optimize.CommonsChunkPlugin({
name: 'common'
}),
new webpack.optimize.CommonsChunkPlugin({
name: 'manifest' // 用於提取 manifest
})
]
}
打包後:

這張圖正好佐證了前面的推論:之前 common 的 Size 一直是 547kb,現在變成 541kb,而 manifest 恰好是 5.85kb,兩者相加正好 547kb。
再改一次 index.js 並重新打包:

這回 common 的 hash 紋絲不動,只有 app 變了。目標達成。
做一個很小的改動——把 entry 裡 app 和 common 的順序對調:
const path = require('path');
const webpack = require('webpack');
module.exports = {
entry: {
app: './src/index.js',
common: ['lodash']
},
output: {
filename: '[name].[chunkhash].js',
path: path.resolve(__dirname, 'dist')
},
plugins: [
new CleanWebpackPlugin(['dist']),
new webpack.optimize.CommonsChunkPlugin({ name: 'common' }),
new webpack.optimize.CommonsChunkPlugin({ name: 'manifest' })
]
}
打包後:

common 的 hash 又變了,而且 app 的 hash 也變了——明明 index.js 一個字都沒改,只是換了順序。
對比前後兩張圖的模塊解析編號([1]、[2]、[3]… 對應的模塊)就能看出端倪:之前 lodash 是第一個被解析的,現在變成了最後一個。
根因是 module.id 會按默認解析順序遞增分配。解析順序一變,id 就變,內容變,hash 自然也變。
有人會想:我從來不動 entry 的順序,是不是就沒這問題?並不然,除非你能保證所有依賴都寫在 entry 最頂部。假設 entry 順序是 app → common,解析順序為 index.js → lodash;哪天 index.js 裡多引了一個 print.js,順序就變成 index.js → print.js → lodash,common 的 hash 一樣會變。
引入 HashedModuleIdsPlugin,讓 module.id 不再依賴解析順序,而是依據內容 hash 生成(NamedModulesPlugin 效果類似,用路徑名生成 id,可讀性更好,但編譯稍慢):
const path = require('path');
const webpack = require('webpack');
module.exports = {
entry: {
common: ['lodash'],
app: './src/index.js'
},
output: {
filename: '[name].[chunkhash].js',
path: path.resolve(__dirname, 'dist')
},
plugins: [
new CleanWebpackPlugin(['dist']),
new webpack.HashedModuleIdsPlugin(), // 引入該插件
new webpack.optimize.CommonsChunkPlugin({ name: 'common' }),
new webpack.optimize.CommonsChunkPlugin({ name: 'manifest' })
]
}
此時打包日誌裡的方括號不再是一串數字,而是類似 hash 的字符串。

最後一次驗證:調換 app 與 common 的順序,同時隨意修改 index.js,重新打包。

common 的 hash 穩定,app 的 hash 隨內容變化。業務代碼不贅緩存、第三方庫長期命中緩存,這才是我們真正想要的結果。
整條優化路徑可以濃縮成四個動作:用 CommonsChunkPlugin 拆分代碼、用 chunkhash 讓文件名跟隨內容、再把 manifest 單獨抽出、最後用 HashedModuleIdsPlugin 消除解析順序對 module id 的干擾。四步缺一,長效緩存都會在某個環節失效。
參考資料:webpack 官方文檔「Caching」、社區文章「webpack 獨立打包與緩存處理」。