SpringCloud-Gateway中自定义Predicate断言

以对用户进行会员等级判断为例

第一步：新建类名

注意：类名必须以RoutePredicateFactory结尾，并继承AbstractRoutePredicateFactory抽象类，例如：

@Component
public class MyRoutePredicateFactory extends AbstractRoutePredicateFactory<MyRoutePredicateFactory.Config>
{}

第二步:重写apply方法

@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;
        }
    };
}

第三步：新建apply方法所需要的静态内部类MyRoutePredicateFactory.Config

Config类是路由断言的规则，非常重要

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

第四步：建立一个空参构造方法，内部调用super()方法

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

第五步：实现shortcutFieldOrder方法，添加对简写格式的支持

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

完整的代码

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>
{
    // 添加空参构造方法，并调用super()
    public MyRoutePredicateFactory()
    {
        super(MyRoutePredicateFactory.Config.class);
    }

    // 新建apply方法所需要的静态内部类MyRoutePredicateFactory.Config
    @Validated
    public static class Config{
        @Setter
        @Getter
        @NotEmpty
        private String userType; //钻、金、银等用户等级
    }

    // 重写apply方法
    @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");
    }
}