Spring Cloud Gateway作为一款强大的API网关,提供了丰富的配置选项来满足不同的应用场景。以下是一些基本配置的概览:
1. 路由配置 (spring.cloud.gateway.routes)
路由是网关的基础,定义了HTTP请求如何从网关转发到后端服务。基本结构包含:
- id:路由的唯一标识。
- uri:请求转发的目标地址,可以是实际URL或服务名称(配合服务发现使用)。
- predicates:谓词集合,用于决定请求是否应该由该路由处理。常见的谓词有Path、Host、Method等。
- filters:过滤器集合,可以在请求转发前后对请求或响应进行修改。
示例配置:
spring: cloud: gateway: routes: - id: users-route uri: lb://user-service # 使用服务发现 predicates: - Path=/users/** filters: - AddRequestHeader=X-Request-Frontend-Id, Gateway
2. 负载均衡配置
- spring.cloud.loadbalancer.ribbon.enabled=false:禁用Ribbon,使用Spring Cloud LoadBalancer。
- spring.cloud.gateway.discovery.locator.enabled=true:启用服务发现定位器,自动为每个服务创建路由。
- spring.cloud.gateway.discovery.locator.lower-case-service-id=true:将服务ID转换为小写。
3. 全局过滤器配置
可以在全局级别定义过滤器,应用于所有路由:
spring: cloud: gateway: default-filters: - AddResponseHeader=X-Response-Default, Default-Value
4. 跨域配置 (spring.cloud.gateway.globalcors.cors-configurations)
定义跨域资源共享(CORS)策略:
spring: cloud: gateway: globalcors: cors-configurations: '[/**]': allowedOrigins: "*" allowedMethods: "*"
5. 认证与鉴权
虽然不是直接的配置项,但可以通过配置过滤器(如JWT、OAuth2等)实现认证和授权逻辑。
6. 日志与跟踪
配置日志级别和追踪信息,例如使用logging.level.org.springframework.cloud.gateway=DEBUG来查看更详细的调试信息。
7. 性能与限制
可以配置请求速率限制、连接池大小等来优化性能和保护后端服务:
spring: cloud: gateway: request-predicates: - name: RequestRateLimiter args: redis-rate-limiter.replenishRate: 10 redis-rate-limiter.burstCapacity: 20
8. SSL/TLS配置
配置SSL证书以支持HTTPS通信,这通常涉及到服务器的SSL/TLS设置而非直接在网关配置中设置,但可以通过环境变量或应用属性间接影响。
9. 服务发现与注册中心配置
当与Eureka、Consul等服务注册中心集成时,需要相应的配置来发现服务:
spring: cloud: discovery: enabled: true service-id: ${spring.application.name}