前端请求接口地址反向代理后 状态码404、反向代理注意事项

1. 反向代理代码（有问题）

接口封装

export function GetCardNum() {
  return request({
    url: '/mon_archive_cabi***_RFID/api/GetCardNum'
  })
}

代理配置

// webpack-dev-server 相关配置
devServer: {
  host: '0.0.0.0',
  port: 8080,
  https: false,
  hotOnly: false,
  open: true, // 自动打开浏览器
  proxy: {
    // ...
    '/api': {
      ws: false, // proxy websockets
      target: 'http://192.168.0.42:9151',
      pathRewrite: { '^/api': '' },
    },
    // ...
    '/mon_archive_cabi***': {
      target: 'http://192.168.0.26:9577',
    },
    '/mon_archive_cabi***_RFID': { // 【主要代码】代理代码
      target: 'http://localhost:5001',
      pathRewrite: { '^/mon_archive_cabi***_RFID': '' }
    },
    '/': {
      target: 'http://192.168.0.42:9000'
    }
  }
},

问题

接口404

2. 问题排查原因

【排查步骤】

1. 思考一下：我们要先看一下接口请求地址 反向代理的真实地址 是哪里，然后看看是代理的问题还是其他问题；
2. 真实地址查看：在代理配置中添加 logLevel: 'debug' 配置，就可以在终端打印出请求地址的代理地址，但是我的加上没有用，终端没有输出任何东西；
3. 2没有用那就找其他办法查看代理的真实地址：代理配置在 onProxyRes 中给请求头添加 x-real-url1 配置展示真实的请求地址；
   
4. 发现代理的地址是 /api 的代理地址 http://192.168.0.42:9151 【问题1】
5. 【问题1解决】修改 /api 代理为 ^/api (修改原因见下 问题1 解释)
6. 发现代理的地址又变成了 /mon_archive_cabi*** 代理的地址【问题2】
   
7. 【问题2解决】修改接口请求地址的前缀 /mon_archive_cabi***_RFID 为 /RFID （即修改接口请求地址 /mon_archive_cabi***_RFID/api/GetCardNum 为 /RFID/api/GetCardNum），并且修改反向代理 /mon_archive_cabi***_RFID 为 /RFID (修改原因见下 问题2 解释)
8. 验证【问题2解决】
   

【问题1】产生原因

/api 代理的意思是：只要请求地址中含有 /api 就都使用该代理，并且不会使用该代理以下的其他代理；
^/api 代理的意思是：只匹配以 /api 开头的请求地址，其余的不匹配
【所以】修改 /api 代理为 ^/api

【问题2】产生原因

顺序问题、地址开头问题

/mon_archive_cabi*** 代理：我们要使用的请求地址 /mon_archive_cabi***_RFID/api/GetCardNum 中含有该代理 && 请求地址开头与该代理一致（模糊匹配） && 该代理在 /mon_archive_cabi***_RFID 代理代码前，所以就匹配到了该代理而不继续匹配该代理代码后的 /mon_archive_cabi***_RFID 代理
【解决】2种办法

1. 将 /mon_archive_cabi***_RFID 代理的代码放在 /mon_archive_cabi*** 代理代码前；
2. 修改 /mon_archive_cabi***_RFID 代理名和请求地址开头地址（我用的这种解决办法）。

【附：排查代码】

代理配置 - 排查问题原因

devServer: {
  host: '0.0.0.0',
  port: 8080,
  https: false,
  hotOnly: false,
  open: true, // 自动打开浏览器
  proxy: {
    // ...
    // '/api': {
    '^/api': {
      ws: false, // proxy websockets
      target: 'http://192.168.0.42:9151',
      pathRewrite: { '^/api': '' },

      changeOrigin: true,
      logLevel: 'debug', // 该代码可在控制台输出代理的真实地址 - 但是我的就没有
      onProxyRes(proxyRes, req, res) {
        console.log('req.url----api----', req.url) // 会在终端打印出当前请求地址 - 不加域名的请求地址
        // 增加代理的真实地址
        const realUrl = new URL(req.url || '', 'http://192.168.0.42:9151' || '')
        proxyRes.headers['x-real-url1'] = realUrl // 在请求头添加 x-real-url1 字段，展示实际请求的地址 - 代理之后地址
      }
    },
    // ...
    '/mon_archive_cabi***': {
      target: 'http://192.168.0.26:9577',

      changeOrigin: true,
      logLevel: 'debug', // 该代码可在控制台输出代理的真实地址 - 但是我的就没有
      onProxyRes(proxyRes, req, res) {
        console.log('req.url----mon_archive_cabi***----', req.url) // 会在终端打印出当前请求地址 - 不加域名的请求地址
        // 增加代理的真实地址
        const realUrl = new URL(req.url || '', 'http://192.168.0.26:9577' || '')
        proxyRes.headers['x-real-url1'] = realUrl // 在请求头添加 x-real-url1 字段，展示实际请求的地址 - 代理之后地址
      }
    },
    // '/mon_archive_cabi***_RFID': { // 会和 /mon_archive_cabi*** 代理冲突
    '^/RFID': {
      target: 'http://localhost:5001',
      changeOrigin: true,
      logLevel: 'debug', // 该代码可在控制台输出代理的真实地址 - 但是我的就没有
      onProxyRes(proxyRes, req, res) {
        console.log('req.url---RFID-----', req.url) // 会在终端打印出当前请求地址 - 不加域名的请求地址
        // 增加代理的真实地址
        const realUrl = new URL(req.url || '', 'http://localhost:5001' || '')
        proxyRes.headers['x-real-url1'] = realUrl // 在请求头添加 x-real-url1 字段，展示实际请求的地址 - 代理之后地址
      },
      // pathRewrite: { '^/mon_archive_cabi***_RFID': '' }
      pathRewrite: { '^/RFID': '' } // 实际请求中请求地址不会加 /RFID
    },
    '/': {
      target: 'http://192.168.0.42:9000'
    }
  }
},

3. 总结 - 解决代码

接口封装

export function GetCardNum() {
  return request({
    // url: 'http://192.168.10.106:5001/api/GetCardNum' // 本地ip
    // url: 'http://localhost:5001/api/GetCardNum' // 测试接口时接口地址
    // url: '/mon_archive_cabi***_RFID/api/GetCardNum' // 接口地址添加反向代理地址头（不用 - 因为会和 /mon_archive_cabi*** 代理冲突）
    url: '/RFID/api/GetCardNum' // 接口地址添加反向代理地址头
    // url: '/mon_archive_cabi***/api/GetCardNum' // 排查问题时借用 /mon_archive_cabi*** 地址头
  })
}

代理配置

devServer: {
  host: '0.0.0.0',
  port: 8080,
  https: false,
  hotOnly: false,
  open: true, // 自动打开浏览器
  proxy: {
    // ...
    '^/api': { // 【解决问题主要代码】添加 ^ 表示以 /api 开头的地址代理到此处；不加 ^ 则只要地址里有 /api 就可代理此处，代理此处后则此处以下的代码将不会被代理到
      ws: false, // proxy websockets
      target: 'http://192.168.0.42:9151',
      pathRewrite: { '^/api': '' },
    },
    // ...
    '/mon_archive_cabi***': {
      target: 'http://192.168.0.26:9577',
    },
    // '/mon_archive_cabi***_RFID': { // 会和 /mon_archive_cabi*** 代理冲突，所以不用
    '^/RFID': {
      target: 'http://localhost:5001',
      // changeOrigin: true, // 默认是 true
      // pathRewrite: { '^/mon_archive_cabi***_RFID': '' }
      pathRewrite: { '^/RFID': '' }
    },
    '/': {
      target: 'http://192.168.0.42:9000'
    }
  }
},

4. 总结 - 反向代理

• 代理地址有多个时：
  1. 注意是以某些地址开头还是含有某些地址；
  2. 注意模糊匹配，不是匹配地址中 / 和 / 之间的精准匹配；
  3. 注意代理地址顺序，以免写在最后的代理被写在前边的代理优先代理，导致请求失败。

【注意】本地反向代理 与 线上反向代理

前端 vue 项目中 vue.config.js 中配置的反向代理只有前端本地运行项目有用，线上部署之后反向代理用的是后端 nginx 配置的代理。

• 在 vue.config.js 中配置了 proxy 跨域后执行 npm run build 打包部署到服务器上会报跨域问题 或 接口请求404，为什么会报错呢？
  • 因为编译打包后，前端页面成为了单独的静态资源，代理服务器 devServer.proxy 被抽离出去了。
  • 也就是说，devServer.proxy 不会一起打包到 dist 文件夹下，所以相当于我们没有配置代理服务器！！
• 怎么解决呢？资源要被访问，那必须要有一个代理服务器来装载它。
  • 我们部署上线最常见的就是使用 nginx 进行反向代理，只需要修改 nginx 配置文件即可。
• 来源