xmonline/xm-gate

XM^online 2 Gateway 镜像文档

1. 镜像概述

XM^online 2 Gateway 是 XM^online 2 微服务架构中的核心网关组件，作为系统统一入口，负责接收客户端请求、动态路由至后端微服务，并提供网关层的流量控制、安全防护及监控能力，简化客户端与微服务间的交互流程。

2. 核心功能与特性

• 动态路由管理：支持基于配置文件或服务发现的动态路由规则，灵活映射客户端请求至目标微服务
• 负载均衡：内置多种负载均衡策略（如轮询、权重、IP哈希），优化后端服务资源利用
• 认证与授权：集成统一认证机制，支持JWT、OAuth2等协议，验证请求合法性并控制访问权限
• 流量控制：提供API限流、熔断降级功能，保护后端服务免受流量峰值冲击
• 监控与可观测性：输出详细请求日志、指标数据（响应时间、错误率等），支持与Prometheus、Grafana等监控系统集成
• SSL终止：支持HTTPS协议，集中处理SSL握手与证书管理，减轻后端服务负担

3. 使用场景与适用范围

• 微服务架构入口：作为客户端（Web/移动端）访问后端微服务的唯一入口，简化网络拓扑
• API统一管理：集中处理API版本控制、协议转换（如HTTP/HTTPS）及请求/响应格式化
• 多环境部署：适用于开发、测试、生产等不同环境，通过配置隔离实现环境差异化
• 流量安全防护：在网关层拦截非法请求，降低后端服务直接暴露的安全风险

4. 使用方法与配置说明

4.1 基本运行示例

通过docker run命令快速启动网关服务：

bash
docker run -d \
  --name xm-online2-gateway \
  -p 8080:8080 \
  -e SPRING_PROFILES_ACTIVE=prod \
  -e SERVER_PORT=8080 \
  -v /path/to/local/config:/app/config \
  docker.xuanyuan.run/xm-online2/gateway:latest

4.2 环境变量配置

4.3 配置文件挂载

若需自定义路由规则、服务发现配置等，可通过挂载外部配置文件实现：

1. 本地创建配置文件 application.yml（示例）：

yaml
spring:
  cloud:
    gateway:
      routes:
        - id: user-service
          uri: lb://user-service
          predicates:
            - Path=/api/users/**filters:
            - StripPrefix=1
            - name: RequestRateLimiter
              args:
                redis-rate-limiter.replenishRate: 10
                redis-rate-limiter.burstCapacity: 20

2. 启动时挂载配置文件：

bash
docker run -d \
  --name xm-online2-gateway \
  -p 8080:8080 \
  -v /local/path/application.yml:/app/config/application.yml \
  docker.xuanyuan.run/xm-online2/gateway:latest

4.4 Docker Compose 示例

yaml
version: '3.8'
services:
  gateway:
    image: docker.xuanyuan.run/xm-online2/gateway:latest
    container_name: xm-online2-gateway
    restart: always
    ports:
      - "8080:8080"
    environment:
      - SPRING_PROFILES_ACTIVE=prod
      - SERVER_PORT=8080
      - AUTH_ENABLED=true
    volumes:
      - ./gateway-config:/app/config
    networks:
      - xm-online2-network

networks:
  xm-online2-network:
    driver: bridge

5. 注意事项

• 生产环境建议通过环境变量或外部配置文件管理敏感信息（如认证密钥），避免硬编码
• 网关服务需与后端微服务部署在同一网络环境，确保服务发现与通信正常
• 高并发场景下建议调整JVM参数（如通过JAVA_OPTS环境变量设置-Xms512m -Xmx1g）以优化性能
• 定期监控网关指标（如请求成功率、平均响应时间），及时调整路由策略与资源配置