当前位置：首页 > news >正文

API网关设计：统一管理前端API的最佳实践

news 2026/5/13 6:34:59

API网关设计：统一管理前端API的最佳实践

前言

大家好，我是cannonmonster01！今天我们来聊聊API网关的设计。

想象一下，你去一个大型商场购物。如果每个店铺都有自己的入口和收银台，你需要跑遍整个商场才能完成购物。而如果有一个中央服务台，你可以在那里获取所有店铺的信息，甚至直接在那里结账，那该有多方便！

API网关就像是这个中央服务台，它为前端提供了一个统一的入口，处理所有的API请求。

API网关核心概念

什么是API网关

API网关是一个服务器，作为API请求的统一入口，负责路由、认证、限流、监控等功能。

API网关的职责

职责	描述
路由	将请求转发到正确的后端服务
认证	验证用户身份和权限
限流	控制API的调用频率
监控	记录请求日志和性能指标
缓存	缓存频繁请求的响应
熔断	防止后端服务过载
协议转换	支持不同的协议（HTTP/gRPC/WebSocket）

API网关设计实战

实战1：使用Express构建简单的API网关

const express = require('express'); const http = require('http'); const app = express(); // 路由配置 const routes = { '/api/users': 'http://users-service:3001', '/api/posts': 'http://posts-service:3002', '/api/comments': 'http://comments-service:3003', }; // 认证中间件 app.use((req, res, next) => { const token = req.headers['authorization']; if (!token) { return res.status(401).json({ error: 'Unauthorized' }); } // 验证token if (!validateToken(token)) { return res.status(403).json({ error: 'Forbidden' }); } next(); }); // 限流中间件 const rateLimit = new Map(); const MAX_REQUESTS = 100; const WINDOW_MS = 60 * 1000; app.use((req, res, next) => { const ip = req.ip; const now = Date.now(); if (!rateLimit.has(ip)) { rateLimit.set(ip, { count: 1, timestamp: now }); } else { const data = rateLimit.get(ip); if (now - data.timestamp > WINDOW_MS) { rateLimit.set(ip, { count: 1, timestamp: now }); } else if (data.count >= MAX_REQUESTS) { return res.status(429).json({ error: 'Too Many Requests' }); } else { data.count++; } } next(); }); // 请求转发 app.all('*', (req, res) => { const path = req.path; let targetService = null; for (const [route, service] of Object.entries(routes)) { if (path.startsWith(route)) { targetService = service; break; } } if (!targetService) { return res.status(404).json({ error: 'Not Found' }); } const options = { hostname: new URL(targetService).hostname, port: new URL(targetService).port || 80, path: path, method: req.method, headers: req.headers, }; const proxyReq = http.request(options, (proxyRes) => { res.writeHead(proxyRes.statusCode, proxyRes.headers); proxyRes.pipe(res, { end: true }); }); req.pipe(proxyReq, { end: true }); }); app.listen(8080, () => { console.log('API Gateway running on port 8080'); });

实战2：使用Docker部署API网关

FROM node:18-alpine WORKDIR /app COPY package*.json ./ RUN npm install --production COPY . . EXPOSE 8080 CMD ["node", "gateway.js"]

version: '3.8' services: api-gateway: build: . ports: - "8080:8080" environment: - USERS_SERVICE=http://users-service:3001 - POSTS_SERVICE=http://posts-service:3002 - COMMENTS_SERVICE=http://comments-service:3003 depends_on: - users-service - posts-service - comments-service users-service: image: users-service:latest ports: - "3001:3001" posts-service: image: posts-service:latest ports: - "3002:3002" comments-service: image: comments-service:latest ports: - "3003:3003"

实战3：使用Nginx作为API网关

http { upstream users_service { server users-service:3001; } upstream posts_service { server posts-service:3002; } upstream comments_service { server comments-service:3003; } server { listen 8080; # 认证 auth_basic "API Gateway"; auth_basic_user_file /etc/nginx/.htpasswd; # 用户服务路由 location /api/users/ { proxy_pass http://users_service/; proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; } # 文章服务路由 location /api/posts/ { proxy_pass http://posts_service/; proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; } # 评论服务路由 location /api/comments/ { proxy_pass http://comments_service/; proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; } # 限流配置 limit_req_zone $binary_remote_addr zone=mylimit:10m rate=100r/m; limit_req zone=mylimit burst=20; } }

API网关最佳实践

1. 使用服务发现

const consul = require('consul')(); async function getServiceAddress(serviceName) { const result = await consul.catalog.service.nodes(serviceName); const nodes = result.body; if (nodes.length === 0) { throw new Error(`Service ${serviceName} not found`); } // 简单的负载均衡：随机选择一个节点 const node = nodes[Math.floor(Math.random() * nodes.length)]; return `${node.Address}:${node.ServicePort}`; }

2. 实现熔断机制

const circuitBreaker = require('opossum'); const breaker = new circuitBreaker(fetchService, { timeout: 5000, errorThresholdPercentage: 50, resetTimeout: 30000, }); breaker.fallback(() => { return { status: 'fallback' }; }); breaker.on('open', () => { console.log('Circuit breaker opened'); }); breaker.on('close', () => { console.log('Circuit breaker closed'); }); async function fetchService(url) { const response = await fetch(url); if (!response.ok) { throw new Error('Service unavailable'); } return response.json(); }

3. 添加日志和监控

const winston = require('winston'); const logger = winston.createLogger({ level: 'info', format: winston.format.json(), transports: [ new winston.transports.File({ filename: 'error.log', level: 'error' }), new winston.transports.File({ filename: 'combined.log' }), ], }); app.use((req, res, next) => { const startTime = Date.now(); res.on('finish', () => { const duration = Date.now() - startTime; logger.info({ method: req.method, path: req.path, statusCode: res.statusCode, duration: `${duration}ms`, ip: req.ip, }); }); next(); });

4. 使用缓存优化性能

const NodeCache = require('node-cache'); const cache = new NodeCache({ stdTTL: 60 }); app.get('/api/users/:id', async (req, res) => { const userId = req.params.id; const cachedUser = cache.get(userId); if (cachedUser) { return res.json(cachedUser); } const user = await fetchFromUserService(userId); cache.set(userId, user); res.json(user); });

API网关与直接调用对比

特性	API网关	直接调用
统一入口	是	否
认证集中	是	需要每个服务单独处理
限流集中	是	需要每个服务单独处理
监控集中	是	需要每个服务单独处理
复杂度	较高	较低
性能开销	轻微	无