Spring Cloud Gateway 过滤器工厂详解

接收参数并打印

@Slf4j
@RequestMapping("/feign")
@RestController
public class FeignController {
    @Autowired
    private ProductApi productApi;

    @RequestMapping("test")
    public String test(Integer id, String userName) {
        log.info("userName: " + userName);
        return "接收到参数" + id;
    }
}

启动服务并访问

GatewayFilter 说明

AddRequestHeader GatewayFilter Factory

为当前请求添加 Header

AddRequestHeadersIfNotPresent GatewayFilter Factory

为当前请求添加请求参数

AddResponseHeader GatewayFilter Factory

为响应结果添加 Header

RemoveRequestHeader GatewayFilter Factory

从当前请求删除某个 Header

RemoveResponseHeader GatewayFilter Factory

从响应结果删除某个 Header

RequestRateLimiter GatewayFilter Factory

为当前网关的所有请求执行限流过滤，如果被限流，默认会响应 HTTP429-TooManyRequests。默认提供了 RedisRateLimiter 的限流实现，采用令牌桶算法实现限流功能。

说明：

redis-rate-limiter.replenishRate : 令牌填充速度，即每秒钟允许多少个请求（不丢弃任何请求） redis-rate-limiter.burstCapacity : 令牌桶容量，即每秒用户最大能够执行的请求数量（不丢弃任何请求）。将此值设置为零将阻止所有请求 redis-rate-limiter.requestedTokens : 每次请求占用几个令牌，默认为 1。

Retry GatewayFilter Factory

针对不同的响应进行重试。当后端服务不可用时，网关会根据配置参数来发起重试请求。

说明：

retries: 重试次数，默认为 3 status: HTTP 请求返回的状态码，针对指定状态码进行重试。对应 org.springframework.http.HttpStatus

RequestSize GatewayFilter Factory

设置允许接收最大请求包的大小。如果请求包大小超过设置的值，则返回 413 Payload Too Large。 请求包大小，单位为字节，默认值为 5M

Default Filters

添加一个 filter 并将其应用于所有路由，这个属性需要一个 filter 的列表

Default Filter 的使用

application.yml

server:
  port: 8888
spring:
  application:
    name: gateway
  cloud:
    nacos:
      discovery:
        server-addr: 47.98.109.138:8848
gateway:
  metrics:
    enabled: true
  routes:
    - id: order-service
      uri: lb://order-service/
      predicates:
        - Path=/order/**,/feign/**
      filters:
        - AddRequestParameter=userName,xiaoming
        - name: Custom
          args:
            name: test_custom
    - id: product-service
      uri: lb://product-service/
      predicates:
        - Path=/product/**
      default-filters:
        - name: Retry
          args:
            retries: 3
            statuses: BAD_GATEWAY

设置响应状态码为 BAD_GATEWAY

@RequestMapping("/order")
@RestController
public class OrderController {
    @Autowired
    private OrderService orderService;

    @RequestMapping("/{orderId}")
    public OrderInfo getOrderById(@PathVariable("orderId") Integer orderId, ServerHttpResponse response) {
        response.setStatusCode(BAD_GATEWAY);
        return orderService.selectOrderById(orderId);
    }
}

启动服务并访问

可以看到，一共是四次，第一次时访问，后三次才是 Retry 的次数。

GlobalFilter

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

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

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

GlobalFilter 的使用

添加依赖

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

添加配置

spring:
  cloud:
    gateway:
      metrics:
        enabled: true
  management:
    endpoints:
      web:
        exposure:
          include: "*"
        endpoint:
          health:
            show-details: always
          shutdown:
            enabled: true

启动服务并访问

查看所有监控的信息链接

访问'http://127.0.0.1:8888/actuator'，显示所有监控的信息链接