前言
webpack是如何解析代碼模塊路徑
webpack 中有一個很關鍵的模塊 enhanced-resolve 就是處理依賴模塊路徑的解析的,這個模塊可以說是 Node.js 那一套模塊路徑解析的增強版本,有很多可以自定義的解析配置。
模塊解析規則
- 解析相對路徑
- 查找相對當前模塊的路徑下是否有對應文件或文件夾
- 是文件則直接加載
- 是文件夾則繼續查找文件夾下的 package.json 文件
- 有 package.json 文件則按照文件中 main 字段的文件名來查找文件
- 無 package.json 或者無 main 字段則查找 index.js 文件.
- 解析模塊名
查找當前文件目錄下,父級目錄及以上目錄下的 node_modules
文件夾,看是否有對應名稱的模塊
- 解析絕對路徑(不建議使用)
直接查找對應路徑的文件
在 webpack 配置中,和模塊路徑解析相關的配置都在 resolve
字段下:
module.exports = {
resolve: {
// ...
}
}
resolve.alias
假設我們有個 utils 模塊極其常用,經常編寫相對路徑很麻煩,希望可以直接 import 'utils' 來引用,那么我們可以配置某個模塊的別名,如:
alias: {
utils: path.resolve(__dirname, 'src/utils')
// 這里使用 path.resolve 和 __dirname 來獲取絕對路徑
}
上述的配置是模糊匹配,意味着只要模塊路徑中攜帶了 utils 就可以被替換掉,如:
import 'utils/query.js'
// 等同於 import '[項目絕對路徑]/src/utils/query.js'
如果需要進行精確匹配可以使用:
alias: {
utils$: path.resolve(__dirname, 'src/utils')
// 只會匹配 import 'utils'
}
更多匹配相關的寫法可以參考官方文檔 Resolve Alias,這里不一一舉例說明。
resolve.extensions
extensions: ['.wasm', '.mjs', '.js', '.json', '.jsx'],
// 這里的順序代表匹配后綴的優先級,例如對於 index.js 和 index.jsx,會優先選擇 index.js
看到數組中配置的字符串大概就可以猜到,這個配置的作用是和文件后綴名有關的。是的,這個配置可以定義在進行模塊路徑解析時,webpack 會嘗試幫你補全那些后綴名來進行查找,例如有了上述的配置,當你在 src/utils/ 目錄下有一個 common.js 文件時,就可以這樣來引用.
import * as common from './src/utils/common'
webpack 會嘗試給你依賴的路徑添加上 extensions 字段所配置的后綴,然后進行依賴路徑查找,所以可以命中 src/utils/common.js 文件。
resolve.modules
前面的內容有提到,對於直接聲明依賴名的模塊(如 react
),webpack 會類似 Node.js 一樣進行路徑搜索,搜索 node_modules 目錄,這個目錄就是使用 resolve.modules
字段進行配置的,默認就是:
resolve: {
modules: ['node_modules'],
},
如果可以確定項目內所有的第三方依賴模塊都是在項目根目錄下的 node_modules 中的話,那么可以在 node_modules 之前配置一個確定的絕對路徑:
resolve: {
modules: [
path.resolve(__dirname, 'node_modules'), // 指定當前目錄下的 node_modules 優先查找
'node_modules', // 如果有一些類庫是放在一些奇怪的地方的,你可以添加自定義的路徑或者目錄
],
}
這樣配置在某種程度上可以簡化模塊的查找,提升構建速度。
后言
resolve 還有一些其他的配置,還有其他的伙伴那就去官網看看,以上都是實際項目中使用到的。