vue动态代理无须重启项目解决方案

本文主要是介绍vue动态代理无须重启项目解决方案，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

1.背景

当我们vue构建项目的时候，都会在vue.config.js中配置我们需要代理的服务器地址。有时候我们需要使用不同后端服务器地址，也就是我们开发中所说的测试环境、灰度环境、正式环境等，这个时候如果我们需要使用不同的环境地址的时候，就需要使用命令或者手动修改vue.config.js中配置来重新启动项目。当项目项目越来越大的时候，我们需要很长的时间来启动项目，如此反复，极大影响我们开发进度。这个时候我们急需一种vue动态代理无须重启项目解决方案来提高我们的开发项目，以此为背景，萌生出了以下方案。

2.技术方案

2.1 旧的配置方案

我们在vue.config.js中常用的代理方案如下：

const port = process.env.port || process.env.npm_config_port || 80 // 端口
module.exports = {lintOnSave: false,devServer: {host: '0.0.0.0',port,open: false,proxy: {'/my-api': {target: 'https://www.baidu.com',ws: false,changeOrigin: true,}}}
}

在启动项目的时候，只会读取一次配置文件，当再次修改target地址时，vue-cli是无法感知文件的变化，所以代理的还是旧的地址，所以我们需要重新启动项目来使配置生效。有没有一种方案，可以在修改配置的时候能使vue-cli感知到文件的变化，从而读取新的配置呢？方案入下：

2.2 新的配置方案思路

vue-cli 的代理是使用的http-proxy-middleware包，所以proxy选项的配置也是基于这个包的配置。在proxy配置选项中有两个属性target以及router。其中target是默认的代理地址。而router可以return一个字符串服务地址，那么当两个选项都配置了时，http-proxy-middleware在解析配置时，会首先使用router函数的返回值，当router的返回值不可以用时，那么就会fallback至target。

http-proxy-middleware router配置源码

配置校验源码

我们可以使用proxy中router来读取我们的代理配置文件，这样就可以实现修改代理配置文件来更新代理地址，无须启动项目。

3. 配置

在vue.config.js中加入如下配置：

// vue.config.js
const dynamicProxy = require('./environments/proxy.js')
const port = process.env.port || process.env.npm_config_port || 80 // 端口module.exports = {lintOnSave: false,devServer: {host: '0.0.0.0',port,open: false,proxy: dynamicProxy.proxy,disableHostCheck: true},
}

新建environments文件夹，同时在里面新建proxy.js文件

// proxy.js
const fs = require('fs')
const path = require('path')const encoding = 'utf-8'
/*** 获取配置文件内容 getContent('proxy-config.json')* @param filename env.json* @returns {string}*/
const getContent = filename => {const dir = path.resolve(process.cwd(), 'environments')return fs.readFileSync(path.resolve(dir, filename), { encoding })
}const jsonParse = obj => {return Function('"use strict";return (' + obj + ')')()
}/*** 获取配置选项 getConfig()* @returns {{}|*}*/
const getConfig = () => {try {return jsonParse(getContent('proxy-config.json'))} catch (e) {return {}}
}module.exports = {proxy: {// 接口匹配规则自行修改['/my-api']: {target: 'that must have a empty placeholder', // 这里必须要有字符串来进行占位changeOrigin: true,router: () => (getConfig() || {}).target || ''}}
}