spring boot gateway 过滤器的执行顺序

前言

学习官方文档，发现对于过滤器有分为三类

• 默认过滤器
• 自定义过滤
• 全局过滤器

于是就有一个疑问，关于这些过滤器的访问顺序是怎样的，今天就以一个demo来进行测试

准备阶段

过滤器工厂类

以此为模板，复制出几份就可以了，注意打印信息，可区分就行

public class ExampleGatewayFilterFactory extends AbstractGatewayFilterFactory {

    /**
     * 创造出的过滤器的顺序
     */
    private int order;

    /**
     * constructor
     */
    public ExampleGatewayFilterFactory(int order) {
        this.order = order;
    }

    @Override
    public GatewayFilter apply(Object config) {
        return new InnerFilter();
    }

    /**
     * 创建一个内部类，来实现2个接口，指定顺序
     */
    private class InnerFilter implements GatewayFilter, Ordered {

        @Override
        public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
            System.out.println("  pre 自定义过滤器工厂  " + this.getClass().getSimpleName());
            // 在then方法里的，相当于aop中的后置通知
            return chain.filter(exchange).then(Mono.fromRunnable(() -> {
                System.out.println("  post 自定义过滤器工厂 " + this.getClass().getSimpleName());
            }));
        }

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

}

过滤器配置类

这里我们设置了

• 2个默认过滤器
• 2个自定义过滤器，
• 1个全局过滤器

@SpringBootConfiguration
public class FilterConfig {

    // 以下是全局的过滤器(注意这里我们保持它为最高优先级)
    @Bean
    @Order(value = Ordered.HIGHEST_PRECEDENCE)
    public GlobalFilter costFilter(){
        return new CostFilter();
    }

    // 以下是自定义的的过滤器工厂

    @Bean
    public GatewayFilterFactory exampleAGatewayFilterFactory(){
        return new ExampleAGatewayFilterFactory(0);
    }

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

    // 以下是默认过滤工厂

    @Bean
    public GatewayFilterFactory myDefaultGatewayFilterFactory(){
        return new MyDefaultGatewayFilterFactory(2);
    }

    @Bean
    public GatewayFilterFactory myDefaultAAGatewayFilterFactory(){
        return new MyDefaultAAGatewayFilterFactory(3);
    }
}

springboot启动类

// 这里扫描基础包，可以把其他配置加入进来
@SpringBootApplication(scanBasePackages = {"com.example.gateway"})
public class GatewayApplication {

    public static void main(String[] args) {
        SpringApplication.run(GatewayApplication.class, args);
    }

}

application.yml文件的配置

spring:
  application:
    name: demo-gateway
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true
      routes:
        - id: to-route
          uri: lb://demo-consumer
          # 例如访问 localhost:8080/route会路由到demo-consumer的服务下的/route接口
          predicates:
            - Path=/route
        - id: to-account
          uri: lb://demo-consumer
          predicates:
            - Path=/account/v1/**
          filters:
            - name: ExampleA
            - name: Example
      # 默认过滤器
      default-filters:
        - name: MyDefaultAA
        - name: MyDefault

测试

场景一

按照准备阶段的配置order顺序，来看访问的结果

  pre 自定义过滤器工厂 AAAA  InnerFilter
  pre 自定义过滤器工厂  InnerFilter
  pre 【默认】过滤器工厂  InnerFilter
  pre 【默认AAA】过滤器工厂  InnerFilter
  pre 全局过滤器  CostFilter
  post 全局过滤器  CostFilter
  post 【默认AAA】过滤器工厂 InnerFilter
  post 【默认】过滤器工厂 InnerFilter
  post 自定义过滤器工厂 InnerFilter
  post 自定义过滤器工厂 AAAA InnerFilter

过滤器的执行顺序与堆栈这个数据结构很想，LIFO，gateway中的过滤器只有前置和后置2个生命周期，pre中后触发的，在post中就先被执行了

从输出的打印来看，默认过滤器和自定义的过滤器按照我们定义的1 2 3 4的顺序，成功的打印了出来，而全局过滤器是在最后才执行

场景二

自定义过滤器和默认过滤器都保留为相同的order顺序

修改如下，都统一为是0

    @Bean
    public GatewayFilterFactory exampleAGatewayFilterFactory(){
        return new ExampleAGatewayFilterFactory(0);
    }

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

    // 以下是默认过滤工厂

    @Bean
    public GatewayFilterFactory myDefaultGatewayFilterFactory(){
        return new MyDefaultGatewayFilterFactory(0);
    }

    @Bean
    public GatewayFilterFactory myDefaultAAGatewayFilterFactory(){
        return new MyDefaultAAGatewayFilterFactory(0);
    }

返回的结果

  pre 【默认AAA】过滤器工厂  InnerFilter
  pre 【默认】过滤器工厂  InnerFilter
  pre 自定义过滤器工厂 AAAA  InnerFilter
  pre 自定义过滤器工厂  InnerFilter
  pre 全局过滤器  CostFilter
  post 全局过滤器  CostFilter
  post 自定义过滤器工厂 InnerFilter
  post 自定义过滤器工厂 AAAA InnerFilter
  post 【默认】过滤器工厂 InnerFilter
  post 【默认AAA】过滤器工厂 InnerFilter

注意到我们前面在yml中配置的过滤器的顺序是

          filters:
            - name: ExampleA
            - name: Example
      # 默认过滤器
      default-filters:
        - name: MyDefaultAA
        - name: MyDefault

1. 这与前面几行的输出结果一致，所以如果当优先order一样的前提下，默认过滤器的执行优先于自定义过滤器，过滤器的执行顺序是与你在yml中声明的顺序是一致的。
2. 全局过滤器依然是最后一个执行的

场景三

我们将自定义过滤器和默认过滤的顺序按照穿插的来，即

自定义、默认、自定义、默认

    // 以下是自定义的的过滤器工厂

    @Bean
    public GatewayFilterFactory exampleAGatewayFilterFactory(){
        return new ExampleAGatewayFilterFactory(1);
    }

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

    // 以下是默认过滤工厂

    @Bean
    public GatewayFilterFactory myDefaultGatewayFilterFactory(){
        return new MyDefaultGatewayFilterFactory(2);
    }

    @Bean
    public GatewayFilterFactory myDefaultAAGatewayFilterFactory(){
        return new MyDefaultAAGatewayFilterFactory(4);
    }

运行访问后的执行结果如下

  pre 自定义过滤器工厂 AAAA  InnerFilter
  pre 【默认】过滤器工厂  InnerFilter
  pre 自定义过滤器工厂  InnerFilter
  pre 【默认AAA】过滤器工厂  InnerFilter
  pre 全局过滤器  CostFilter
  post 全局过滤器  CostFilter
  post 【默认AAA】过滤器工厂 InnerFilter
  post 自定义过滤器工厂 InnerFilter
  post 【默认】过滤器工厂 InnerFilter
  post 自定义过滤器工厂 AAAA InnerFilter

可以看到它是按照我们书写的顺序来的

---

结论

1. 全局过滤器与其他2类过滤器相比，永远是最后执行的；它的优先级只对其他全局过滤器起作用
2. 当默认过滤器与自定义过滤器的优先级一样时，优先出发默认过滤器，然后才是自定义过滤器；同类型的过滤器，出发顺序与他们在配置文件中声明的顺序一致
3. 默认过滤器与自定义过滤器使用同样的order顺序空间，即他们会按照各自的顺序来进行排序