vue项目设置proxy代理,客户端或浏览器如何去查看代理地址(2024-5-30)


1、简介

Web 项目部署时,会将前端和后端打包好放到服务器中。比如将 Vue 项目和 SpringBoot 项目打包好放到 Tomcat 中。

然后浏览器通过 HTTP 等协议从服务器获取 HTML、JS、CSS 等静态文件,之后 JS 请求库发 HTTP 请求到后端,后端根据请求返回数据,就这样前后端不断进行交互。

在开发 Vue 项目的时候,后面没有 Tomcat 来响应 HTTP 请求,之所以还是能够在浏览器中访问地址进行测试,是因为 Vue 项目启动了一个本地服务器。

vue.config.js中的 devServer 是用来配置这个本地服务器的。

  • port 配置服务器监听的端口号
  • host 配置服务器监听的主机名
// 配置例子
devServer: {
	port: 8080,
	host: 'localhost',
	https: false
}

//打开浏览器开发者工具查看网络请求,会发现请求指向http://localhost:8080。


2、客户端查看代理地址

vue.config.js 文件 

// vue.config.js代理配置
module.exports = {
  devServer: {
    proxy: {
      '/dev-api': {
          target: 'http://localhost:3000',
          changeOrigin: true,
          logLevel: 'debug',
          pathRewrite: {
            '^/dev-api': ''
          }
      }
    }
  }
}

//logLevel: 'debug', 
//在vscode、webstorm等客户端会显示代理接口请求之后终端会有显示真实的接口地址

将所有以 /dev-api 开头的请求代理到http://localhost:3000上。

其中 changeOrigin 表示将请求头中的 Host 字段设置为 target 的值,pathRewrite 表示对请求路径进行重写。

在这个例子中,对于以 /dev-api 开头的请求路径,将其重写为空,即去掉 /dev-api 前缀。

当前端使用 axios 请求 /dev-api/getInfo时,devServer 会将请求转发到http://localhost:3000/getInfo。


3、浏览器查看代理地址

配置请求信息头部,在控制台中查看真实的接口地址

如下例子

将所有以 /dev-api 开头的请求代理到https://www.baidu.com上。

pathRewrite 表示对请求路径进行重写,对于以 /dev-api 开头的请求路径,将其重写为空,即去掉 /dev-api 前缀。

当前端使用 axios 请求 /dev-api/captchaImage时,devServer 会将请求转发到https://www.baidu.com/captchaImage。

// vue.config.js代理配置
module.exports = {
  devServer: {
    proxy: {
      '/dev-api': {
          target: 'https://www.baidu.com',
          changeOrigin: true,
          logLevel: 'debug',
          pathRewrite: {
            '^/dev-api': ''
          },
          onProxyRes(proxyRes,response){
            // req.url = '/captchaImage'
            const realUrl = new URL(response.url,'https://www.baidu.com').href
            proxyRes.headers['x-real-url'] = realUrl
          },
      }
    }
  }
}


// 将真实的地址放在请求头 x-real-url

控制台接口信息头部会出现x-real-url参数,后面跟着就是真实的接口地址


### 正确配置 Vue 项目的反向代理 在开发 Vue 项目时,如果需要通过 Nginx 其他工具实现反向代理功能,则需注意前后端分离架构下的通信方式。以下是关于如何正确配置 Vue 项目的反向代理及其常见失败原因与解决方案。 #### 一、Vue 开发环境中的反向代理配置 Vue CLI 提供了一个内置的 `devServer.proxy` 功能来处理开发环境中的跨域问题。可以在 `vue.config.js` 文件中设置如下: ```javascript module.exports = { devServer: { proxy: { '/api': { // 将以 /api 开头的请求代理到目标地址 target: 'http://localhost:5000', // 后端服务的实际地址 changeOrigin: true, // 是否改变源 pathRewrite: { '^/api': '' } // 可选路径重写规则 } } } }; ``` 上述代码的作用是将前端发送至 `/api/*` 的请求转发到指定的目标服务器上[^1]。 --- #### 二、生产环境中使用 Nginx 实现反向代理项目部署到生产环境时,通常会借助 Nginx 来完成反向代理的功能。以下是一个典型的 Nginx 配置示例: ```nginx server { listen 80; server_name yourdomain.com; location / { root /path/to/dist; # Vue 构建后的静态文件目录 index index.html; try_files $uri /index.html; # 支持单页应用路由模式 } location /api/ { proxy_pass http://backend_server_address/; proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; } } ``` 此配置实现了两个主要功能: 1. **静态资源分发**:通过 `location / {}` 处理用户的访问请求并将 HTML 页面返回给客户端。 2. **API 请求转发**:通过 `location /api/ {}` 将 API 请求转发到后端服务器[^2]。 --- #### 三、常见的反向代理失败原因及解决方案 ##### 1. 路径匹配不一致 如果前端发出的请求 URL 和 Nginx 中定义的正则表达式前缀不符,可能导致无法成功匹配到对应的 `location` 块。例如,假设前端请求的是 `/data/getInfo`,而 Nginx 配置只监听了 `/api/*`,那么该请求不会被代理。 **解决方案**: 确保前端接口调用的路径与 Nginx 配置保持一致性。 ##### 2. `proxy_pass` 地址错误 如果 `proxy_pass` 指定的目标地址有误(如拼写错误、协议缺失),可能会导致请求无法到达实际的服务端口。 **解决方案**: 使用正确的主机名 IP 地址,并确认其可用性。可以通过命令行测试连接情况,例如 `curl http://target-server-address/api/test`. ##### 3. CORS 问题未完全解决 即使设置了反向代理,在某些情况下仍可能出现跨域资源共享 (CORS) 报错的情况。这通常是由于浏览器的安全策略所致。 **解决方案**: 在后端程序中显式允许特定来源的请求;者继续优化 Nginx 配置,确保所有必要的 HTTP Header 已经正确传递[^4]。 ##### 4. 缺少必要 Headers 部分后端框架依赖于额外的信息字段才能正常工作,比如真实的客户端 IP (`X-Real-IP`) 者原始域名 (`Host`)。如果没有正确设置这些参数,可能引发异常行为。 **解决方案**: 添加相应的指令,像这样: ```nginx proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; ``` --- ### 总结 为了使 Vue 应用能够顺利运行并通过反向代理机制与其他微服务交互,请仔细检查以上提到的各项要点——无论是本地调试阶段还是正式上线之前都需要反复验证每一步骤是否无误执行到位.
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值