Spring Cloud Gateway2之断言Predicate详解

1. 前言

随着微服务架构的普及，API网关已经成为了微服务系统中不可或缺的一部分。Spring Cloud Gateway作为Spring Cloud官方推出的二代网关框架，其路由配置简单，支持热部署，支持断路器，限流等功能，因此受到了广大开发者的热烈欢迎。

Spring Cloud Gateway是Spring Cloud官方推出的第二代微服务网关框架，它旨在提供一种简单有效的方式来对API进行路由，或者在边缘服务应用中添加防护措施。它内置了与Spring集成的高级功能，例如：服务发现集成、负载均衡、断路器集成、HttpClient、WebSockets、重试、限流等等。

断言在Spring Cloud Gateway中扮演着重要角色。断言是Gateway在进行路由时，根据具体的请求信息如请求路径、请求方法、请求参数等进行匹配的规则。当一个请求的信息符合断言设置的条件时，Gateway就会将该请求路由到对应的服务上。

例如，我们可能想要将所有GET方法的请求路由到一个服务，将所有POST方法的请求路由到另一个服务。对于这种场景，我们就可以使用Method断言。再如，我们想要将所有路径为"/api/user"的请求路由到用户服务，那么我们就可以使用Path断言Predicate。

2. Spring Cloud Gateway断言的种类及各自功能

根据源码我们可以看到Spring cloud gateway 的内置断言，我们可以看到核心10个内置Predicate

2.1. Path断言 PathRoutePredicateFactory

Path断言用于根据请求的路径进行匹配。设定该断言的时候，可以为路径设置一个或多个模式。例如，我们可以配置将所有路径为"/api/user"的请求路由到用户服务。

routes:
- id: user_service
  uri: http://localhost:8080
  predicates:
  - Path=/api/user

2.2.Method断言 MethodRoutePredicateFactory

Method断言用于根据HTTP请求方法进行匹配。例如，我们可以配置将所有POST方法的请求路由到某个服务。

routes:
- id: user_service
  uri: http://localhost:8080
  predicates:
  - Method=POST

2.3.Header断言 HeaderRoutePredicateFactory

Header断言用于根据HTTP请求头中的信息进行匹配。例如，我们可以配置将所有请求头中含有某个特定字段（比如X-Request-Id）的请求路由到某个服务。

routes:
- id: user_service
  uri: http://localhost:8080
  predicates:
  - Header=X-Request-Id, \d+

2.4.Host断言 HostRoutePredicateFactory

Host断言用于根据请求的主机名进行匹配。例如，我们可以配置将所有来自某个特定主机（比如myhost.com）的请求路由到某个服务。

routes:
- id: user_service
  uri: http://localhost:8080
  predicates:
  - Host=myhost.com

2.5.Query断言 QueryRoutePredicateFactory

Query断言用于根据请求的查询参数进行匹配。例如，我们可以配置将所有请求中包含某个特定查询参数（比如param）的请求路由到某个服务。

routes:
- id: user_service
  uri: http://localhost:8080
  predicates:
  - Query=param

2.6.Cookie断言 CookieRoutePredicateFactory

Cookie断言用于根据请求中的Cookie信息进行匹配。例如，我们可以配置将所有请求中含有某个特定Cookie的请求路由到某个服务。

routes:
- id: user_service
  uri: http://localhost:8080
  predicates:
  - Cookie=cookie

2.7.After/Between/Before断言

After/Between/Before断言主要用于根据请求的时间进行匹配。例如，我们可以配置在某个时间段内的请求路由到某个服务。

routes:
- id: user_service
  uri: http://localhost:8080
  predicates:
  - Between=2019-07-14T20:00:00.000+02:00, 2019-07-15T20:00:00.000+02:00

2.8.RemoteAddr断言 RemoteAddrRoutePredicateFactory

RemoteAddr断言主要用于根据请求的源IP地址进行匹配。例如，我们可以配置将所有来自某个特定IP地址（比如192.168.1.1/24）的请求路由到某个服务。

routes:
- id: user_service
  uri: http://localhost:8080
  predicates:
  - RemoteAddr=192.168.1.1/24

2.9.Weight断言 WeightRoutePredicateFactory

Weight断言主要用于根据权重进行匹配，常用于灰度发布或者流量控制。例如，我们可以配置将80%的请求路由到新版本的服务，20%的请求路由到旧版本的服务。

routes:
- id: user_service_v1
  uri: http://localhost:8081
  predicates:
  - Weight=group1, 8
- id: user_service_v2
  uri: http://localhost:8082
  predicates:
  - Weight=group1, 2

通过源码可以看到WeightRoutePredicateFactory 和其他断言不一样的是，实现了ApplicationEventPublisherAware接口。beforeApply方法在应用断言之前发布一个WeightDefinedEvent事件，以通知其他组件有关权重信息。事件发布者通过ApplicationEventPublisherAware接口获得ApplicationEventPublisher对象的引用。

3. 断言的组合使用

在Spring Cloud Gateway中，可以通过在同一个路由定义中添加多个断言来组合使用多个断言。这样做将创建一个逻辑AND条件，也就是说，只有当所有断言都匹配时，请求才会被路由到对应的服务。

举个栗子，假设想要将所有POST请求，并且路径为"/api/user"的请求路由到用户服务。可以这样配置：
只有当请求是POST方法，并且请求的路径为"/api/user"时，请求才会被路由到用户服务。

routes:
- id: user_service
  uri: http://localhost:8080
  predicates:
  - Path=/api/user
  - Method=POST

还可以在断言中使用"AND"和"OR"这样的关键字来创建更复杂的匹配条件。
例如，可以配置将所有POST或者PUT方法，并且路径为"/api/user"的请求路由到用户服务
只有当请求是POST或者PUT方法，并且请求的路径为"/api/user"时，请求才会被路由到用户服务。

routes:
- id: user_service
  uri: http://localhost:8080
  predicates:
  - Path=/api/user
  - Method=POST,PUT

4. 自定义断言

假设我们要根据请求头中的用户代理（User-Agent）限制对我们服务的访问，因为我们项目在开发过程中只支持谷歌浏览器和火狐浏览器，所以我们也可以使用自定义断言实现。只允许使用特定浏览器谷歌浏览器和火狐浏览器用户访问。我们可以创建一个自定义的断言工厂来实现这个功能。

断言工厂中，我们接受一个配置参数，该参数是一组允许的用户代理（User-Agent）字符串。断言将检查发出请求的客户端的用户代理字符串是否包含在这个列表中的任何一个。

import org.springframework.cloud.gateway.handler.predicate.AbstractRoutePredicateFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;

import java.util.Collections;
import java.util.List;
import java.util.function.Predicate;

@Component
public class UserAgentRoutePredicateFactory extends AbstractRoutePredicateFactory<UserAgentRoutePredicateFactory.Config> {

    public UserAgentRoutePredicateFactory() {
        super(Config.class);
    }

    @Override
    public List<String> shortcutFieldOrder() {
        return Collections.singletonList("allowedUserAgents");
    }

    @Override
    public Predicate<ServerWebExchange> apply(Config config) {
        return exchange -> {
            String userAgent = exchange.getRequest().getHeaders().getFirst("User-Agent");
            return config.getAllowedUserAgents().stream().anyMatch(userAgent::contains);
        };
    }

    public static class Config {
        private List<String> allowedUserAgents;

        public List<String> getAllowedUserAgents() {
            return allowedUserAgents;
        }

        public void setAllowedUserAgents(List<String> allowedUserAgents) {
            this.allowedUserAgents = allowedUserAgents;
        }
    }
}

可以在路由定义中使用这个自定义的断言

routes:
- id: my_route
  uri: http://localhost:8080
  predicates:
  - UserAgentRoutePredicateFactory=Chrome,Firefox

5. 断言的核心类详解

GatewayAutoConfiguration

断言工厂的初始化主要在GatewayAutoConfiguration中

以构造方法的形式注入到 RouteLocator

RoutePredicateFactory

RoutePredicateFactory 是 Spring Cloud Gateway 中用于处理路由预言（路由选择条件）的关键接口。

它是一个工厂接口，用于创建 Predicate 对象，这些对象用于评估给定的 HTTP 请求是否应该被路由到特定的路由。每个 RoutePredicateFactory 实现都定义了一种特定类型的路由选择条件，例如，基于请求头的路由选择，基于请求参数的路由选择，等等。

RoutePredicateFactory的主要方法如下：

1. ShortcutType shortcutType()：返回此工厂支持的快捷方式类型。快捷方式类型定义了如何从配置中解析断言定义。

2. Predicate apply(T config)：根据给定的配置创建一个 Predicate 实例。这个 Predicate 可以用于评估一个给定的 ServerWebExchange（代表一个 HTTP 请求）是否匹配此预言。

每个具体的 RoutePredicateFactory 实现类通常会有一个对应的配置类，用于存储此预言所需的配置信息。例如 HostRoutePredicateFactory 对应的配置类是 HostRoutePredicateFactory.Config，这个类有一个 hosts 属性用于存储要匹配的主机名列表。

在 Spring Cloud Gateway 的配置中，可以使用一个 YAML 或者 properties 配置文件来定义路由规则。在这个配置文件中，每个路由都可以有一个或者多个断言，每个断言都对应一个 RoutePredicateFactory。Spring Cloud Gateway 在启动时会解析这个配置文件，为每个断言创建一个对应的 RoutePredicateFactory 实例，然后使用它来创建 Predicate 实例。这些 Predicate 实例用于在运行时评估是否应该将一个请求路由到对应的路由。

6.参考文档

https://cloud.spring.io/spring-cloud-gateway/2.0.x/single/spring-cloud-gateway.html