Spring Cloud Gateway网关的高级特性以及配置之Route Predicate Factories（路由谓词工厂）

一、Route Predicate Factories（路由谓词工厂）

还是先来查看官网的说明：点击此处

路由谓词工厂是微服务网关（如Spring Cloud Gateway）中用于定义路由规则的一种机制。它们用来决定哪些请求应该被路由到特定的服务。

简单来说就是：

• Route Predicate Factories 提供了一种方式来指定什么样的请求应该被路由到某个服务。这通常是基于请求的属性，比如路径、查询参数、头部信息等。【你可以创建自己的Route Predicate Factories来满足特定的需求，这样就可以定制化地处理请求。】
• 当一个请求到达网关时，网关会根据配置的规则来检查该请求是否符合某个Route Predicate Factory的条件。如果请求匹配了某个Route Predicate Factory的条件，则该请求会被路由到相应的服务。

二、Route Predicate 的配置

针对上图所示的几种内置的Route Predicate 我们来在配置文件中进行配置。

1、配置方法有两种：

1. shortcuts
2. fully expanded arguments.

配置Route Predicate 的股份描述如下图所示：

2、具体配置如下所示：

server:
  port: 9527

spring:
  application:
    name: cloud-gateway #以微服务注册进consul或nacos服务列表内
  cloud:
    consul: #配置consul地址
      host: localhost
      port: 8500
      discovery:
        prefer-ip-address: true
        service-name: ${spring.application.name}
    gateway:
      routes:
        - id: pay_routh1 #pay_routh1                #路由的ID(类似mysql主键ID)，没有固定规则但要求唯一，建议配合服务名
          #uri: http://localhost:8001                #匹配后提供服务的路由地址
          uri: lb://cloud-payment-service                #匹配后提供服务的路由地址
          predicates:
            - Path=/pay/gateway/get/**              # 断言，路径相匹配的进行路由
            - After=2023-12-30T23:02:39.079979400+08:00[Asia/Shanghai]
            #- Cookie=username,zzyy
            # - Header=X-Request-Id, \d+ # 请求头要有X-Request-Id属性并且值为整数的正则表达式
            #- Host=**.atguigu.com
            #- Query=username, \d+  # 要有参数名username并且值还要是整数才能路由
            #- RemoteAddr=192.168.124.1/24 # 外部访问我的IP限制，最大跨度不超过32，目前是1~24它们是 CIDR 表示法。

        - id: pay_routh2 #pay_routh2                #路由的ID(类似mysql主键ID)，没有固定规则但要求唯一，建议配合服务名
          #uri: http://localhost:8001                #匹配后提供服务的路由地址
          uri: lb://cloud-payment-service
          predicates:
            - Path=/pay/gateway/info/**              # 断言，路径相匹配的进行路由

小贴士：
如何获得ZonedDateTime？？
很简单，创建一个main方法，代码如下：
import java.time.ZoneId;
import java.time.ZonedDateTime;

public class ZonedDateTimeDemo
{
    public static void main(String[] args)
    {
        ZonedDateTime zbj = ZonedDateTime.now(); // 默认时区
              System.out.println(zbj);
    }
}

三、自定义断言规则

除了上面的内置的几种规则之外，我们还可以自定义断言规则。注意格式是XXRoutePredicateFactory.
为什么要自定义断言规则呢？？
那肯定就是原有的断言配置不满足业务需求喽

话不多说，直接开始自定义路由断言规则步骤：
1.新建类名XXX需要以RoutePredicateFactory结尾并继承AbstractRoutePredicateFactory类自
2新建apply方法所需要的静态内部类MyRoutePredicateFactory.Config这个Config类就是我们的路由断言规则
3.空参构造方法，内部调用super
4.重写apply方法

完整代码如下所示：

import jakarta.validation.constraints.NotEmpty;
import lombok.Getter;
import lombok.Setter;
import org.springframework.cloud.gateway.handler.predicate.AbstractRoutePredicateFactory;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.server.ServerWebExchange;

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

@Component
public class MyRoutePredicateFactory extends AbstractRoutePredicateFactory<MyRoutePredicateFactory.Config>
{
    public MyRoutePredicateFactory()
    {
        super(MyRoutePredicateFactory.Config.class);
    }

    @Validated
    public static class Config{
        @Setter
        @Getter
        @NotEmpty
        private String userType; //钻、金、银等用户等级
    }

    @Override
    public Predicate<ServerWebExchange> apply(MyRoutePredicateFactory.Config config)
    {
        return new Predicate<ServerWebExchange>()
        {
            @Override
            public boolean test(ServerWebExchange serverWebExchange)
            {
                //检查request的参数里面，userType是否为指定的值，符合配置就通过
                String userType = serverWebExchange.getRequest().getQueryParams().getFirst("userType");

                if (userType == null) return false;

                //如果说参数存在，就和config的数据进行比较
                if(userType.equals(config.getUserType())) {
                    return true;
                }

                return false;
            }
        };
    }
	// 如果缺少shortcutFieldOrder方法的实现，就不支持短格式，所以要重写
	@Override
	public List<String> shortcutFieldOrder() {
	  return Collections.singletonList("userType");
	}
}

yml配置如下：和内置的配置使用都是一样的

spring:
  application:
    name: cloud-gateway #以微服务注册进consul或nacos服务列表内
  cloud:
    consul: #配置consul地址
      host: localhost
      port: 8500
      discovery:
        prefer-ip-address: true
        service-name: ${spring.application.name}
    gateway:
      routes:
        - id: pay_routh1 
          uri: lb://cloud-payment-service                #匹配后提供服务的路由地址
          predicates:
            - Path=/pay/gateway/get/**              
            - After=2023-12-30T23:02:39.079979400+08:00[Asia/Shanghai]
            - My=diamond		# 自定义的配置

我的浏览器地址栏访问如下地址（顺利通过测试）：