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

 更新时间:2022年09月19日 17:05:03   作者:Atdow  
这篇文章主要为大家介绍了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配置源码

配置校验源码

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

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 || ''
    }
  }
}

proxy.js最后导出一个对象,这个对象跟我们以前使用的旧代理方案很像,但是多了一个router配置router函数返回执行getConfig函数读取配置文件的内容,也就是我们的代理地址。

environments目录下新建我们的代理配置文件proxy-config.json

{
    "target": "https://www.baidu.com"
}

当项目启动后,会读取我们的代理配置文件。我们在项目启动后,手动修改代理配置文件的代理地址,然后刷新页面,就可以使我们的新代理地址生效。

示例demo

github.com/atdow/vue-d…

以上就是vue动态代理无须重启项目解决方案详解的详细内容,更多关于vue 动态代理的资料请关注脚本之家其它相关文章!

相关文章

  • 基于Vue-cli快速搭建项目的完整步骤

    基于Vue-cli快速搭建项目的完整步骤

    这篇文章主要给大家介绍了关于如何基于Vue-cli快速搭建项目的完整步骤,文中通过示例代码以及图片将搭建的步骤一步步介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2018-11-11
  • vue.config.js配置报错解决办法(可能是与webpack混淆)

    vue.config.js配置报错解决办法(可能是与webpack混淆)

    在Vue.js开发过程中,vue.config.js文件是用于配置项目的,特别是对于开发环境的设置,这篇文章主要给大家介绍了关于vue.config.js配置报错解决的相关资料,可能是与webpack混淆,需要的朋友可以参考下
    2024-06-06
  • VUE实现表单元素双向绑定(总结)

    VUE实现表单元素双向绑定(总结)

    本篇文章主要介绍了VUE实现表单元素双向绑定(总结) ,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-08-08
  • vue 如何将二维数组转化为一维数组

    vue 如何将二维数组转化为一维数组

    这篇文章主要介绍了vue 如何将二维数组转化为一维数组,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-04-04
  • Vue中进行路由懒加载的示例详解

    Vue中进行路由懒加载的示例详解

    路由懒加载是一种优化Vue应用程序性能的技术,本文介绍了Vue中如何进行路由懒加载,包括使用Vue异步组件和Webpack代码分割,需要的朋友可以参考下
    2023-06-06
  • Vue3中使用混入(Mixin)的示例详解

    Vue3中使用混入(Mixin)的示例详解

    混入(Mixin)是 Vue 中一种代码复用的模式,允许将组件的选项抽离为独立模块,下面就跟随小编一起来深入了解下如何在Vue3中使用混入Mixin吧
    2025-03-03
  • 基于vue-cli搭建多模块且各模块独立打包的项目

    基于vue-cli搭建多模块且各模块独立打包的项目

    这篇文章主要介绍了基于vue-cli搭建多模块且各模块独立打包的项目,本文给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下
    2019-06-06
  • vue如何设置动态的栅格占位、水平偏移量、类名、样式

    vue如何设置动态的栅格占位、水平偏移量、类名、样式

    这篇文章主要介绍了vue如何设置动态的栅格占位、水平偏移量、类名、样式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-09-09
  • Vue报错error:0308010C:digital envelope routines::unsupported的解决方法

    Vue报错error:0308010C:digital envelope routines::unsupported

    这篇文章主要给大家介绍了关于Vue报错error:0308010C:digital envelope routines::unsupported的解决方法,文中通过图文将解决的办法介绍的非常详细,需要的朋友可以参考下
    2022-11-11
  • vue使用keep-alive无效以及include和exclude用法解读

    vue使用keep-alive无效以及include和exclude用法解读

    这篇文章主要介绍了vue使用keep-alive无效以及include和exclude用法解读,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-07-07

最新评论