Webpack中publicPath使用詳解

更新時間：2021年06月25日 10:59:59 作者：Mello_Z

最近自己在搭建一個基于webpack的react項目，遇到關于output.publicPath和webpack-dev-server中publicPath的問題，所以自己研究了下并寫下本文記錄。感興趣的小伙伴們可以參考一下

output

output選項指定webpack輸出的位置，其中比較重要的也是經(jīng)常用到的有path和publicPath

output.path

默認值：process.cwd()
output.path只是指示輸出的目錄，對應一個絕對路徑，例如在項目中通常會做如下配置：

output: {
 path: path.resolve(__dirname, '../dist'),
}

output.publicPath

默認值：空字符串
官方文檔中對publicPath的解釋是

webpack 提供一個非常有用的配置，該配置能幫助你為項目中的所有資源指定一個基礎路徑，它被稱為公共路徑(publicPath)。

而關于如何應用該路徑并沒有說清楚...

其實這里說的所有資源的基礎路徑是指項目中引用css，js，img等資源時候的一個基礎路徑，這個基礎路徑要配合具體資源中指定的路徑使用，所以其實打包后資源的訪問路徑可以用如下公式表示：

靜態(tài)資源最終訪問路徑 = output.publicPath + 資源loader或插件等配置路徑

例如

output.publicPath = '/dist/'

// image
options: {
  name: 'img/[name].[ext]?[hash]'
}

// 最終圖片的訪問路徑為
output.publicPath + 'img/[name].[ext]?[hash]' = '/dist/img/[name].[ext]?[hash]'

// js output.filename
output: {
 filename: '[name].js'
}
// 最終js的訪問路徑為
output.publicPath + '[name].js' = '/dist/[name].js'

// extract-text-webpack-plugin css
new ExtractTextPlugin({
 filename: 'style.[chunkhash].css'
})
// 最終css的訪問路徑為
output.publicPath + 'style.[chunkhash].css' = '/dist/style.[chunkhash].css'

這個最終靜態(tài)資源訪問路徑在使用html-webpack-plugin打包后得到的html中可以看到。所以publicPath設置成相對路徑后，相對路徑是相對于build之后的index.html的，例如，如果設置publicPath: './dist/'，則打包后js的引用路徑為./dist/main.js，但是這里有一個問題，相對路徑在訪問本地時可以，但是如果將靜態(tài)資源托管到CDN上則訪問路徑顯然不能使用相對路徑，但是如果將publicPath設置成/，則打包后訪問路徑為localhost:8080/dist/main.js，本地無法訪問

所以這里需要在上線時候手動更改publicPath，感覺不是很方便，但是不知道該如何解決...

一般情況下publicPath應該以'/'結(jié)尾，而其他loader或插件的配置不要以'/'開頭

webpack-dev-server中的publicPath

點擊查看官方文檔中關于devServer.publicPath的介紹

在開發(fā)階段，我們借用devServer啟動一個開發(fā)服務器進行開發(fā)，這里也會配置一個publicPath，這里的publicPath路徑下的打包文件可以在瀏覽器中訪問。而靜態(tài)資源仍然使用output.publicPath。

webpack-dev-server打包的內(nèi)容是放在內(nèi)存中的，這些打包后的資源對外的的根目錄就是publicPath，換句話說，這里我們設置的是打包后資源存放的位置

例如：

// 假設devServer的publicPath為
const publicPath = '/dist/'
// 則啟動devServer后index.html的位置為
const htmlPath = `${pablicPath}index.html`
// 包的位置
cosnt mainJsPath = `${pablicPath}main.js`

以上可以直接通過http://lcoalhost:8080/dist/main.js訪問到。

通過訪問 http://localhost:8080/webpack-dev-server 可以得到devServer啟動后的資源訪問路徑，如圖所示，點擊靜態(tài)資源可以看到靜態(tài)資源的訪問路徑為 http://localhost:8080${publicPath}index.html

html-webpack-plugin

這個插件用于將css和js添加到html模版中，其中template和filename會受到路徑的影響，從源碼中可以看出

template

作用：用于定義模版文件的路徑

源碼：

this.options.template = this.getFullTemplatePath(this.options.template, compiler.context);

因此template只有定義在webpack的context下才會被識別，webpack context的默認值為process.cwd()，既運行 node 命令時所在的文件夾的絕對路徑

filename

作用：輸出的HTML文件名，默認為index.html，可以直接配置帶有子目錄

源碼：

this.options.filename = path.relative(compiler.options.output.path, filename);

所以filename的路徑是相對于output.path的，而在webpack-dev-server中，則是相對于webpack-dev-server配置的publicPath。

如果webpack-dev-server的publicPath和output.publicPath不一致，在使用html-webpack-plugin可能會導致引用靜態(tài)資源失敗，因為在devServer中仍然以output.publicPath引用靜態(tài)資源，和webpack-dev-server的提供的資源訪問路徑不一致，從而無法正常訪問。

有一種情況除外，就是output.publicPath是相對路徑，這時候可以訪問本地資源

所以一般情況下都要保證devServer中的publicPath與output.publicPath保持一致。