Gateway過濾器詳解

一、概述

Gateway是Spring Cloud中的一部分，提供了一種靈活的、可擴展的方式來構建API網關，是整個微服務架構的入口和出口。Gateway過濾器位於Gateway請求處理流程的關鍵位置，可以對請求進行預處理或後處理。

Gateway默認提供了一些常用的過濾器，如路由、重試等，同時也可以自定義過濾器。本文將從過濾器的類型、實現方式、應用場景等方面對Gateway過濾器進行詳解。

二、Gateway過濾器類型

Gateway過濾器根據實現方式可以分為Global Filter和Scoped Filter兩種類型。

1. Global Filter

Global Filter是在整個Gateway路由請求流程中都會執行的過濾器，可以實現一些全局的功能，如請求鑒權、請求日誌等。

Global Filter的實現方式很簡單，只需要實現GatewayFilter接口並將其註冊到RouteLocator中即可：

public class AuthFilter implements GatewayFilter {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 鑒權邏輯
        return chain.filter(exchange);
    }
}

@Configuration
public class GatewayConfig {

    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {
        return builder.routes()
                .route("auth_route", r -> r.path("/api/**").filters(f -> f.filter(new AuthFilter()))
                .uri("lb://auth-service"))
                .build();
    }
}

2. Scoped Filter

Scoped Filter是在指定路由規則下執行的過濾器，可以實現路由相關的功能，如路由重試、請求頭修改等。

Scoped Filter的實現方式也很簡單，只需要在RouteDefinition中將其註冊即可：

@Configuration
public class GatewayConfig {

    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {
        return builder.routes()
                .route("retry_route", r -> r.path("/api/**").filters(f -> f.rewritePath("/api/(?<name>.*)", "/${name}")
                .addRequestHeader("X-Request-ID", UUID.randomUUID().toString())
                .retry(3))
                .uri("lb://service"))
                .build();
    }
}

三、Gateway過濾器實現

Gateway過濾器需要實現GatewayFilter接口，並在filter方法中編寫自定義的過濾邏輯。需要注意的是，filter方法返回的是Mono<Void>類型，表示過濾完成後需要繼續調用下一個過濾器。

過濾器可以獲取到ServerWebExchange對象，可以通過該對象對請求或響應進行修改或獲取各種必要信息。

以下是一個自定義的限流過濾器實現：

public class RateLimiterFilter implements GatewayFilter {
    
    private final RateLimiter rateLimiter;

    public RateLimiterFilter(RateLimiter rateLimiter) {
        this.rateLimiter = rateLimiter;
    }

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        Mono<Boolean> isAllowed = rateLimiter.isAllowed(exchange.getRequest().getRemoteAddress().getAddress());
        return isAllowed.flatMap(allowed -> {
            if (allowed) {
                return chain.filter(exchange);
            } else {
                exchange.getResponse().setStatusCode(HttpStatus.TOO_MANY_REQUESTS);
                return exchange.getResponse().setComplete();
            }
        });
    }
}

@Configuration
public class GatewayConfig {

    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder,
            RateLimiter rateLimiter) {
        return builder.routes()
                .route("rate_limit_route", r -> r.path("/api/**").filters(f -> f.filter(new RateLimiterFilter(rateLimiter)))
                .uri("lb://service"))
                .build();
    }
}

四、Gateway過濾器應用場景

Gateway過濾器的應用場景非常廣泛，可以通過過濾器實現各種功能，以下是一部分常見場景：

1. 請求鑒權

通過過濾器對請求進行鑒權，如校驗請求頭、Token等。

2. 請求日誌

通過過濾器實現請求日誌記錄，方便問題排查和性能優化。

3. 限流

通過過濾器實現請求的限流功能，避免被惡意攻擊或高並發請求拖垮服務。

4. 敏感信息過濾

通過過濾器實現敏感信息的過濾，如過濾手機號、銀行卡號等。

5. 請求重試

通過過濾器實現請求的重試功能，避免因為下游服務不可用而導致的請求失敗。

五、總結

Gateway過濾器是Spring Cloud Gateway中非常重要的一部分，可以對請求進行預處理或後處理，實現各種功能。本文從過濾器類型、實現方式、應用場景等方面對Gateway過濾器進行了詳細的介紹，並提供了相關的代碼示例。