Skip to content

Latest commit

 

History

History
113 lines (77 loc) · 4.56 KB

Part02 spring cloud gateway 自定义过滤器.md

File metadata and controls

113 lines (77 loc) · 4.56 KB

spring cloud gateway 自定义过滤器

相关文档

  • 官方文档地址：

    https://docs.spring.io/spring-cloud/docs/current/reference/html/

https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/

  • 示例源码地址：

    /~https://github.com/zfhlm/mrh-example/tree/main/mrh-spring-cloud

网关过滤器扩展方式

  • 编写并注册过滤器工厂

    最简单的过滤器工厂示例：

    public class ExampleGatewayFilterFactory extends AbstractGatewayFilterFactory<NameConfig> {

        private final Log log = LogFactory.getLog("ExampleFilter");

        public ExampleGatewayFilterFactory() {
            super(NameConfig.class);
        }

        // 过滤器名称，不重写默认为当前类名去除“GatewayFilterFactory”之后作为过滤器名称
        @Override
        public String name() {
            return "Example";
        }

        @Override
        public GatewayFilter apply(NameConfig config) {
            return (exchange, chain) -> {
                log.info("example");
                return chain.filter(exchange);
            };
        }

    }

注册为 Spring 管理的 bean：

    @Configuration
    public class GatewayFilterConfiguration {

        @Bean
        public ExampleGatewayFilterFactory exampleGatewayFilterFactory() {
            return new ExampleGatewayFilterFactory();
        }

    }

  • 使用自定义过滤器

    添加 application.yml 配置：

    spring:
      cloud:
        gateway:
          routes:
          - id: api-admin
            predicates:
              - Path=/admin/**
            filters:
              # 添加 Example 过滤器
              - Example
              - StripPrefix=1
            uri: lb://mrh-spring-cloud-api-admin

启动网关和服务，再访问如下地址：

    http://localhost:8081/admin/api/welcome

    -> (接口响应内容：{"errcode":0, "errmsg": "success"})

    -> (控制台输出：ExampleFilter - example)

过滤器执行顺序

  • 网关过滤器类型：

    GlobalFilter                # 全局过滤器，对所有路由生效，官方用于实现路由的转发、负载均衡等逻辑，不建议业务扩展使用

GatewayFilter               # 网关过滤器，一般使用 GatewayFilterFactory 创建 GatewayFilter，业务一般基于此进行扩展

  • 查看网关过滤器执行顺序

    查看源码可以看到具体的实现逻辑：

    org.springframework.cloud.gateway.handler.FilteringWebHandler

网关日志调整为 debug 级别，并发起一次网关请求，日志输出过滤器排序顺序示例：

    2022-06-28 10:55:50.351 DEBUG org.springframework.cloud.gateway.handler.FilteringWebHandler - Sorted gatewayFilterFactories:
    [
      [GatewayFilterAdapter{delegate=org.springframework.cloud.gateway.filter.RemoveCachedBodyFilter@da28d03}, order = -2147483648],
      [GatewayFilterAdapter{delegate=org.springframework.cloud.gateway.filter.AdaptCachedBodyGlobalFilter@23da79eb}, order = -2147482648],
      [GatewayFilterAdapter{delegate=org.springframework.cloud.gateway.filter.NettyWriteResponseFilter@2007435e}, order = -1],
      [GatewayFilterAdapter{delegate=org.springframework.cloud.gateway.filter.ForwardPathFilter@4d157493}, order = 0],
      [[Example], order = 1],
      [[StripPrefix parts = 1], order = 2],
      [GatewayFilterAdapter{delegate=org.springframework.cloud.gateway.filter.RouteToRequestUrlFilter@ebda593}, order = 10000],
      [GatewayFilterAdapter{delegate=org.springframework.cloud.gateway.filter.ReactiveLoadBalancerClientFilter@485caa8f}, order = 10150],
      [GatewayFilterAdapter{delegate=org.springframework.cloud.gateway.filter.LoadBalancerServiceInstanceCookieFilter@2703d91}, order = 10151],
      [GatewayFilterAdapter{delegate=org.springframework.cloud.gateway.filter.WebsocketRoutingFilter@54c622a7}, order = 2147483646],
      [GatewayFilterAdapter{delegate=org.springframework.cloud.gateway.filter.NettyRoutingFilter@5be052ca}, order = 2147483647],
      [GatewayFilterAdapter{delegate=org.springframework.cloud.gateway.filter.ForwardRoutingFilter@5792c08c}, order = 2147483647]
    ]