天天播報(bào):Spring Cloud Gateway過(guò)濾器的執(zhí)行順序

在Spring Cloud Gateway中，過(guò)濾器的執(zhí)行順序?qū)τ趯?shí)現(xiàn)請(qǐng)求處理流程的正確性和效率至關(guān)重要。Spring Cloud Gateway中的過(guò)濾器分為全局過(guò)濾器和局部過(guò)濾器兩種類(lèi)型，不同類(lèi)型的過(guò)濾器在執(zhí)行順序上有所不同。

全局過(guò)濾器執(zhí)行順序

【資料圖】

全局過(guò)濾器是指在所有路由規(guī)則中都會(huì)執(zhí)行的過(guò)濾器，可以用于實(shí)現(xiàn)一些全局性的功能，如請(qǐng)求的日志記錄、響應(yīng)頭信息的設(shè)置等。Spring Cloud Gateway提供了一些內(nèi)置的全局過(guò)濾器，如請(qǐng)求路徑的重寫(xiě)、請(qǐng)求日志的記錄等。在Spring Cloud Gateway中，全局過(guò)濾器的執(zhí)行順序是由GatewayFilterAdapter的ORDER常量值確定的，該常量值為-2147483648，表示全局過(guò)濾器將在所有的局部過(guò)濾器之前執(zhí)行。

局部過(guò)濾器執(zhí)行順序

局部過(guò)濾器是指只在特定路由規(guī)則中才會(huì)執(zhí)行的過(guò)濾器，可以用于實(shí)現(xiàn)一些特定的功能，如請(qǐng)求鑒權(quán)、請(qǐng)求轉(zhuǎn)發(fā)等。Spring Cloud Gateway中的局部過(guò)濾器可以通過(guò)自定義過(guò)濾器工廠類(lèi)來(lái)實(shí)現(xiàn)，該工廠類(lèi)需要繼承AbstractGatewayFilterFactory抽象類(lèi)，并實(shí)現(xiàn)其中的apply方法和泛型參數(shù)指定配置類(lèi)。在Spring Cloud Gateway中，局部過(guò)濾器的執(zhí)行順序是由配置文件中的filters屬性確定的，該屬性可以通過(guò)spring.cloud.gateway.routes.filters參數(shù)進(jìn)行配置，不同的過(guò)濾器在列表中的位置就決定了它們的執(zhí)行順序。

以下是一個(gè)示例，其中定義了一個(gè)全局過(guò)濾器和兩個(gè)局部過(guò)濾器，演示了不同類(lèi)型過(guò)濾器的執(zhí)行順序：

@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 {        // 配置參數(shù)    }}@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 {        // 配置參數(shù)    }}

復(fù)制

在這個(gè)示例中，我們定義了一個(gè)全局過(guò)濾器GlobalFilter和兩個(gè)局部過(guò)濾器LocalFilter1和LocalFilter2。其中，GlobalFilter實(shí)現(xiàn)了GatewayFilter和Ordered接口，用于實(shí)現(xiàn)全局過(guò)濾器的邏輯。LocalFilter1和LocalFilter2都繼承了AbstractGatewayFilterFactory抽象類(lèi)，并通過(guò)實(shí)現(xiàn)apply方法實(shí)現(xiàn)了局部過(guò)濾器的邏輯。在apply方法中，我們可以實(shí)現(xiàn)自己的過(guò)濾邏輯，并返回一個(gè)GatewayFilter對(duì)象。在GatewayFilter對(duì)象中，我們可以繼續(xù)調(diào)用chain.filter方法來(lái)執(zhí)行下一個(gè)過(guò)濾器，或者直接返回結(jié)果。這里我們使用Mono.fromRunnable方法來(lái)在請(qǐng)求結(jié)束時(shí)輸出一些信息。

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

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

復(fù)制

在這個(gè)配置文件中，我們?yōu)閑xample路由規(guī)則指定了兩個(gè)局部過(guò)濾器，分別是LocalFilter2和LocalFilter1。在執(zhí)行順序方面，LocalFilter2將會(huì)先于LocalFilter1執(zhí)行，因?yàn)樗鼈冊(cè)趂ilters列表中的位置是從前往后的。也就是說(shuō)，請(qǐng)求先經(jīng)過(guò)LocalFilter2，再經(jīng)過(guò)LocalFilter1，最后再到達(dá)后端服務(wù)。

需要注意的是，在GatewayFilterChain中的filter方法調(diào)用中，如果其中一個(gè)過(guò)濾器返回了錯(cuò)誤，那么整個(gè)請(qǐng)求處理過(guò)程會(huì)立即停止并返回錯(cuò)誤。因此，在設(shè)計(jì)過(guò)濾器時(shí)需要格外小心，確保每個(gè)過(guò)濾器都不會(huì)拋出異常，以免影響整個(gè)系統(tǒng)的穩(wěn)定性。

此外，還有一些其他的過(guò)濾器類(lèi)型，如：

Pre Filter：在請(qǐng)求被路由之前調(diào)用?？梢杂脕?lái)實(shí)現(xiàn)身份認(rèn)證、IP過(guò)濾等邏輯。Post Filter：在請(qǐng)求被路由之后調(diào)用?？梢杂脕?lái)實(shí)現(xiàn)響應(yīng)頭處理、日志記錄等邏輯。Error Filter：在請(qǐng)求處理過(guò)程中發(fā)生錯(cuò)誤時(shí)調(diào)用?？梢杂脕?lái)實(shí)現(xiàn)異常處理、錯(cuò)誤日志記錄等邏輯。

這些過(guò)濾器類(lèi)型可以通過(guò)實(shí)現(xiàn)不同的接口來(lái)實(shí)現(xiàn)。例如，實(shí)現(xiàn)Ordered和GatewayFilter接口的就是Pre Filter和Global Filter類(lèi)型的過(guò)濾器。而實(shí)現(xiàn)Ordered和WebFilter接口的則是Error Filter類(lèi)型的過(guò)濾器。

標(biāo)簽：