React 脚手架配置代理完整指南(最新推荐)

更新时间：2024年12月31日 14:17:51 作者：傻小胖

本文详细介绍了React脚手架配置代理的多种方式,文章还讨论了常见问题的解决方案,如跨域问题、WebSocket代理和错误处理,并提供了生产环境配置建议和调试技巧,感兴趣的朋友一起看看吧

React 脚手架配置代理完整指南

1. 代理配置方式概述

React 脚手架中配置代理主要有以下几种方式：

在 package.json 中配置简单代理
在 src/setupProxy.js 中配置复杂代理
使用 nginx 反向代理
使用环境变量配置代理

2. 基础配置方法

2.1 package.json 简单配置

{
  "name": "my-app",
  "version": "0.1.0",
  "private": true,
  "proxy": "http://localhost:5000"
}

这种方式的特点：

优点：配置简单
缺点：只能配置单个代理
适用场景：只需要代理到单个接口服务器

2.2 setupProxy.js 配置

// src/setupProxy.js
const { createProxyMiddleware } = require('http-proxy-middleware');
module.exports = function(app) {
  app.use(
    '/api',
    createProxyMiddleware({
      target: 'http://localhost:5000',
      changeOrigin: true,
      pathRewrite: {
        '^/api': ''
      }
    })
  );
  app.use(
    '/api2',
    createProxyMiddleware({
      target: 'http://localhost:5001',
      changeOrigin: true,
      pathRewrite: {
        '^/api2': ''
      }
    })
  );
};

这种方式的特点：

优点：可以配置多个代理，更灵活
缺点：配置相对复杂
适用场景：需要代理到多个服务器

3. 高级配置示例

3.1 带身份验证的代理

// src/setupProxy.js
const { createProxyMiddleware } = require('http-proxy-middleware');
module.exports = function(app) {
  app.use(
    '/api',
    createProxyMiddleware({
      target: 'http://localhost:5000',
      changeOrigin: true,
      onProxyReq: function(proxyReq, req, res) {
        // 添加自定义请求头
        proxyReq.setHeader('Authorization', 'Bearer your-token');
      },
      onProxyRes: function(proxyRes, req, res) {
        // 处理响应头
        proxyRes.headers['x-proxy-by'] = 'your-app';
      }
    })
  );
};

3.2 带路径重写的代理

// src/setupProxy.js
const { createProxyMiddleware } = require('http-proxy-middleware');
module.exports = function(app) {
  app.use(
    '/api',
    createProxyMiddleware({
      target: 'http://localhost:5000',
      changeOrigin: true,
      pathRewrite: {
        '^/api/old-path': '/api/new-path', // 重写路径
        '^/api/remove': '' // 删除路径
      },
      router: {
        // 根据请求路径改变目标服务器
        'dev.localhost:3000': 'http://localhost:8000',
        'staging.localhost:3000': 'http://localhost:9000'
      }
    })
  );
};

3.3 带负载均衡的代理

// src/setupProxy.js
const { createProxyMiddleware } = require('http-proxy-middleware');
// 定义目标服务器列表
const targets = [
  'http://localhost:5000',
  'http://localhost:5001',
  'http://localhost:5002'
];
let currentIndex = 0;
module.exports = function(app) {
  app.use(
    '/api',
    createProxyMiddleware({
      target: targets[0],
      changeOrigin: true,
      router: () => {
        // 简单的轮询负载均衡
        currentIndex = (currentIndex + 1) % targets.length;
        return targets[currentIndex];
      }
    })
  );
};

4. 环境变量配置

4.1 创建环境变量文件

# .env.development
REACT_APP_API_URL=http://localhost:5000
# .env.production
REACT_APP_API_URL=https://api.production.com

4.2 使用环境变量配置代理

// src/setupProxy.js
const { createProxyMiddleware } = require('http-proxy-middleware');
module.exports = function(app) {
  app.use(
    '/api',
    createProxyMiddleware({
      target: process.env.REACT_APP_API_URL,
      changeOrigin: true
    })
  );
};

5. 常见问题和解决方案

5.1 跨域问题

// src/setupProxy.js
module.exports = function(app) {
  app.use(
    '/api',
    createProxyMiddleware({
      target: 'http://localhost:5000',
      changeOrigin: true,
      onProxyRes: function(proxyRes, req, res) {
        // 处理跨域响应头
        proxyRes.headers['Access-Control-Allow-Origin'] = '*';
        proxyRes.headers['Access-Control-Allow-Methods'] = 'GET,PUT,POST,DELETE,OPTIONS';
        proxyRes.headers['Access-Control-Allow-Headers'] = 'Content-Type,Authorization';
      }
    })
  );
};

5.2 WebSocket 代理

// src/setupProxy.js
module.exports = function(app) {
  app.use(
    '/socket',
    createProxyMiddleware({
      target: 'ws://localhost:5000',
      ws: true, // 启用 websocket 代理
      changeOrigin: true
    })
  );
};

5.3 错误处理

// src/setupProxy.js
module.exports = function(app) {
  app.use(
    '/api',
    createProxyMiddleware({
      target: 'http://localhost:5000',
      changeOrigin: true,
      onError: function(err, req, res) {
        res.writeHead(500, {
          'Content-Type': 'text/plain'
        });
        res.end('Proxy Error: ' + err);
      }
    })
  );
};

6. 生产环境配置

6.1 使用 nginx 配置

# nginx.conf
server {
    listen 80;
    server_name your-domain.com;
    location /api {
        proxy_pass http://backend-server;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
    location / {
        root /usr/share/nginx/html;
        index index.html;
        try_files $uri $uri/ /index.html;
    }
}

7. 最佳实践

开发环境建议：

使用 setupProxy.js 进行配置
避免在生产环境使用代理
使用环境变量管理配置

生产环境建议：

使用 nginx 等专业代理服务器
配置适当的缓存策略
注意安全性配置

调试技巧：

使用 console.log 调试代理配置
检查网络请求面板
验证请求头和响应头

性能优化：

合理使用缓存
避免不必要的代理
考虑使用负载均衡

到此这篇关于React 脚手架配置代理完整指南的文章就介绍到这了,更多相关React 脚手架配置代理内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

React18中请求数据的官方姿势适用其他框架
这篇文章主要为大家介绍了官方回答在React18中请求数据的正确姿势详解，同样也适用其他框架，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-07-07
react实现移动端下拉菜单的示例代码
这篇文章主要介绍了react实现移动端下拉菜单的示例代码，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-01-01
jenkins分环境部署vue/react项目的方法步骤
这篇文章主要介绍了jenkins分环境部署vue/react项目的方法，本文分步骤给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
2022-02-02
React虚拟列表的实现
在开发过程中，总是遇到很多列表的显示。当上数量级别的列表渲染于浏览器，终会导致浏览器的性能下降，你可以选择其他方式避免，本文就介绍了虚拟列表来解决这个问题
2021-05-05
react ant protable自定义实现搜索下拉框
这篇文章主要介绍了react ant protable自定义实现搜索下拉框，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-06-06
react中引入less并支持antd主题换肤方式
这篇文章主要介绍了react中引入less并支持antd主题换肤方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2024-01-01
使用React-Window实现虚拟滚动效果的示例代码
React-Window 是一个为 React 应用程序中高效渲染大数据集而设计的库,它基于窗口化或虚拟化的原则运行,本文将使用React-Window实现虚拟滚动效果,感兴趣的可以了解下
2024-01-01
react批量引入svg图标的方法
这篇文章主要介绍了react批量引入svg图标的方法,在批量引入之前,我们需要安装一个包并配置到typescript.json文件中,需要的朋友可以参考下
2024-03-03
react路由基础解读(Router、Link和Route)
这篇文章主要介绍了react路由基础解读(Router、Link和Route)，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-07-07
ahooks封装cookie localStorage sessionStorage方法
这篇文章主要为大家介绍了ahooks封装cookie localStorage sessionStorage的方法示例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-07-07