Spring-Cloud-Gateway之route數據模型

網關服務核心是將進入的請求正確合理的路由到下層具體的服務進行業(yè)務處理,由此可見網關服務的核心就是路由信息的構建。下面學習和閱讀下Spring-Cloud-Gateway的route數據模型


首先查看Route模型的代碼如下:

public class Route implements Ordered {

    /**
     * 路由編號
     * ID 編號,唯一
     */
    private final String id;

    /**
     * 路由向的 URI
     *
     */
    private final URI uri;

    /**
     * 順序
     * 當請求匹配到多個路由時,使用順序小的
     */
    private final int order;

    /**
     * 謂語數組
     * 請求通過 predicates 判斷是否匹配
     */
    private final Predicate<ServerWebExchange> predicate;

    /**
     * 過濾器數組
     */
    private final List<GatewayFilter> gatewayFilters;
    }
    

由代碼可以看到一個路由應該包含如下必要的信息:

  • id:路由編號,唯一
  • uri:路由向的 URI,對應的具體業(yè)務服務的URL
  • order:順序,當請求匹配多個路由時,使用順序小的
  • predicate: 請求匹配路由的斷言條件
  • gatewayFilters: 當前路由上存在的過濾器,用于對請求做攔截處理

Route模型是通過RouteDefinition(路由定義)模型構建起來的,接下來查看RouteDefinition

/**
 * 路由定義實體信息,包含路由的定義信息
 * @author Spencer Gibb
 */
@Validated
public class RouteDefinition {

    /**
     * 路由ID 編號,唯一
     */
    @NotEmpty
    private String id = UUID.randomUUID().toString();

    /**
     * 謂語定義數組
     * predicates 屬性,謂語定義數組
     * 請求通過 predicates 判斷是否匹配。在 Route 里,PredicateDefinition 轉換成 Predicate
     */
    @NotEmpty
    @Valid
    private List<PredicateDefinition> predicates = new ArrayList<>();

    /**
     *過濾器定義數組
     * filters 屬性,過濾器定義數組。
     * 在 Route 里,FilterDefinition 轉換成 GatewayFilter
     */
    @Valid
    private List<FilterDefinition> filters = new ArrayList<>();

    /**
     * 路由指向的URI
     */
    @NotNull
    private URI uri;

    /**
     * 順序
     */
    private int order = 0;
}

這個模型與上面的Route模型是不是很相似,它是對route的定義以及描述,Spring-Cloud-Gateway最終會通過RouteDefinition來構建起Route實例信息。
細看RouteDefinition代碼會發(fā)現其中包含兩個數組分別是PredicateDefinition,FilterDefinition的數組。

  • PredicateDefinition : 斷言條件(謂語)定義,構建 Route 時,PredicateDefinition 轉換成 Predicate
  • FilterDefinition : 過濾條件的定義,構建Route 時,FilterDefinition 轉換成 GatewayFilter

那么我們看下PredicateDefinition與FilterDefinition的代碼

  • PredicateDefinition
/**
 * 謂語定義,在 Route 里,PredicateDefinition將轉換成 Predicate
 * @author Spencer Gibb
 */
@Validated
public class PredicateDefinition {
    /**
     * 謂語定義名字
     * 通過 name 對應到 org.springframework.cloud.gateway.handler.predicate.RoutePredicateFactory 的實現類。
     * 例如: name=Query 對應到 QueryRoutePredicateFactory
     */
    @NotNull
    private String name;
    /**
     * 參數數組
     * 例如,name=Host / args={"_genkey_0" : "iocoder.cn"} ,匹配請求的 hostname 為 iocoder.cn
     */
    private Map<String, String> args = new LinkedHashMap<>();
}   

PredicateDefinition 描述了構建Predicate的必要條件

  • name:名稱,Spring-Cloud-Gateway會根據name找到Predicate的構建工廠類
  • args:參數,構建Predicate的參數
  • FilterDefinition
/**
 * 過濾器定義,在 Route 里,FilterDefinition將轉換成 GatewayFilter
 * @author Spencer Gibb
 */
@Validated
public class FilterDefinition {
    /**
     * 過濾器定義名字
     * 通過 name 對應到 org.springframework.cloud.gateway.filter.factory.GatewayFilterFactory 的實現類。
     * 例如,name=AddRequestParameter 對應到 AddRequestParameterGatewayFilterFactory
     */
    @NotNull
    private String name;


    /**
     * 參數數組
     * 例如 name=AddRequestParameter / args={"_genkey_0": "foo", "_genkey_1": "bar"} ,添加請求參數 foo 為 bar
     */
    private Map<String, String> args = new LinkedHashMap<>();
}

FilterDefinition 描述了構建GatewayFilter的必要條件

  • name:名稱,Spring-Cloud-Gateway會根據name找到GatewayFilter的構建工廠類
  • args:參數,構建GatewayFilter的參數

通過這些基礎的數據模型我可以清晰看到Spring-Cloud-Gateway構建路由的數據流向


路由數據流向.png

通過數據流向可以幫助我們接下來閱讀Route信息的初始化加載以及路由的使用

?著作權歸作者所有,轉載或內容合作請聯系作者
【社區(qū)內容提示】社區(qū)部分內容疑似由AI輔助生成,瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發(fā)布,文章內容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

相關閱讀更多精彩內容

  • Spring Cloud為開發(fā)人員提供了快速構建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務發(fā)現,斷路器,智...
    卡卡羅2017閱讀 136,695評論 19 139
  • 前言 在微服務架構的系統(tǒng)中,我們通常會使用輕量級的消息代理來構建一個共用的消息主題讓系統(tǒng)中所有微服務實例都連接上來...
    Chandler_玨瑜閱讀 6,789評論 2 39
  • Spring Boot 參考指南 介紹 轉載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 47,288評論 6 342
  • Spring Web MVC Spring Web MVC 是包含在 Spring 框架中的 Web 框架,建立于...
    Hsinwong閱讀 22,970評論 1 92
  • 今天早上把4月份有火腿的預定表給各班發(fā)下去了,并安排發(fā)放內容以及填寫表格的要求。上午全校學生集中進行了期中考...
    珍妮_e5cd閱讀 174評論 0 0

友情鏈接更多精彩內容