Spring Cloud Gateway核心之Filter、自定义全局Filter、自定义局部Filter介绍

这篇文章距离上次修改已过195天，其中的内容可能已经有所变动。

Spring Cloud Gateway的Filter提供了一种强大的方式来修改请求和响应。在Spring Cloud Gateway中，Filter分为两种类型：局部Filter（Local Filter）和全局Filter（Global Filter）。

局部Filter：仅对某个路由起作用。
全局Filter：对所有路由都起作用。

自定义全局Filter

自定义全局Filter需要实现GlobalFilter接口。

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

public class MyGlobalFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 在这里编写你的逻辑
        // 比如打印请求的相关信息
        System.out.println("请求路径: " + exchange.getRequest().getPath());

        // 继续执行下一个Filter或处理请求
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
        // 定义filter的执行顺序，数字越小，优先级越高
        return 0;
    }
}

然后将自定义的全局Filter注册到Spring容器中：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class FilterConfig {
    @Bean
    public MyGlobalFilter myGlobalFilter() {
        return new MyGlobalFilter();
    }
}

自定义局部Filter

自定义局部Filter需要实现GatewayFilterFactory接口。

import org.springframework.cloud.gateway.filter.factory.GatewayFilterFactory;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;

@Component
public class MyGatewayFilterFactory implements GatewayFilterFactory {
    @Override
    public GatewayFilter apply(Object config) {
        return (exchange, chain) -> {
            ServerHttpRequest request = exchange.getRequest().mutate()
                .header("MyHeader", "MyValue")
                .build();
            return chain.filter(exchange.mutate().request(request).build());
        };
    }
}

然后在路由配置中使用自定义的局部Filter：

spring:
  cloud:
    gateway:
      routes:
        - id: my_route
          uri: https://example.org
          filters:
            - MyGatewayFilterFactory

以上代码展示了如何创建自定义的全局Filter和局部Filter，并将它们注册到Spring Cloud Gateway中。自定义Filter可以用于权限校验、请求日志记录、流量控制等多种场景。

Spring Cloud Gateway核心之Filter、自定义全局Filter、自定义局部Filter介绍

自定义全局Filter

自定义局部Filter

评论已关闭

推荐阅读