Spring Cloud Gateway グローバル フィルターの概要

この記事では、Spring Cloud Gateway のグローバル フィルターについて紹介します。一定の参考値があります。必要な友人は参照してください。お役に立てば幸いです。

グローバル フィルターはすべてのルートに作用するため、個別に構成する必要はなく、権限認証や IP アクセス制限など、多くの統合処理ビジネス要件を実現するために使用できます。

インターフェイス定義クラス: org.springframework.cloud.gateway.filter.GlobalFilter

public interface GlobalFilter {
    Mono<void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}</void>

以下に示すように、ゲートウェイに付属する GlobalFilter 実装クラスが多数あります。

##転送、ルーティング、ロードなどに関連する GlobalFilters があります。興味がある場合は、ソース コードをチェックして詳細を確認してください。

独自のビジネス ロジックを実装するために GlobalFilter を定義するにはどうすればよいでしょうか?

公式ドキュメントから例を挙げると、

@Configuration
public class ExampleConfiguration {
    private Logger log = LoggerFactory.getLogger(ExampleConfiguration.class);

    @Bean
    @Order(-1)
    public GlobalFilter a() {
        return (exchange, chain) -> {
            log.info("first pre filter");
            return chain.filter(exchange).then(Mono.fromRunnable(() -> {
                log.info("third post filter");
            }));
        };
    }

    @Bean
    @Order(0)
    public GlobalFilter b() {
        return (exchange, chain) -> {
            log.info("second pre filter");
            return chain.filter(exchange).then(Mono.fromRunnable(() -> {
                log.info("second post filter");
            }));
        };
    }

    @Bean
    @Order(1)
    public GlobalFilter c() {
        return (exchange, chain) -> {
            log.info("third pre filter");
            return chain.filter(exchange).then(Mono.fromRunnable(() -> {
                log.info("first post filter");
            }));
        };
    }
}

上記では GlobalFilter が 3 つ定義されており、実行順序は @Order で指定されており、数値が小さいほど優先度が高くなります。以下は出力ログです。ログから実行順序を確認できます:

2018-10-14 12:08:52.406  INFO 55062 --- [ioEventLoop-4-1] c.c.gateway.config.ExampleConfiguration  : first pre filter
2018-10-14 12:08:52.406  INFO 55062 --- [ioEventLoop-4-1] c.c.gateway.config.ExampleConfiguration  : second pre filter
2018-10-14 12:08:52.407  INFO 55062 --- [ioEventLoop-4-1] c.c.gateway.config.ExampleConfiguration  : third pre filter
2018-10-14 12:08:52.437  INFO 55062 --- [ctor-http-nio-7] c.c.gateway.config.ExampleConfiguration  : first post filter
2018-10-14 12:08:52.438  INFO 55062 --- [ctor-http-nio-7] c.c.gateway.config.ExampleConfiguration  : second post filter
2018-10-14 12:08:52.438  INFO 55062 --- [ctor-http-nio-7] c.c.gateway.config.ExampleConfiguration  : third post filter

GlobalFilter に多くのロジックがある場合、それを処理する別の GlobalFilter を作成することをお勧めします。たとえば、 IP にアクセス制限を実装したいのですが、IP ホワイトリストにない場合、リクエストは許可されません。

個別に定義する場合は、GlobalFilter と Ordered の 2 つのインターフェイスを実装するだけで済みます。

@Component
public class IPCheckFilter implements GlobalFilter, Ordered {

    @Override
    public int getOrder() {
        return 0;
    }

    @Override
    public Mono<void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        HttpHeaders headers = exchange.getRequest().getHeaders();
        // 此处写死了，演示用，实际中需要采取配置的方式
        if (getIp(headers).equals("127.0.0.1")) {
            ServerHttpResponse response = exchange.getResponse();
            ResponseData data = new ResponseData();
            data.setCode(401);
            data.setMessage("非法请求");
            byte[] datas = JsonUtils.toJson(data).getBytes(StandardCharsets.UTF_8);
            DataBuffer buffer = response.bufferFactory().wrap(datas);
            response.setStatusCode(HttpStatus.UNAUTHORIZED);
            response.getHeaders().add("Content-Type", "application/json;charset=UTF-8");
            return response.writeWith(Mono.just(buffer));
        }
        return chain.filter(exchange);
    }

    // 这边从请求头中获取用户的实际IP,根据Nginx转发的请求头获取
    private String getIp(HttpHeaders headers) {
        return "127.0.0.1";
    }

}</void>

フィルタリングの使用については、特に言うことはありません。比較的シンプルですが、非常に便利で、多くのニーズに対応できます。上記の IP 認証傍受は氷山の一角にすぎません。詳細関数はフィルターに基づいて自分で実装する必要があります。

たとえば、a/b テストを実行したい場合は、ルーティングおよび転送レベルで作業する必要があります。以前に写真を投稿しました。写真にはデフォルトのグローバル フィルターが多数あり、その中にはルートの選択を担当する LoadBalancerClientFilter サービスのロード フィルターは、loadBalancer を通じて転送サービスを選択し、それを次のルーティング NettyRoutingFilter フィルターに渡して実行し、このメカニズムに基づいて実装できます。

次のメソッドは、Filter 内の次の Filter にデータを渡すために使用されます:

exchange.getAttributes().put(GATEWAY_REQUEST_URL_ATTR, requestUrl);

取得者はそれを直接取得します:

URI requestUrl = exchange.getRequiredAttribute(GATEWAY_REQUEST_URL_ATTR);

ルーティングを変更したい場合は、これを行うことができます:

@Component
public class DebugFilter implements GlobalFilter, Ordered {

    @Override
    public int getOrder() {
        return 10101;
    }

    @Override
    public Mono<void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        try {
            exchange.getAttributes().put(GATEWAY_REQUEST_URL_ATTR, new URI("http://192.168.31.245:8081/house/hello2"));
        } catch (URISyntaxException e) {
            e.printStackTrace();
        }
        return chain.filter(exchange);
    }

}</void>

LoadBalancerClientFilter の次数は 10100 で、これより 1 大きいので、実行後にルーティングされるアドレスを置き換えることができます。

以上がSpring Cloud Gateway グローバル フィルターの概要の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。