SpringCloudGatewayカスタムアサーションファクトリ

公式に提供されているすべてのアサーションファクトリがビジネス要件を満たせない場合は、アサーションファクトリをカスタマイズすることもできます。

カスタムアサーションファクトリクラスを追加します

カスタムアサーションファクトリについて注意すべき主なポイントは次のとおりです。

• Springboot Beanを宣言し、アノテーション@Componentを追加する必要があります。また、名前は、名前付けの制約であるRoutePredicateFactoryで終わる必要があります。
• 名前付けの制約に従って名前を付けないと、アサーションファクトリが見つかりません。プレフィックスは、構成で構成されたアサーションです。
• Gatewayに実装されているアサーションファクトリを直接コピーし、対応するコンテンツを変更して、ピットを踏まないようにすることができます。
• 親クラスAbstractRoutePredicateFactoryを継承し、メソッドをオーバーライドします。
• アサーション構成のデータを受信するには、Config静的内部クラスを定義する必要があります。
• オーバーライドされたshortcutFieldOrderメソッドで、Configのプロパティをバインドします。着信配列の内容は、Configのプロパティと一致している必要があります。
• オーバーライドされたapplyメソッドで、特定の検証ロジックを実装します。

import com.alibaba.cloud.commons.lang.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.cloud.gateway.handler.predicate.AbstractRoutePredicateFactory;
import org.springframework.cloud.gateway.handler.predicate.GatewayPredicate;
import org.springframework.http.HttpHeaders;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;

import javax.validation.constraints.NotNull;
import java.util.Arrays;
import java.util.List;
import java.util.function.Predicate;

/**
 * @ClassName CustomVerifyRoutePredicateFactory
 * @Description 
 * @Author tigerkin
 * @Date 2022/3/14 15:15
 */
@Component
public class CustomVerifyRoutePredicateFactory extends AbstractRoutePredicateFactory<CustomVerifyRoutePredicateFactory.Config> {

    private final Logger log = LoggerFactory.getLogger(this.getClass());

    /**
     * 验证内容 key.
     */
    public static final String VERIFY_CONTENT_KEY = "verifyContentKey";

    /**
     * 验证内容 val.
     */
    public static final String VERIFY_CONTENT_VAL = "verifyContentVal";

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

    /**
     * 将签名 key 与 静态类Config中的属性进行绑定
     * 数组里面下标对应配置文件中配置
     *
     * @return
     */
    @Override
    public List<String> shortcutFieldOrder() {
        return Arrays.asList(VERIFY_CONTENT_KEY, VERIFY_CONTENT_VAL);
    }

    @Override
    public Predicate<ServerWebExchange> apply(CustomVerifyRoutePredicateFactory.Config config) {
        return new GatewayPredicate() {

            /**
             * 断言验证逻辑，返回true，则验证成功，否则失败
             *
             * @param serverWebExchange
             * @return
             */
            @Override
            public boolean test(ServerWebExchange serverWebExchange) {
                HttpHeaders headers = serverWebExchange.getRequest().getHeaders();
                String headerVal = headers.getFirst(config.getVerifyContentKey());
                boolean result = StringUtils.equals(headerVal, config.getVerifyContentVal());

                log.info("========> 自定义断言配置 key：{} val：{}", config.getVerifyContentKey(), config.getVerifyContentVal());
                log.info("========> 自定义断言验证 status：{} val：{}", result, headerVal);
                return result;
            }

            @Override
            public Object getConfig() {
                return config;
            }

            @Override
            public String toString() {
                return String.format("key: %s, val: %s", config.getVerifyContentKey(), config.getVerifyContentVal());
            }
        };
    }

    /**
     * 定义静态类，接收自定义断言的配置信息
     */
    public static class Config {

        @NotNull
        private String verifyContentKey;

        @NotNull
        private String verifyContentVal;

        public String getVerifyContentKey() {
            return verifyContentKey;
        }

        public void setVerifyContentKey(String verifyContentKey) {
            this.verifyContentKey = verifyContentKey;
        }

        public String getVerifyContentVal() {
            return verifyContentVal;
        }

        public void setVerifyContentVal(String verifyContentVal) {
            this.verifyContentVal = verifyContentVal;
        }
    }
}

カスタムアサーションファクトリを構成する

spring:
  cloud:
    gateway:
      routes:
        - id: user-route # 路由ID，唯一标识，自定义命名
          uri: lb://gateway-user
          predicates:
            - Path=/user-server/**
            # 自定义的断言工厂，多个参数按逗号（,）隔开，参数对应断言工厂中shortcutFieldOrder方法定义的数组，一一对应。
            - CustomVerify=verify, success 

この時点で、カスタムアサーションファクトリが完成しました。！！