天天播報:Spring Cloud Gateway過濾器的執行順序

在Spring Cloud Gateway中，過濾器的執行順序對于實現請求處理流程的正確性和效率至關重要。Spring Cloud Gateway中的過濾器分為全局過濾器和局部過濾器兩種類型，不同類型的過濾器在執行順序上有所不同。

全局過濾器執行順序

【資料圖】

全局過濾器是指在所有路由規則中都會執行的過濾器，可以用于實現一些全局性的功能，如請求的日志記錄、響應頭信息的設置等。Spring Cloud Gateway提供了一些內置的全局過濾器，如請求路徑的重寫、請求日志的記錄等。在Spring Cloud Gateway中，全局過濾器的執行順序是由GatewayFilterAdapter的ORDER常量值確定的，該常量值為-2147483648，表示全局過濾器將在所有的局部過濾器之前執行。

局部過濾器執行順序

局部過濾器是指只在特定路由規則中才會執行的過濾器，可以用于實現一些特定的功能，如請求鑒權、請求轉發等。Spring Cloud Gateway中的局部過濾器可以通過自定義過濾器工廠類來實現，該工廠類需要繼承AbstractGatewayFilterFactory抽象類，并實現其中的apply方法和泛型參數指定配置類。在Spring Cloud Gateway中，局部過濾器的執行順序是由配置文件中的filters屬性確定的，該屬性可以通過spring.cloud.gateway.routes.filters參數進行配置，不同的過濾器在列表中的位置就決定了它們的執行順序。

以下是一個示例，其中定義了一個全局過濾器和兩個局部過濾器，演示了不同類型過濾器的執行順序：

@Componentpublic class GlobalFilter implements GatewayFilter, Ordered {    @Override    public Mono filter(ServerWebExchange exchange, GatewayFilterChain chain) {        System.out.println("GlobalFilter before...");        return chain.filter(exchange).then(Mono.fromRunnable(() -> {            System.out.println("GlobalFilter after...");        }));    }    @Override    public int getOrder() {        return -1;    }}@Componentpublic class LocalFilter1 extends AbstractGatewayFilterFactory {    public LocalFilter1() {        super(Config.class);    }    @Override    public GatewayFilter apply(Config config) {        return (exchange, chain) -> {            System.out.println("LocalFilter1 before...");            return chain.filter(exchange).then(Mono.fromRunnable(() -> {                System.out.println("LocalFilter1 after...");            }));        };    }    public static class Config {        // 配置參數    }}@Componentpublic class LocalFilter2 extends AbstractGatewayFilterFactory {    public LocalFilter2() {        super(Config.class);    }    @Override    public GatewayFilter apply(Config config) {        return (exchange, chain) -> {            System.out.println("LocalFilter2 before...");            return chain.filter(exchange).then(Mono.fromRunnable(() -> {                System.out.println("LocalFilter2 after...");            }));        };    }    public static class Config {        // 配置參數    }}

復制

在這個示例中，我們定義了一個全局過濾器GlobalFilter和兩個局部過濾器LocalFilter1和LocalFilter2。其中，GlobalFilter實現了GatewayFilter和Ordered接口，用于實現全局過濾器的邏輯。LocalFilter1和LocalFilter2都繼承了AbstractGatewayFilterFactory抽象類，并通過實現apply方法實現了局部過濾器的邏輯。在apply方法中，我們可以實現自己的過濾邏輯，并返回一個GatewayFilter對象。在GatewayFilter對象中，我們可以繼續調用chain.filter方法來執行下一個過濾器，或者直接返回結果。這里我們使用Mono.fromRunnable方法來在請求結束時輸出一些信息。

在上述示例中，我們定義了全局過濾器和兩個局部過濾器。在執行順序方面，由于全局過濾器的ORDER常量值最小，因此它會在所有的局部過濾器之前執行。而在局部過濾器的執行順序方面，它們的執行順序是由配置文件中的filters屬性決定的，如下所示：

spring:  cloud:    gateway:      routes:      - id: example        uri: http://example.org        predicates:        - Path=/example/**        filters:        - LocalFilter2        - LocalFilter1

復制

在這個配置文件中，我們為example路由規則指定了兩個局部過濾器，分別是LocalFilter2和LocalFilter1。在執行順序方面，LocalFilter2將會先于LocalFilter1執行，因為它們在filters列表中的位置是從前往后的。也就是說，請求先經過LocalFilter2，再經過LocalFilter1，最后再到達后端服務。

需要注意的是，在GatewayFilterChain中的filter方法調用中，如果其中一個過濾器返回了錯誤，那么整個請求處理過程會立即停止并返回錯誤。因此，在設計過濾器時需要格外小心，確保每個過濾器都不會拋出異常，以免影響整個系統的穩定性。

此外，還有一些其他的過濾器類型，如：

Pre Filter：在請求被路由之前調用。可以用來實現身份認證、IP過濾等邏輯。Post Filter：在請求被路由之后調用。可以用來實現響應頭處理、日志記錄等邏輯。Error Filter：在請求處理過程中發生錯誤時調用。可以用來實現異常處理、錯誤日志記錄等邏輯。

這些過濾器類型可以通過實現不同的接口來實現。例如，實現Ordered和GatewayFilter接口的就是Pre Filter和Global Filter類型的過濾器。而實現Ordered和WebFilter接口的則是Error Filter類型的過濾器。

標簽：