解决webpack-dev-server代理常切换问题

背景

通常我们有一份webpack.dev.config.js使用webpack-dev-server的proxy，代理到开发服务器，来解决本地跨域问题。假如项目变大，可能需要proxy到不同环境，比如docker，或者后端开发人员的电脑上

现有问题

• 需要手动更改proxy配置，比较麻烦还容易写错
• 改变后的config文件会被git检测到
• 不小心将本地修改的配置push到远程仓库，对其他人造成困扰

需求

假如本地开发服务器是dev.xxx.cn，docker环境是docker.xxx.cn，服务端开发人员ip是192.168.1.1

因为我本地用了gulp，启动前端开发环境到命令是 gulp local (与 npm run xx 的效果差不多)，那么我希望

gulp local
gulp local -t docker
gulp local -t 192.168.1.1

解决方案

创建webpack.local.js，proxy配置如下

proxy: {
  '/api/**': {
    target: 'http://{target|dev}.xxx.cn',
    changeOrigin: true,
  },
}复制代码

在我们运行 gulp local 时，读取local.config文件，替换{target|dev}为 -t 后的内容，比如 gulp local -t docker ，替换后变为 'http://docker.xxx.cn'

再将替换后的文件内容输出到一个名为webpack.local.target.js的文件里，然后执行 webpack-dev-server -c webpack.local.target.js

最后修改.gitignore文件，加入webpack.loc.target.js，这样每次生成的文件就不会被误push到远程

实现细节

上面的配置中 {target|dev} |后面的dev是执行 gulp local 时的默认选项

const { t } = gulputil.env
let config = fs.readFileSync(_path.join(__dirname, '/webpack.loc.js')).toString()

if (/\d{1,3}(\.\d{1,3}){3}/.test(t)) {
  config = config.replace(/\\{target[^}]+\\}[^']*/g, t)
} else if (typeof t === 'string' && t.length > 0) {
  config = config.replace(/\\{target[^}]+\\}/g, t)
} else {
  config = config.replace(/\\{target\\|([^}]+)\\}/g, '$1')
}
fs.writeFileSync(_path.join(__dirname, '/webpack.loc.target.js'), config)复制代码

第一个if判断内容为-t后的参数是否为ip，如果是，替换 'http://{target|dev}.xxx.cn' 为 http://192.168.1.1
第二个判断是否有参数，如果有，替换为 http://docker.xxx.cn
第三个判断就是直接运行 gulp local 不加 -t 时，替换为 http://dev.xxx.cn

正则不太懂可以看我另一篇文章《正则速记法》

觉得运行开发环境打包慢可以看《webpack性能榨汁机》