面试官：SpringCloudGateway过滤器类型有哪些？

在 Spring Cloud Gateway 中，过滤器是在请求到达目标服务之前或之后，执行某些特定操作的一种机制。例如，它可以实现对传入的请求进行验证、修改、日志记录、身份验证、流量控制等各种功能。

在 Spring Cloud Gateway 中，过滤器总共分为以下两大类：

1. 局部过滤器：只作用于某一个路由（route）。
2. 全局过滤器：对所有的路由都有效。
   1. 内置全局过滤器：Spring Cloud Gateway 自带的 30+ 过滤器，详情请访问：https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gatewayfilter-factories
   2. 自定义全局过滤器：开发者自行实现的过滤器。

      1.局部过滤器

      Spring Cloud Gateway 中的局部过滤器配置如下：

      spring:
      cloud:
      gateway:
      routes:
        - id: userservice
          uri: http://192.168.1.7:56628
          predicates:
            - Path=/user/**
          filters:
            - AddResponseHeader=gateway-flag, javacn.site
      

      以上过滤器的含义是在输出对象 Response 中添加 Header 信息，key 为“gateway-flag”，value 为“javacn.site”。

      PS：AddResponseHeader 也是 Gateway 内置过滤器之一。

2.全局过滤器

全局过滤器会对当前网关中的所有路由都生效。

2.1 内置全局过滤器

Spring Cloud Gateway 中的内置全局过滤器配置如下：

spring:
  cloud:
    gateway:
      routes:
        - id: userservice
          uri: http://192.168.1.7:51627
          predicates:
          - Weight=group1,50
        - id: userservice2
          uri: http://192.168.1.7:56628
          predicates:
            - Weight=group1,50
          filters:
            - AddResponseHeader=gateway-flag, javacn.site
      default-filters:
        - AddResponseHeader=gateway-default-filters, www.javacn.site

其中的“default-filters”就是全局内置过滤器，它对所有的路由（route）有效，它的含义是在输出对象 Response 中添加 Header 信息，key 为“gateway-default-filters”，value 为“www.javacn.site”。

2.2 自定义全局过滤器

Spring Cloud Gateway 中自定义全局过滤器的实现是，定义一个类，使用 @Component 注解将其存入 IoC 容器，然后再实现 GlobalFilter 接口，重写 filter 方法，在 filter 中写自己的过滤方法即可，具体实现如下：

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.http.HttpStatus;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.http.server.reactive.ServerHttpResponse;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

@Component
public class AuthFilter implements GlobalFilter, Ordered {
   
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
   
        // 得到 request、response 对象
        ServerHttpRequest request = exchange.getRequest();
        ServerHttpResponse response = exchange.getResponse();
        // 业务逻辑代码
        if(request.getQueryParams().getFirst("auth")==null){
   
            // 权限有问题返回，并结束执行
            response.setStatusCode(HttpStatus.FORBIDDEN);
            return response.setComplete();
        }
        // 此步骤正常，执行下一步
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
   
        // 此值越小越早执行
        return 1;
    }
}

以上代码是验证请求参数中是否有“auth”参数，如果没有的话就认为未登录，调用“response.setComplete()”终止继续执行，反之则认为已经登录，可以执行后续流程了，使用“chain.filter(exchange)”来实现。

课后思考

Spring Cloud Gateway 过滤器底层是如何实现的？

本文已收录到我的面试小站 www.javacn.site，其中包含的内容有：Redis、JVM、并发、并发、MySQL、Spring、Spring MVC、Spring Boot、Spring Cloud、MyBatis、设计模式、消息队列等模块。