Spring Cloud Gateway 自定义过滤器详解

针对这个 Filter 的配置，使用 CustomConfig 定义：

package gateway;

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 管理，所以需要加 @Component 注解
5. getOrder 表示该过滤器的优先级，值越大，优先级越低

配置过滤器

spring:
  cloud:
    gateway:
      routes:
        - id: order-service
          uri: lb://order-service/
          predicates:
            - Path=/order/**,/feign/**
          filters:
            - AddRequestParameter=userName,xiaoming
            - name: Custom
              args:
                name: test_custom

启动服务并访问

自定义 GlobalFilter

GlobalFilter 的实现比较简单，它不需要额外的配置，只需要实现 GlobalFilter 接口，自动会过滤所有的 Filter。

定义 GlobalFilter

package gateway;

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.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

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

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

启动服务并访问

从日志中可以看出，当 GatewayFilter 和 GlobalFilter 过滤器的 order 一样时，会先执行 GatewayFilter，然后再执行 GlobalFilter。其中会先执行 Pre GatewayFilter，然后执行 Pre GlobalFilter，然后执行 Post GlobalFilter，最后执行 Post GatewayFilter。

服务部署

1. 修改数据库、Nacos 等相关配置
2. 对三个服务进行打包：product-service, order-service, gateway
3. 上传 jar 到 Linux 服务器
4. 启动 Nacos 启动前最好把 data 数据删除掉。
5. 启动服务

#后台启动 order-service，并设置输出日志到 logs/order.log
nohup java -jar order-service.jar >logs/order.log &

#后台启动 product-service，并设置输出日志到 logs/product-9090.log
nohup java -jar product-service.jar >logs/product-9090.log &

#启动网关
nohup java -jar gateway.jar >logs/gateway.log &

观察日志：