Gateway

什么是服务网关

• 客户端会多次请求不同的微服务，增加了客户端的复杂性。

• 存在跨域请求，在一定场景下处理相对复杂。

• 认证复杂，每个服务都需要独立认证。

• 难以重构，随着项目的迭代，可能需要重新划分微服务。例如，可能将多个服务合并成一个或者将一个服务拆分成多个。如果客户端直接与微服务通信，那么重构将会很难实施。

• 某些微服务可能使用了防火墙 / 浏览器不友好的协议，直接访问会有一定的困难。

网关解决了什么问题

• 聚合接口使得服务对调用者透明，客户端与后端的耦合度降低

• 聚合后台服务，节省流量，提高性能，提升用户体验

• 提供安全、流控、过滤、缓存、计费、监控等 API 管理功能

• 性能：API 高可用，负载均衡，容错机制。

• 安全：权限身份认证、脱敏，流量清洗分发，后端签名（保证全链路可信调用），黑名单（非法调用的限制）。

• 日志：日志记录，一旦涉及分布式，全链路跟踪必不可少。

• 缓存：数据缓存。

• 监控：记录请求响应数据，API 耗时分析，性能监控。

• 限流：流量控制，错峰流控，可以定义多种限流规则。

• 灰度：线上灰度部署，可以减小风险。

• 路由：动态路由规则。

• 数据平面主要功能是接入用户的HTTP请求和微服务被拆分后的聚合。使用微服务网关统一对外暴露后端服务的API和契约，路由和过滤功能正是网关的核心能力模块。另外，微服务网关可以实现拦截机制和专注跨横切面的功能，包括协议转换、安全认证、熔断限流、灰度发布、日志管理、流量监控等。

• 控制平面主要功能是对后端服务做统一的管控和配置管理。例如，可以控制网关的弹性伸缩；可以统一下发配置；可以对网关服务添加标签；

Spring Cloud Gateway

Spring Cloud Gateway 是基于 Spring 生态系统之上构建的 API 网关，包括：Spring 5，Spring Boot 2 和 Project Reactor。Spring Cloud Gateway 旨在提供一种简单而有效的方法来路由到 API，并为它们提供跨领域的关注点，例如：安全性，监视/指标，限流等。

由于 Spring 5.0 支持 Netty，Http2，而 Spring Boot 2.0 支持 Spring 5.0，因此 Spring Cloud Gateway 天然支持 Netty 和 Http2。

核心概念

• Route: The basic building block of the gateway. It is defined by an ID, a destination URI, a collection of predicates, and a collection of filters. A route is matched if the aggregate predicate is true.
• 路由是构建网关的基本模块，它由ID，目标URI，一系列的断言和过滤器组成，如果断言为true则匹配该路由

• Predicate: This is a Java 8 Function Predicate. The input type is a Spring Framework ServerWebExchange. This lets you match on anything from the HTTP request, such as headers or parameters.
• 参考的是java8的java.util.function.Predicate开发人员可以匹配HTTP请求中的所有内容（例如请求头或请求参数），如果请求与断言相匹配则进行路由

• Filter: These are instances of GatewayFilter that have been constructed with a specific factory. Here, you can modify requests and responses before or after sending the downstream request.
• 指的是Spring框架中GatewayFilter的实例，使用过滤器，可以在请求被路由前或者之后对请求进行修改。

Predicate 断言

SpringCloud Gateway 将路由匹配作为Spring WebFlux HandlerMapping基础架构的一部分。

内置谓词断言

• After Route Predicate Factory 匹配在指定日期时间之后发生的请求
• 参数：datetime
• 注意时间格式带时区 ZonedDateTime
• spring: cloud: gateway: routes: - id: after_route_test uri: <https://www.hehouhui.cn> predicates: - After=2022-07-10T17:42:00.789-07:00[Asia/Shanghai]

• Before Route Predicate Factory 匹配在指定日期时间之前发生的请求

• Between Route Predicate Factory 匹配在指定范围日期时间发生的请求
• 参数：datetime1 开始
• datetime2 结束
• 注意时间格式带时区 ZonedDateTime
• spring: cloud: gateway: routes: - id: between_route_test uri: <https://www.hehouhui.cn> predicates: - Between=2022-07-10T17:42:30.789-07:00[Asia/Shanghai],2022-07-10T17:42:59.789-07:00[Asia/Shanghai]

• Cookie Route Predicate Factory 匹配在指定包含指定cookie 值的请求

• regexp 匹配值的正则

• spring: cloud: gateway: routes: - id: cookie_route_test uri: <https://www.hehouhui.cn> predicates: - Cookie=token,allow_account

• Header Route Predicate Factory 匹配在指定包含指定请求头的请求

• Host Route Predicate Factory 请求主机地址匹配

• Method Route Predicate Factory 请求方法的匹配

• Path Route Predicate Factory 请求路由规则匹配

• Query Route Predicate Factory 请求参数 url ？后的参数

• RemoteAddr Route Predicate Factory 客户端请求IP匹配

• XForwardedRemoteAddressResolver::trustAll返回RemoteAddressResolver始终采用在X-Forwarded-For标头中找到的第一个 IP 地址的 a。这种方法容易受到欺骗，因为恶意客户端可以为 设置初始值，X-Forwarded-For解析器会接受该值。

• XForwardedRemoteAddressResolver::maxTrustedIndex采用与 Spring Cloud Gateway 前运行的受信任基础架构数量相关的索引。例如，如果 Spring Cloud Gateway 只能通过 HAProxy 访问，则应使用值 1。如果在访问 Spring Cloud Gateway 之前需要两跳可信基础架构，则应使用值 2。

• Weight Route Predicate Factory 权重路由匹配
参数： group 自定义分组名称

• XForwarded Remote Addr Route Predicate Factory 根据 X-Forwarded-For请求头匹配
参数：sources 注意此处为cidr格式

Filter过滤器

GlobaFilter 全局过滤器

GlobaFilter 全局过滤器，不需要在配置文件中配置，系统初始化时加载，并作用在每个路由上。 SpringCloud Gateway 核心的功能也是通过内置的全局过滤器来完成

AbstractGatewayFilterFactory 局部过滤器工厂

GatewayFilter局部过滤器，是针对单个路由的过滤器。 在SpringCloud Gateway组件中提供了大量内置的局部过滤器，对请求和响应坐过滤操作。

遵循约定大于配置的思想，只需要在配置文件配置局部过滤器名称，并为其制定对应的值。就可以让其生效。

RouteLocator

ConfigurationService