Kc's blog

Appearance

kc_shen2025-07-23
1542
5.9m

统一代理服务器项目总结：一个强大的Node.js代理解决方案 ​

项目概述 ​

最近我开发并部署了一个功能强大的统一代理服务器，这是一个基于Node.js和Express的通用代理解决方案。该项目的主要目标是提供一个统一的接口来代理多个不同的API服务，通过简单的key参数来动态选择目标服务器。

线上访问地址： http://birth.kcshen.cn:3002/proxy/huoshan/

核心功能特性 ​

🎯 统一代理路由 ​

  • 使用 /proxy/{key}/* 格式的统一路由
  • 通过key参数动态选择不同的目标服务器
  • 支持所有HTTP方法：GET、POST、PUT、DELETE、PATCH等

🔄 多种key传递方式 ​

  1. URL参数方式（推荐）：/proxy/users/users/1
  2. 查询参数方式：/proxy/users/1?key=users
  3. 请求体方式：在POST请求体中包含key字段

🛡️ 完善的中间件支持 ​

  • CORS处理：自动解决跨域问题
  • 请求日志：详细的请求和响应日志记录
  • 错误处理：完善的错误处理和用户友好的错误信息
  • 安全防护：使用helmet、rate-limit等安全中间件

📊 监控和健康检查 ​

  • 健康检查接口：/health
  • 可用key列表：/proxy/keys
  • 详细的请求日志和错误追踪

技术架构 ​

核心技术栈 ​

  • Node.js - 运行时环境
  • Express.js - Web框架
  • Axios - HTTP客户端
  • PM2 - 进程管理
  • Nginx - 反向代理（可选）

项目结构 ​

Agent/
├── server.js              # 主服务器文件
├── proxy-middleware.js    # 核心代理中间件
├── package.json          # 项目配置
├── ecosystem.config.js   # PM2配置文件
├── deploy.sh            # 部署脚本
├── DEPLOYMENT.md        # 部署文档
├── nginx/               # Nginx配置
└── README.md           # 项目文档

核心代码解析 ​

代理中间件实现 ​

javascript
function createProxyMiddleware(urlMap) {
    return async (req, res, next) => {
        // 1. 获取key参数
        const key = req.params.key || req.query.key || req.body.key;
        
        // 2. 验证key并获取目标URL
        const targetUrl = urlMap[key];
        
        // 3. 构建完整的目标URL
        const fullUrl = `${targetUrl}${requestPath}`;
        
        // 4. 转发请求
        const response = await axios(requestConfig);
        
        // 5. 返回响应
        res.status(response.status).send(response.data);
    };
}

URL映射配置 ​

javascript
const urlMap = {
    'huoshan': 'https://openspeech.bytedance.com/api/v1/tts',
    // 可以轻松添加更多API映射
};

部署方案 ​

生产环境部署 ​

项目使用PM2进行进程管理，支持以下特性：

  • 集群模式：利用所有CPU核心
  • 自动重启：进程崩溃时自动重启
  • 日志管理：分离的访问日志和错误日志
  • 内存限制：防止内存泄漏
  • 开机自启：系统重启后自动启动

部署脚本 ​

bash
# 开发环境部署
./deploy.sh dev

# 生产环境部署
./deploy.sh prod

# 查看状态
./deploy.sh status

监控和维护 ​

  • 健康检查：curl http://birth.kcshen.cn:3002/health
  • 日志查看：pm2 logs proxy-server-prod
  • 性能监控：pm2 monit

使用示例 ​

基本使用 ​

bash
# 获取可用的key列表
curl http://birth.kcshen.cn:3002/proxy/keys

# 使用代理访问API
curl http://birth.kcshen.cn:3002/proxy/huoshan/

JavaScript/Node.js集成 ​

javascript
const axios = require('axios');

// 通过代理访问API
const response = await axios.get('http://birth.kcshen.cn:3002/proxy/huoshan/');
console.log(response.data);

前端集成 ​

javascript
// 获取API数据
fetch('http://birth.kcshen.cn:3002/proxy/huoshan/')
    .then(response => response.json())
    .then(data => {
        console.log('API响应:', data);
    });

项目亮点 ​

1. 高度可扩展 ​

  • 通过简单的配置即可添加新的API映射
  • 支持任意数量的目标服务器
  • 模块化的中间件设计

2. 开发友好 ​

  • 详细的日志输出
  • 完善的错误处理
  • 丰富的文档和示例

3. 生产就绪 ​

  • PM2进程管理
  • 健康检查机制
  • 自动重启和监控
  • 安全防护措施

4. 性能优化 ​

  • 请求超时设置
  • 内存使用限制
  • 集群模式支持

实际应用场景 ​

1. 前端开发 ​

  • 解决跨域问题
  • 统一API接口管理
  • 开发环境代理

2. 微服务架构 ​

  • API网关功能
  • 服务路由
  • 负载均衡

3. 第三方API集成 ​

  • 统一管理多个第三方API
  • 简化客户端调用
  • 添加统一的认证和日志

技术挑战与解决方案 ​

1. 跨域问题 ​

挑战：前端直接调用第三方API时遇到CORS限制 解决方案：在代理服务器中配置CORS中间件，统一处理跨域请求

2. 错误处理 ​

挑战：需要将目标服务器的错误信息友好地传递给客户端 解决方案：实现统一的错误处理中间件，格式化错误响应

3. 性能优化 ​

挑战：高并发场景下的性能问题 解决方案：使用PM2集群模式，充分利用多核CPU

4. 日志管理 ​

挑战：需要详细记录代理请求的详细信息 解决方案：实现自定义日志中间件，记录请求、响应和错误信息

未来规划 ​

短期目标 ​

  • 添加API认证机制
  • 实现请求缓存功能
  • 添加API限流功能
  • 完善监控面板

长期目标 ​

  • 支持WebSocket代理
  • 添加API版本管理
  • 实现动态配置热更新
  • 支持负载均衡算法

总结 ​

这个统一代理服务器项目是一个功能完整、易于扩展的Node.js解决方案。它不仅解决了跨域问题，还提供了统一的API管理接口，大大简化了前端开发和API集成的复杂度。

项目的核心价值在于：

  • 简化开发：统一的接口，减少重复代码
  • 提高效率：快速集成新的API服务
  • 增强安全：统一的认证和日志管理
  • 便于维护：集中的配置和监控

通过这个项目，我深入学习了Node.js、Express、PM2等技术，也积累了丰富的部署和运维经验。这个项目不仅解决了实际的技术问题，也为未来的项目开发提供了可复用的解决方案。

项目地址： http://birth.kcshen.cn:3002/proxy/huoshan/

本文档详细介绍了统一代理服务器项目的设计思路、技术实现和部署方案，希望能为有类似需求的开发者提供参考。

最近更新