springcommunity/spring-petclinic-api-gateway

Spring Petclinic Microservices API Gateway 镜像文档

镜像概述

本镜像为Spring Petclinic微服务架构中的核心组件——API网关，基于Spring Cloud Gateway实现。作为微服务集群的统一入口，它负责请求路由、服务发现、负载均衡、请求过滤及API文档聚合等功能，简化客户端与后端微服务的交互流程。

核心功能与特性

• 请求路由转发：根据预设规则将客户端请求路由至对应微服务实例
• 服务发现集成：支持与Eureka、Consul等服务注册中心联动，动态获取服务实例信息
• 负载均衡：内置轮询、随机等负载均衡策略，优化服务请求分发
• 请求过滤机制：支持自定义过滤器实现认证授权、请求限流、日志记录等功能
• API文档聚合：可集成Swagger/OpenAPI，提供统一的API文档访问入口
• 响应处理：支持请求/响应转换、错误统一处理及跨域资源共享(CORS)配置

使用场景与适用范围

• 开发环境：微服务接口调试与集成测试
• 测试环境：统一管理微服务接口，简化测试用例编写
• 生产环境：实现流量控制、安全防护及服务降级策略
• 教学场景：演示微服务架构中API网关的设计与实现

使用方法与配置说明

基本部署（Docker Run）

bash
docker run -d \
  --name petclinic-api-gateway \
  -p 8080:8080 \
  -e SPRING_PROFILES_ACTIVE=prod \
  -e EUREKA_CLIENT_SERVICEURL_DEFAULTZONE=http://eureka-server:8761/eureka/ \
  docker.xuanyuan.run/springcommunity/spring-petclinic-api-gateway:latest

Docker Compose 配置示例

yaml
version: '3.8'
services:
  api-gateway:
    image: docker.xuanyuan.run/springcommunity/spring-petclinic-api-gateway:latest
    container_name: petclinic-api-gateway
    ports:
      - "8080:8080"
    environment:
      - SPRING_PROFILES_ACTIVE=prod
      - EUREKA_CLIENT_SERVICEURL_DEFAULTZONE=http://eureka-server:8761/eureka/
      - SPRING_CLOUD_GATEWAY_ROUTES[0].id=customers-service
      - SPRING_CLOUD_GATEWAY_ROUTES[0].uri=lb://customers-service
      - SPRING_CLOUD_GATEWAY_ROUTES[0].predicates[0]=Path=/api/customers/**filters[0]=StripPrefix=1
    depends_on:
      - eureka-server

核心配置参数

路由规则配置示例

通过环境变量配置路由规则（JSON格式）：

bash
-e SPRING_CLOUD_GATEWAY_ROUTES='[{"id":"vets-service","uri":"lb://vets-service","predicates":[{"name":"Path","args":{"pattern":"/api/vets/**"}}],"filters":[{"name":"StripPrefix","args":{"parts":"1"}}]}]'

注意事项

• 需确保服务注册中心（如Eureka）已提前启动并可访问
• 生产环境建议通过配置中心（如Spring Cloud Config）管理路由规则
• 高并发场景下可调整JVM参数（通过JAVA_OPTS环境变量）优化性能

参考链接

• 官方项目地址：https://github.com/spring-petclinic/spring-petclinic-microservices
• Spring Cloud Gateway文档：https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/