一、引言
在微服务架构中,API网关是流量的统一入口,承担着路由转发、流量管控、安全防护等核心职责。Spring Cloud Gateway作为Spring官方推荐的第二代网关,基于Spring 5.0、Spring Boot 2.0和Project Reactor构建,提供了高性能的响应式编程模型和丰富的扩展能力。相比 Zuul 1.x,它采用响应式编程模型,能够更高效地处理高并发场景。
本文将从基础入手,深入讲解路由、断言、过滤器、负载均衡及与Nacos的集成,帮助读者快速掌握Gateway的核心技术。
二、核心概念与基础架构
Spring Cloud Gateway 是 Spring Cloud 生态中基于 WebFlux 构建的高性能响应式 API 网关,定位为替代传统的 Zuul 网关。其核心价值在于提供统一的路由管理、流量控制、安全防护等功能,成为微服务架构的 “统一入口”。
2.1 核心组件
Spring Cloud Gateway的核心由三大组件构成:
- 路由(Route):路由是网关的基本单元,包含ID、目标URI、断言和过滤器。
- 断言(Predicate):用于匹配请求条件(如路径、参数、时间等),决定请求是否匹配当前路由。
- 过滤器(Filter):分为全局过滤器(GlobalFilter)和局部过滤器(GatewayFilter),用于请求/响应的预处理和后处理。
2.2 核心功能
- 路由转发:根据请求规则将请求分发到不同微服务
- 负载均衡:集成 Spring Cloud LoadBalancer 实现动态负载均衡
- 过滤链:通过 Filter 链实现请求预处理和响应后处理
- 动态配置:支持配置中心动态更新路由规则
- 安全防护:集成 Spring Security 实现认证授权
2.3 核心优势
- 高性能:基于WebFlux的非阻塞IO模型,吞吐量比传统网关提升30%以上。
- 动态路由:支持从Nacos、Redis等动态加载路由规则,无需重启服务。
- 丰富的生态:内置30+开箱即用的过滤器,支持插件化扩展。
三、路由与断言:网关的核心逻辑
3.1 路由配置基础
路由配置通常在application.yml
中定义,示例如下:
spring:cloud:gateway:routes:- id: user-service-routeuri: lb://user-service # 负载均衡服务名predicates:- Path=/api/user/** # 路径匹配filters:- StripPrefix=1 # 移除路径前缀
3.2 断言(Predicate)详解
断言是路由匹配的核心条件,Spring Cloud Gateway提供了多种内置断言工厂。
3.2.1 路径匹配断言(Path)
- 语法:
Path=/path/**
- 示例:匹配以
/api/user/
开头的所有路径
predicates:- Path=/api/user/**
3.2.2 参数匹配断言(Query)
- 语法:
Query=param[,regex]
- 示例:匹配包含
token
参数且值以Bearer_
开头的请求
predicates:- Query=token,Bearer_.*
3.2.3 IP段匹配断言(RemoteAddr)
- 语法:
RemoteAddr=192.168.1.0/24
- 示例:仅允许来自
192.168.1.0/24
网段的请求
predicates:- RemoteAddr=192.168.1.0/24
3.2.4 时间范围断言(Between)
- 语法:
Between=startTime,endTime
- 示例:仅在2023-01-01至2023-12-31之间的请求生效
predicates:- Between=2023-01-01T00:00:00+08:00,2023-12-31T23:59:59+08:00
3.2.5 组合断言(逻辑运算符)
- 语法:使用
()
组合多个断言 - 示例:匹配路径为
/api/user
且请求方法为POST的请求
predicates:- (Path=/api/user && Method=POST)
3.2.6 流量分配断言(Weight)
- 语法:
Weight=group,weight
- 示例:将80%的流量转发到
weighthigh.org
,20%转发到weightlow.org
routes:- id: weight_highuri: https://weighthigh.orgpredicates:- Weight=group1,8- id: weight_lowuri: https://weightlow.orgpredicates:- Weight=group1,2
四、过滤器:请求与响应的精细化控制
4.1 过滤器分类
- 全局过滤器(GlobalFilter):对所有路由生效,需实现
GlobalFilter
接口。 - 局部过滤器(GatewayFilter):仅对当前路由生效,通过配置文件定义。
- 默认过滤器(default-filters):对所有路由生效,配置在
spring.cloud.gateway.default-filters
中。
4.2 内置过滤器示例
4.2.1 添加请求头(AddRequestHeader)
filters:- AddRequestHeader=X-Request-Id,${random.uuid}
4.2.2 移除路径前缀(StripPrefix)
filters:- StripPrefix=1 # 移除第一个路径段
4.2.3 限流过滤器(RequestRateLimiter)
filters:- name: RequestRateLimiterargs:key-resolver: "#{@remoteAddrKeyResolver}" # 基于IP限流redis-rate-limiter.replenishRate: 10 # 每秒生成10个令牌redis-rate-limiter.burstCapacity: 20 # 令牌桶容量
4.3 自定义全局过滤器
@Component
@Order(-1) // 优先级:数值越小,执行越早
public class AuthFilter implements GlobalFilter {@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {String token = exchange.getRequest().getHeaders().getFirst("Authorization");if (token == null || !token.startsWith("Bearer ")) {exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);return exchange.getResponse().setComplete();}return chain.filter(exchange); // 放行请求}
}
五、负载均衡:与Nacos的深度集成
5.1 服务注册与发现
- 引入依赖:
<dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
- 配置Nacos:
spring:cloud:nacos:discovery:server-addr: localhost:8848 # Nacos服务地址gateway:discovery:locator:enabled: true # 启用服务发现路由lower-case-service-id: true # 服务名小写
- 路由配置:
routes:- id: user-serviceuri: lb://user-service # 负载均衡服务名predicates:- Path=/api/user/**
5.2 负载均衡策略配置
默认使用轮询策略,可通过@LoadBalancerClient
指定其他策略:
@Configuration
public class LoadBalancerConfig {@Beanpublic ReactorLoadBalancer<ServiceInstance> randomLoadBalancer(Environment environment,ServiceInstanceListSupplier supplier) {return new RandomLoadBalancer(environment, supplier); // 随机策略}
}@LoadBalancerClient(name = "user-service", configuration = LoadBalancerConfig.class)
public interface UserClient {// Feign客户端接口
}
六、与Nacos的动态路由集成
6.1 动态路由配置
- 在Nacos控制台创建配置文件:
# Data ID: gateway-routes.yaml
spring:cloud:gateway:routes:- id: product-serviceuri: lb://product-servicepredicates:- Path=/api/product/**filters:- StripPrefix=1
- 在网关服务中加载配置:
spring:cloud:config:import: "optional:nacos:gateway-routes.yaml"
- 动态刷新路由:
curl -X POST http://localhost:8080/actuator/gateway/refresh
6.2 动态服务发现
网关会自动从Nacos获取服务实例列表,实现动态负载均衡:
uri: lb://product-service # 自动发现服务实例