Vue.config.js中配置Proxy代理HTTPS

创作时间:

作者:

@小白创作中心

Vue.config.js中配置Proxy代理HTTPS

引用

CSDN

https://blog.csdn.net/black_cat7/article/details/142469102

Vue.config.js中配置Proxy代理HTTPS

在开发基于Vue.js的应用时，经常会遇到前后端分离的情况，即前端应用与后端API服务器部署在不同的域名下。由于浏览器的同源策略限制，直接请求其他域名的数据会导致CORS（跨域资源共享）错误。为了解决这个问题，Vue CLI提供了vue.config.js文件，允许开发者配置代理服务器来绕过跨域限制。本文将详细介绍如何在vue.config.js中配置HTTPS代理，帮助你在开发环境中无缝对接后端API。

基本概念与作用

Vue CLI内置了基于Webpack的开发服务器，它提供了热重载、实时编译等功能，极大地提高了开发效率。但在开发过程中，直接向后端API发起请求可能会因为同源策略而失败。通过在vue.config.js中配置代理，可以让开发服务器充当代理服务器的角色，将请求转发到正确的API地址。

为什么要使用HTTPS代理？

安全性：HTTPS协议加密传输数据，保护敏感信息不被窃取。
认证：确保客户端与服务器之间的通信是可信的。
行业标准：越来越多的网站和服务要求使用HTTPS连接。

示例一：基础HTTPS代理配置

首先，我们需要创建一个vue.config.js文件（如果尚未存在），并在其中配置代理规则。以下是一个简单的配置示例：

module.exports = {
  devServer: {
    proxy: {
      '/api': {
        target: 'https://api.example.com',
        changeOrigin: true, // 修改目标的origin为代理服务器origin
        pathRewrite: { '^/api': '' }, // 重写路径，去除'/api'前缀
      },
    },
  },
};

在这个示例中，所有以/api开头的请求都会被转发到https://api.example.com，并且路径中的/api会被移除。

示例二：多环境代理配置

在实际开发中，我们可能需要针对不同的环境（如开发、测试、生产）配置不同的API服务器地址。这时可以利用环境变量来动态设置代理目标。

module.exports = {
  devServer: {
    proxy: {
      '/api': {
        target: process.env.VUE_APP_API_URL,
        changeOrigin: true,
        pathRewrite: { '^/api': '' },
      },
    },
  },
};

在.env文件中设置：

VUE_APP_API_URL=https://api.dev.example.com

这样，我们可以通过更改.env文件中的VUE_APP_API_URL来切换API服务器。

示例三：忽略某些路径

有时候，我们可能不希望所有的请求都被代理，而是只有特定的路径。可以通过exclude选项来排除不需要代理的路径。

module.exports = {
  devServer: {
    proxy: {
      '/api': {
        target: 'https://api.example.com',
        changeOrigin: true,
        pathRewrite: { '^/api': '' },
        exclude: ['/api/auth'],
      },
    },
  },
};

在这个示例中，所有以/api开头但不包含/auth的请求将会被代理。

示例四：支持WebSocket代理

在一些场景下，我们需要使用WebSocket与后端建立连接。为了保证WebSocket请求同样可以正确代理，需要在配置中显式支持WebSocket。

module.exports = {
  devServer: {
    proxy: {
      '/ws': {
        target: 'wss://api.example.com',
        ws: true,
        changeOrigin: true,
        pathRewrite: { '^/ws': '' },
      },
    },
  },
};

这里我们为WebSocket请求指定了不同的target，并通过ws: true启用WebSocket支持。

示例五：高级配置

Vue CLI的代理配置还支持更高级的功能，比如基于正则表达式的匹配、自定义中间件等。

module.exports = {
  devServer: {
    proxy: {
      '/api': {
        target: 'https://api.example.com',
        changeOrigin: true,
        pathRewrite: { '^/api': '' },
        // 自定义中间件
        ws: true,
        logLevel: 'debug',
        onProxyRes(proxyRes, req, res) {
          // 在代理响应之前执行的操作
          console.log(proxyRes.headers);
        },
        onProxyReq(proxyReq, req, res) {
          // 在发送代理请求之前执行的操作
          proxyReq.setHeader('X-Requested-With', 'XMLHttpRequest');
        },
      },
    },
  },
};

在这个示例中，我们添加了两个自定义中间件函数onProxyRes和onProxyReq，分别在代理响应和请求时执行额外的操作。