【Gateway】Gateway Filter Factories

Predicate决定了请求由哪一个路由处理,如果在请求处理前后需要加一些逻辑,这就是Filter(过滤器)的作用范围了.Filter分为两种类型:Pre类型和Post类型

滤器的两种类型

Pre 类型过滤器:
- 执行时机: 在请求被转发到后端服务之前执行。
- 作用: 可以用来执行鉴权、限流、请求日志记录、修改请求头或请求体等操作。
- 常见用途:
  - 鉴权: 验证请求是否合法，是否具有访问权限。
  - 限流: 控制请求的频率，防止服务被过载。
  - 修改请求: 在请求到达后端服务之前，修改请求内容或添加额外的信息。
Post 类型过滤器:
- 执行时机: 在请求执行完成后，将响应返回给客户端之前执行。
- 作用: 可以用来处理响应数据，例如添加响应头、记录响应日志、处理错误等。
- 常见用途:
  - 日志记录: 记录响应时间、状态码等信息，用于监控和分析。
  - 响应处理: 修改响应体或者添加额外的响应头信息。
  - 错误处理: 处理后端服务返回的错误，并返回自定义的错误信息给客户端。

Spring Cloud Gateway 中内置了很多Filter,用于拦截和链式处理web请求,比如权限校验,访问超时等设定.
Spring Cloud Gateway从作用范围上,把Filter可分为GatewayFilter 和GlobalFilter.

GatewayFilter:应用到单个路由或者一个分组的路由上
GlobalFilter: 应用到所有的路由上,也就是对所有的请求生效.

1. GatewayFilter

GatewayFilter 同 Predicate 类似,都是在配置文件 application.yml 中配置，每个过滤器的逻辑都是固定的.比如 AddRequestParameterGatewayFilterFactory 只需要在配置文件中写 AddRequestParameter,就可以为请求添加一个参数.

Spring Cloud Gateway 提供了多种内置的过滤器工厂，以下是一些常用的：

AddRequestHeader Filter：向请求头中添加一个自定义的头部。
AddRequestParameter Filter：向请求中添加一个参数。
AddResponseHeader Filter：向响应头中添加一个自定义的头部。
StripPrefix Filter：移除请求路径中的指定前缀。
RewritePath Filter：重写请求路径。
Retry Filter：在失败时重试请求。
RequestRateLimiter Filter：对请求进行限流。
CircuitBreaker Filter：实现断路器功能。
RedirectTo Filter：将请求重定向到指定的 URL

可以在官方文档学习更多的过滤器类型以及使用方式：AddRequestHeader GatewayFilter Factory :: Spring Cloud Gateway

1.1 快速上手

演示一下使用AddRequestParameter Filter：向请求中添加一个参数。

1. 在application.yml中添加filter

server:
  port: 10040 # 网关端口
spring:
  application:
    name: gateway # 服务名称
  cloud:
    nacos:
      discovery:
        server-addr: 101.42.168.168:8848
        namespace: fcc2c221-085b-4864-bff4-f1f18f734cb0
    gateway:
      routes: # 网关路由配置
        - id: product-service # 路由ID, 自定义, 唯一即可
          uri: lb://product-service # 目标服务地址
          predicates: # 路由条件
            - Path=/product/**
            - After=2024-09-20T17:42:47.789-07:00[America/Denver]
          filters:
            - AddRequestParameter=userName, guanguan
        - id: order-service
          uri: lb://order-service
          predicates:
            - Path=/order/**

现在的filter只添加在了product-service路由下，因此只对product-service路由生效，也就是对/product/**的请求生效。

2. 将添加的参数使用日志打印，便于观察

在 product-service 服务中接收请求的参数,并打印出来


@RestController
@RequestMapping("/product")
public class ProductController {

    @Autowired
    private ProductService productService;

    @RequestMapping("/{productID}")
    public ProductInfo getProductByID(@PathVariable("productID") Integer productID ,String userName){
        System.out.println("收到请求："+ productID);
        System.out.println("userName: "+ userName);
        return productService.getProductMapper(productID);
    }
}

3. 启动服务观察是否成功添加了username参数

访问：http://192.168.5.1:10040/product/1001

2. GlobalFilter

GlobalFilter是Spring Cloud Gateway中的全局过滤器,它和GatewayFilter的作用是相的.GlobalFilter 会应用到所有的路由请求上,全局过滤器通常用于实现与安全性,性能监控和日志记录等相关的全局功能。

官方文档：Global Filters :: Spring Cloud Gateway

Spring Cloud Gateway 内置的全局过滤器也有很多,比如:

Gateway Metrics Filter: 网关指标,提供监控指标
Forward Routing Filter: 用于本地forword,请求不转发到下游服务器
LoadBalancer Client Filter:针对下游服务,实现负载均衡,
......

使用Gateway Metrics Filter:

1. 添加actutator依赖

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

2. 添加配置

3.启动服务

访问http://192.168.5.1:10040/actuator ，显示所有监控信息链接

3. 过滤器执行顺序

项目中,既有GatewayFilter,又有 GlobalFilter时,执行的先后顺序是什么呢?请求路由后,网关会把当前项目中的GatewayFilter和GlobalFilter合并到一个过滤器链(集合)中,并进行排序,依次执行过滤器.

3.1 过滤器顺序控制

Spring Cloud Gateway 中的过滤器顺序是通过实现 Ordered 接口或使用 @Order 注解来控制的。顺序值越小，优先级越高，越早执行。

Filter通过实现Order接⼝或者添加@Order注解来指定order值.
Spring Cloud Gateway提供的Filter由Spring指定. ⽤⼾也可以⾃定义Filter, 由⽤⼾指定.
当过滤器的order值⼀样时, 会按照 defaultFilter > GatewayFilter > GlobalFilter的顺序执⾏.

3.2 内置过滤器的默认顺序

Spring Cloud Gateway 内置的过滤器有默认的顺序。以下是一些常见过滤器的默认顺序，按优先级从高到低排列（值越小优先级越高）：

NettyWriteResponseFilter：-1
NettyRoutingFilter：1
ForwardRoutingFilter：2
WebSocketRoutingFilter：3
LoadBalancerClientFilter：10100
ReactiveLoadBalancerClientFilter：10150
GatewayMetricsFilter：-1000
ForwardPathFilter：0
RemoveCachedBodyFilter：-10
RequestRateLimiterGatewayFilter：1000

4. 自定义过滤器

Spring Cloud Gateway提供了过滤器的扩展功能,开发者可以根据实际业务来自定义过滤器,同样自定义过滤器也支持GatewayFilter和 GlobalFilter两种,

4.1 自定义GatewayFilter

自定义GatewayFilter,需要去实现对应的接口 GatewayFilterFactory,Spring Boot 默认帮我们实现的抽象类是 AbstractGatewayFilterFactory,我们可以直接使用.

1. 自定义GatewayFilter

import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
import org.springframework.core.Ordered;
import org.springframework.stereotype.Service;
import reactor.core.publisher.Mono;


@Service
@Slf4j
public class CustomGatewayFilterFactory extends AbstractGatewayFilterFactory<CustomConfig> implements Ordered {

    public CustomGatewayFilterFactory() {
        super(CustomConfig.class);
    }


    @Override
    public GatewayFilter apply(CustomConfig config) {
        /**
         * Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain)
         *ServerWebExchange: HTTP请求-响应交互的契约, 提供对HTTP请求和响应的访问, 服务器端请求属性, 请求实例,响应实例等, 类似Context⻆⾊
         * GatewayFilterChain: 过滤器链
         *
         *  Mono: Reactor核⼼类, 数据流发布者, Mono最多只触发⼀个事件, 所以可以把Mono ⽤于在异步任务完成时发出通知
         *  Mono.fromRunnable: 创建⼀个包含Runnable元素的数据流
         * */return (exchange, chain) -> {
             log.info("[Pre] Filter Request, name:" + config.getName());
             return chain.filter(exchange).then(Mono.fromRunnable(() -> {
                 log.info("[Post] Response Filter");
             }));
         };
    }


    public int getOrder() {
        return Ordered.LOWEST_PRECEDENCE;
    }


}

针对这个Filter的配置, 使⽤CustomConfig 定义


import lombok.Data;

@Data
public class CustomConfig {
    private String name;
}

注意：

1.类名统一以GatewayFilterFactory结尾,因为默认情况下,过滤器的name会采用该定义类的前缀,这里的name=Custom(yml配置中使用)

2.apply方法中,同时包含Pre和Post过滤,then方法中是请求执行结束之后处理的

3.CustomConfig是一个配置类,该类只有一个属性name,和yml的配置对应

4.该类需要交给Spring管理,所以需要加 @Service 注解

5.getOrder表示该过滤器的优先级,值越大,优先级越低,

2. 配置过滤器

3. 测试

重启服务, 访问接⼝, 观察⽇志 http://127.0.0.1:10040/product/1001

4.2 自定义GlobalFilter

import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.stereotype.Service;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

@Slf4j
@Service
public class CustomGlobalFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("[Pre] CustomGlobalFilter enter...");
         return chain.filter(exchange).then(Mono.fromRunnable(()->{
            log.info("[Post] CustomGlobalFilter return...");
            }));
    }

    @Override
    public int getOrder() {
        return  Ordered.LOWEST_PRECEDENCE;
    }
}

重启服务，访问http://127.0.0.1:10040/product/1001