Webpack中publicPath路径问题详解

最近自己在搭建一个基于webpack的react项目，遇到关于output.publicpath和webpack-dev-server中publicpath的问题，而官方文档对它们的描述也不是很清楚，所以自己研究了下并写下本文记录。

output

output选项指定webpack输出的位置，其中比较重要的也是经常用到的有 path 和 publicpath

output.path

默认值： process.cwd()

output.path 只是指示输出的目录，对应一个 绝对路径 ，例如在项目中通常会做如下配置：

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

output.publicpath

默认值：空字符串

官方文档中对publicpath的解释 是

webpack 提供一个非常有用的配置，该配置能帮助你为项目中的所有资源指定一个基础路径，它被称为公共路径(publicpath)。

而关于如何应用该路径并没有说清楚...

其实这里说的所有资源的基础路径是指项目中引用css，js，img等资源时候的一个基础路径，这个基础路径要配合具体资源中指定的路径使用，所以其实打包后资源的访问路径可以用如下公式表示：

静态资源最终访问路径 = 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'

这个最终静态资源访问路径在使用html-webpack-plugin打包后得到的html中可以看到。所以 publicpath 设置成相对路径后，相对路径是相对于build之后的index.html的，例如，如果设置 publicpath: './dist/' ，则打包后js的引用路径为 ./dist/main.js ，但是这里有一个问题，相对路径在访问本地时可以，但是如果将静态资源托管到cdn上则访问路径显然不能使用相对路径，但是如果将 publicpath 设置成 / ，则打包后访问路径为 localhost:8080/dist/main.js ，本地无法访问

所以这里需要在上线时候手动更改 publicpath ，感觉不是很方便，但是不知道该如何解决...

一般情况下 publicpath应该以'/'结尾，而其他loader或插件的配置不要以'/'开头

webpack-dev-server中的publicpath

点击查看官方文档中关于devserver.publicpath的介绍

在开发阶段，我们借用devserver启动一个开发服务器进行开发，这里也会配置一个 publicpath ，这里的 publicpath 路径下的打包文件可以在浏览器中访问。而静态资源仍然使用 output.publicpath 。

webpack-dev-server打包的内容是放在内存中的，这些打包后的资源对外的的根目录就是 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启动后的资源访问路径，如图所示，点击静态资源可以看到静态资源的访问路径为 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可能会导致引用静态资源失败，因为在devserver中仍然以 output.publicpath 引用静态资源，和webpack-dev-server的提供的资源访问路径不一致，从而无法正常访问。

有一种情况除外，就是 output.publicpath 是相对路径，这时候可以访问本地资源

所以一般情况下都要保证devserver中的 publicpath 与 output.publicpath 保持一致。

最后

关于webpack中的 path 就总结这么多，在研究关于webpack路径的过程中看查到的一些关于路径的零碎的知识如下：

斜杠/的含义

配置中/代表url根路径，例如http://localhost:8080/dist/js/test.js中的http://localhost:8080/

devserver.publicpath & devserver.contentbase

1. devserver.contentbase 告诉服务器从哪里提供内容。只有在你想要提供静态文件时才需要。
2. devserver.publicpath 将用于确定应该从哪里提供 bundle，并且此选项优先。

node中的路径

1. __dirname: 总是返回被执行的 js 所在文件夹的绝对路径
2. __filename: 总是返回被执行的 js 的绝对路径
3. process.cwd(): 总是返回运行 node 命令时所在的文件夹的绝对路径

参考

详解webpack2的那些路径
webpack 公共路径(public path)
devserver.publicpath
浅析 nodejs 的几种文件路径

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。