Express HTTP Proxy 使用教程

1. 项目介绍

express-http-proxy 是一个用于 Express 和 Connect 的代理中间件。它允许你将请求代理到另一个主机，并将响应返回给原始调用者。这个中间件非常适合用于反向代理、API 网关等场景。

2. 项目快速启动

安装

首先，你需要通过 npm 安装 express-http-proxy：

npm install express-http-proxy --save

基本使用

以下是一个简单的示例，将所有以 /proxy 开头的请求代理到 www.google.com：

const proxy = require('express-http-proxy');
const express = require('express');
const app = express();

app.use('/proxy', proxy('www.google.com'));

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

高级配置

你可以通过配置选项来定制代理行为。例如，修改请求路径：

app.use('/proxy', proxy('localhost:12345', {
  proxyReqPathResolver: function (req) {
    const parts = req.url.split('?');
    const queryString = parts[1];
    const updatedPath = parts[0].replace(/test/, 'tent');
    return updatedPath + (queryString ? '?' + queryString : '');
  }
}));

3. 应用案例和最佳实践

反向代理

在微服务架构中，反向代理是一个常见的模式。你可以使用 express-http-proxy 将请求代理到不同的后端服务。例如：

app.use('/service1', proxy('http://service1.example.com'));
app.use('/service2', proxy('http://service2.example.com'));

API 网关

API 网关是另一个常见的应用场景。你可以使用 express-http-proxy 来统一管理多个 API 服务：

app.use('/api', proxy('http://api.example.com'));

请求过滤

你可以通过 filter 选项来限制哪些请求会被代理。例如，只代理 GET 请求：

app.use('/proxy', proxy('www.google.com', {
  filter: function(req, res) {
    return req.method === 'GET';
  }
}));

4. 典型生态项目

Express

express-http-proxy 是基于 Express 框架的中间件，因此它与 Express 生态系统紧密集成。你可以将它与其他 Express 中间件（如 body-parser、cors 等）一起使用。

Connect

express-http-proxy 也兼容 Connect 框架，因此你可以在 Connect 应用中使用它。

Node.js

作为一个 Node.js 模块，express-http-proxy 可以与任何基于 Node.js 的 Web 应用框架一起使用。

通过以上教程，你应该能够快速上手并使用 express-http-proxy 来构建你的代理服务。