快捷導(dǎo)航

gataway斷言工作流程源碼剖析

更新時(shí)間：2024年01月15日 08:31:37 作者：朱永勝

這篇文章主要為大家介紹了gataway斷言工作流程源碼剖析，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

Cookie斷言

拿Cookie斷言來說，首先看它的體系結(jié)構(gòu)

public class CookieRoutePredicateFactory
        extends AbstractRoutePredicateFactory<CookieRoutePredicateFactory.Config> {
    /**
     * Name key.
     */
    public static final String NAME_KEY = "name";
    /**
     * Regexp key.
     */
    public static final String REGEXP_KEY = "regexp";
    public CookieRoutePredicateFactory() {
        super(Config.class);
    }
    /*
      通過shortcutFieldOrder方法設(shè)置Config配置類中的屬性,需要根據(jù)具體的規(guī)則來設(shè)置
      通過shortcutType方法獲取具體規(guī)則，具體參看：org.springframework.cloud.gateway.support.ShortcutConfigurable.ShortcutType
      規(guī)則包括以下幾種：
        DEFAULT : 按照shortcutFieldOrder順序依次賦值
    */
    @Override
    public List<String> shortcutFieldOrder() {
        return Arrays.asList(NAME_KEY, REGEXP_KEY);
    }
    @Override
    public Predicate<ServerWebExchange> apply(Config config) {
        return new GatewayPredicate() {
            @Override
            public boolean test(ServerWebExchange exchange) {
                List<HttpCookie> cookies = exchange.getRequest().getCookies()
                        .get(config.name);
                if (cookies == null) {
                    return false;
                }
                for (HttpCookie cookie : cookies) {
                    if (cookie.getValue().matches(config.regexp)) {
                        return true;
                    }
                }
                return false;
            }
            @Override
            public String toString() {
                return String.format("Cookie: name=%s regexp=%s", config.name,
                        config.regexp);
            }
        };
    }
    /*
     內(nèi)部配置類是用來接收在配置文件中配置的參數(shù)的
      routes:
        #唯一標(biāo)識(shí)符
        - id: hailtaxi-driver
          uri: lb://hailtaxi-driver
          #路由斷言
          predicates:
            - Cookie=username,itheima
    */
    @Validated
    public static class Config {
        @NotEmpty
        private String name;
        @NotEmpty
        private String regexp;
        public String getName() {
            return name;
        }
        public Config setName(String name) {
            this.name = name;
            return this;
        }
        public String getRegexp() {
            return regexp;
        }
        public Config setRegexp(String regexp) {
            this.regexp = regexp;
            return this;
        }
    }
}

盡管Spring Cloud Gateway已經(jīng)包含了很多路由匹配規(guī)則，有時(shí)候我們需要開發(fā)自定義路由匹配規(guī)則來滿足需求，下面簡單的介紹一下如何自定義路由匹配規(guī)則。

案例

需求：轉(zhuǎn)發(fā)帶token的請(qǐng)求到hailtaxi-drvier服務(wù)中，這里定義請(qǐng)求帶token是指包含某個(gè)請(qǐng)求頭的請(qǐng)求，至于是什么請(qǐng)求頭可以由配置指定

1、修改配置文件

gateway:
      #路由配置
      routes:
        #唯一標(biāo)識(shí)符
        - id: hailtaxi-driver
          uri: lb://hailtaxi-driver
          #路由斷言
          predicates:
            # 自定義一個(gè)Token斷言,如果請(qǐng)求包含Authorization的token信息則通過
            - Token=Authorization

2、創(chuàng)建 RoutePredicateFactory

斷言工廠默認(rèn)命名規(guī)則必須按照"名稱"+RoutePredicateFactory，如上TokenRoutePredicateFactory的斷言名稱為Token

@Slf4j
@Component // 要交給spring容器管理
public class TokenRoutePredicateFactory extends AbstractRoutePredicateFactory<TokenRoutePredicateFactory.Config> {
    public TokenRoutePredicateFactory() {
        super(Config.class);
    }
    public Predicate<ServerWebExchange> apply(Config config) {
        return exchange -> {
            // 打印配置文件參數(shù)值
            String headerName = config.getHeaderName();
            HttpHeaders headers = exchange.getRequest().getHeaders();
            List<String> header = headers.get(headerName);
            log.info("Token Predicate headers:{}", header);
            // 斷言返回的是boolean值
            return header!=null && header.size()>0;
        };
    }
    @Override
    public List<String> shortcutFieldOrder() {
        return Arrays.asList("headerName");//指定配置文件中加載到的配置信息應(yīng)填充到Config的哪個(gè)屬性上
    }
    @Override
    public ShortcutType shortcutType() {
        return ShortcutType.DEFAULT;
    }
    @Data
    public static class Config { //static class
        private String headerName;//存儲(chǔ)從配置文件中加載的配置
    }
}