好的，各位朋友们，欢迎来到今天的“Spring Cloud Gateway：API网关与路由”专场脱口秀！我是你们的老朋友，码农界的段子手——“代码诗人”，今天就和大家一起聊聊这个既重要又有点神秘的API网关，以及它背后的路由机制。
别担心，今天咱们不讲那些枯燥的定义和概念，咱们用最接地气的方式，把这个看似高大上的技术，扒个精光，让它变得像隔壁老王一样亲切。😉
开场白：API网关，互联网世界的“门卫大爷”
想象一下，你家小区门口的门卫大爷，他每天的工作是什么？
- 身份验证： 确认你是小区居民，或者是有预约的访客。
- 流量控制： 高峰期的时候，控制一下人流，避免拥堵。
- 安全防护： 拦住那些形迹可疑的人，保障小区的安全。
- 路由指引： 告诉你应该往哪个方向走，才能找到你要去的那栋楼。
API网关，其实就是互联网世界的“门卫大爷”。它站在所有微服务的前面，负责处理所有的外部请求，进行身份验证、流量控制、安全防护、路由转发等等。
如果没有API网关，你的微服务就像一个个光着屁股的小孩，直接暴露在互联网上，随便一个黑客都能进来搞破坏。有了API网关，你的微服务就穿上了铠甲，安全系数瞬间提升N个档次！🛡️
第一幕：Spring Cloud Gateway，网关界的“变形金刚”
市面上有很多API网关，比如Nginx、Kong、Zuul等等。但是，今天咱们的主角是Spring Cloud Gateway，它是Spring Cloud家族的一员，基于Spring WebFlux构建，性能强劲，功能丰富，而且和Spring Cloud生态系统无缝集成。
你可以把Spring Cloud Gateway想象成一个“变形金刚”，它可以根据你的需求，灵活地进行配置和扩展，变成你想要的任何样子。🚀
Spring Cloud Gateway的核心概念：
| 概念 | 解释 | 举例 |
|---|---|---|
| Route | 路由，定义了请求应该如何转发到下游服务。 | 将所有以/user开头的请求，转发到user-service。 |
| Predicate | 断言，用于匹配请求的条件。只有满足条件的请求，才会被路由到指定的下游服务。 | 只有请求头中包含X-Request-Id的请求，才会被路由到user-service。 |
| Filter | 过滤器，用于在请求被路由到下游服务之前或之后，对请求进行修改或处理。 | 在请求头中添加X-Source: gateway，或者记录请求的耗时。 |
| Global Filter | 全局过滤器，对所有路由都生效的过滤器。 | 统一进行身份验证，或者统一记录请求日志。 |
第二幕：路由配置，指哪打哪的“导航地图”
路由配置是API网关的核心，它决定了请求应该被转发到哪个下游服务。Spring Cloud Gateway提供了多种方式进行路由配置，包括：
- Java配置： 使用Java代码来定义路由。
- YAML配置： 使用YAML文件来定义路由。
- DiscoveryClient： 从服务注册中心（比如Eureka、Nacos）动态获取路由信息。
1. Java配置：代码界的“艺术家”
Java配置是最灵活的方式，你可以用代码来表达你的路由逻辑，就像艺术家用画笔来创作一样。🎨
@Configuration
public class GatewayConfig {
@Bean
public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {
return builder.routes()
.route("path_route", r -> r.path("/get")
.uri("http://httpbin.org")) // 将/get请求转发到http://httpbin.org
.route("host_route", r -> r.host("*.example.com")
.uri("http://httpbin.org")) // 将所有host为*.example.com的请求转发到http://httpbin.org
.route("rewrite_route", r -> r.path("/foo/**")
.filters(f -> f.rewritePath("/foo/(?<segment>.*)", "/${segment}")) // 重写路径
.uri("http://httpbin.org"))
.route("hystrix_route", r -> r.path("/hystrix/**")
.filters(f -> f.hystrix(config -> config.setName("myHystrixCommand"))) // 使用Hystrix断路器
.uri("http://httpbin.org"))
.build();
}
}这段代码定义了几个路由：
- 将
/get请求转发到http://httpbin.org。 - 将所有host为
*.example.com的请求转发到http://httpbin.org。 - 将
/foo/**请求转发到http://httpbin.org，并且重写路径。 - 将
/hystrix/**请求转发到http://httpbin.org，并且使用Hystrix断路器。
2. YAML配置：配置界的“极简主义者”
YAML配置更简洁，更易于阅读和维护，适合那些喜欢“极简主义”的朋友。🧘
spring:
cloud:
gateway:
routes:
- id: user_route
uri: lb://user-service # 使用服务发现，转发到user-service
predicates:
- Path=/user/**
filters:
- AddRequestHeader=X-Source, gateway
- id: product_route
uri: lb://product-service
predicates:
- Path=/product/**
filters:
- AddRequestHeader=X-Source, gateway这段YAML配置定义了两个路由：
- 将所有以
/user开头的请求，转发到user-service，并且添加一个请求头X-Source: gateway。 - 将所有以
/product开头的请求，转发到product-service，并且添加一个请求头X-Source: gateway。
注意，这里使用了lb://user-service和lb://product-service，表示使用服务发现，从服务注册中心获取user-service和product-service的地址。
3. DiscoveryClient：动态路由的“魔术师”
DiscoveryClient可以从服务注册中心动态获取路由信息，这对于微服务架构来说非常重要。当你的微服务实例发生变化时，API网关可以自动更新路由信息，无需手动修改配置。🎩
要使用DiscoveryClient，你需要先集成服务注册中心，比如Eureka、Nacos等等。然后在你的路由配置中，使用lb://service-id来指定下游服务。
第三幕：断言，请求的“过滤器”
断言用于匹配请求的条件，只有满足条件的请求，才会被路由到指定的下游服务。Spring Cloud Gateway提供了多种断言，包括：
| 断言类型 | 解释 | 举例 |
|---|---|---|
Path |
匹配请求路径。 | Path=/user/**：匹配所有以/user开头的请求。 |
Method |
匹配请求方法。 | Method=GET,POST：匹配GET或POST请求。 |
Header |
匹配请求头。 | Header=X-Request-Id：匹配包含X-Request-Id请求头的请求。Header=X-Request-Id, d+：匹配包含X-Request-Id请求头，且值为数字的请求。 |
Query |
匹配请求参数。 | Query=name：匹配包含name参数的请求。Query=name, w+：匹配包含name参数，且值为字母数字的请求。 |
Cookie |
匹配Cookie。 | Cookie=chocolate, ch.p：匹配名为chocolate的Cookie，且值为ch.p的请求。 |
Host |
匹配Host。 | Host=*.example.com：匹配所有host为*.example.com的请求。 |
RemoteAddr |
匹配客户端IP地址。 | RemoteAddr=192.168.1.1/24：匹配所有来自192.168.1.1/24网段的请求。 |
Weight |
权重，用于实现灰度发布。 | Weight=group1, 80：将80%的流量路由到group1，剩余的20%路由到其他组。 |
BeforeRoute |
在指定时间之前的请求。 | BeforeRoute=2023-12-31T23:59:59+08:00：匹配在2023年12月31日23:59:59之前的所有请求。 |
AfterRoute |
在指定时间之后的请求。 | AfterRoute=2024-01-01T00:00:00+08:00：匹配在2024年1月1日00:00:00之后的所有请求。 |
BetweenRoute |
在指定时间范围内的请求。 | BetweenRoute=2023-12-31T23:59:59+08:00, 2024-01-01T00:00:00+08:00：匹配在2023年12月31日23:59:59到2024年1月1日00:00:00之间的所有请求。 |
XForwardedFor |
匹配 X-Forwarded-For 头信息中的 IP 地址。 |
XForwardedFor=192.168.1.d{1,3}：匹配 X-Forwarded-For 头信息中包含 192.168.1.x 的请求。 |
你可以组合使用多个断言，来实现更复杂的匹配逻辑。
第四幕：过滤器，请求的“美容师”
过滤器用于在请求被路由到下游服务之前或之后，对请求进行修改或处理。Spring Cloud Gateway提供了多种过滤器，包括：
| 过滤器类型 | 解释 | 举例 |
|---|---|---|
AddRequestHeader |
添加请求头。 | AddRequestHeader=X-Source, gateway：添加一个名为X-Source，值为gateway的请求头。 |
AddRequestParameter |
添加请求参数。 | AddRequestParameter=source, gateway：添加一个名为source，值为gateway的请求参数。 |
AddResponseHeader |
添加响应头。 | AddResponseHeader=X-Powered-By, gateway：添加一个名为X-Powered-By，值为gateway的响应头。 |
RewritePath |
重写请求路径。 | RewritePath=/foo/(?<segment>.*), /${segment}：将/foo/bar重写为/bar。 |
PrefixPath |
添加请求路径前缀。 | PrefixPath=/api：将所有请求路径添加/api前缀。 |
StripPrefix |
移除请求路径前缀。 | StripPrefix=1：移除请求路径的第一个/及其后面的内容。 |
RequestRateLimiter |
请求限流。 | 基于令牌桶算法，限制每个用户每秒只能访问10次。 |
Hystrix |
使用Hystrix断路器。 | 当下游服务出现故障时，快速失败，避免雪崩效应。 |
Retry |
重试。 | 当下游服务出现故障时，自动重试。 |
CircuitBreaker |
使用 Resilience4j 断路器. 相较于Hystrix，Resilience4j提供了更丰富的断路器配置和监控功能。 | 设置断路器的阈值、滑动窗口大小等参数，以更精细地控制断路器的行为。 |
ModifyRequestBody |
修改请求体. 允许你根据需要修改请求的内容，例如将 JSON 格式的请求体转换为 XML 格式。 | 将请求体中的某个字段的值进行加密处理。 |
ModifyResponseBody |
修改响应体. 可以修改从下游服务返回的响应内容，例如添加一些额外的字段或修改现有的字段。 | 统一修改响应体中的状态码，或者添加一些通用的信息。 |
SaveSession |
保存Session. 用于在 Gateway 层保存 Session 信息，以便在下游服务中可以使用。 | 将用户的登录信息保存在 Session 中，以便在后续的请求中进行身份验证。 |
RemoveRequestHeader |
移除请求头。 | RemoveRequestHeader=Cookie：移除所有Cookie请求头。 |
RemoveResponseHeader |
移除响应头。 | RemoveResponseHeader=Server：移除所有Server响应头。 |
你可以自定义过滤器，来实现更复杂的业务逻辑。
第五幕：全局过滤器，请求的“统一标准”
全局过滤器对所有路由都生效，通常用于处理一些通用的逻辑，比如身份验证、日志记录等等。
你可以通过实现GlobalFilter接口来创建全局过滤器。
@Component
public class GlobalAuthenticationFilter implements GlobalFilter, Ordered {
@Override
public 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);
}
@Override
public int getOrder() {
// 设置过滤器的优先级，值越小优先级越高
return 0;
}
}这个全局过滤器会检查每个请求的Authorization头，如果token不存在或者不是以Bearer开头，就返回401 Unauthorized。
第六幕：监控与告警，网关的“千里眼”和“顺风耳”
API网关是系统的入口，监控和告警非常重要。你可以使用Spring Boot Actuator来监控API网关的运行状态，比如：
- Metrics： 收集API网关的各项指标，比如请求量、响应时间、错误率等等。
- Health： 检查API网关的健康状态，比如是否可以连接到服务注册中心、数据库等等。
- Loggers： 动态调整日志级别。
你还可以集成Prometheus和Grafana，来实现更强大的监控和告警功能。
结束语：API网关，微服务架构的“守护神”
API网关是微服务架构中不可或缺的一部分，它可以帮助你解决很多问题，比如：
- 统一入口： 将所有外部请求统一到一个入口，简化客户端的开发。
- 安全防护： 保护你的微服务，防止恶意攻击。
- 流量控制： 控制流量，避免系统过载。
- 灰度发布： 实现平滑升级，降低风险。
- 监控与告警： 及时发现问题，保障系统稳定。
希望通过今天的讲解，你对Spring Cloud Gateway有了更深入的了解。记住，API网关就像微服务架构的“守护神”，它默默地守护着你的系统，保障你的业务稳定运行。😊
好了，今天的脱口秀就到这里，感谢大家的收听！我们下期再见！👋