35.Gateway局部过滤器

局部过滤器

• 局部过滤器是针对单个路由的过滤器。

内置局部过滤器

• 在SpringCloud Gateway中内置了很多不同类型的网关路由过滤器。具体如下：

内置过滤器的使用

server:
  port: 7000
spring:
  application:
    name: api-gateway
  cloud:
    nacos:
      discovery:
        server-addr: 192.168.110.130:8848
    gateway:
      discovery:
        locator:
          enabled: true # 让gateway从nacos中获取服务信息
      routes: # 路由数组[]
        - id: product_route # 当前路由的标识，要求唯一，默认是UUID
          uri: http://localhost:8081 # 请求最终要转发的地址
          order: 1 # 路由的优先级，数字越小代表路由的优先级越高
          predicates:  #断言(条件判断，返回值是Boolean，转发请求要求满足的条件)
            - Path=/product-serv/** # 当请求路径满足path指定的规则时，此路由信息才会正常转发
          filters: # 过滤器（在请求传递过程中 对请求做一些手脚）
            - StripPrefix=1 # 在请求转发之前去掉一层路径
            - SetStatus=250

自定义局部过滤器

• 第1步：在配置文件中，添加一个Log的过滤器配置

server:
  port: 7000
spring:
  application:
    name: api-gateway
  cloud:
    nacos:
      discovery:
        server-addr: 192.168.110.130:8848
    gateway:
      discovery:
        locator:
          enabled: true # 让gateway从nacos中获取服务信息
      routes: # 路由数组[]
        - id: product_route # 当前路由的标识，要求唯一，默认是UUID
          uri: http://localhost:8081 # 请求最终要转发的地址
          order: 1 # 路由的优先级，数字越小代表路由的优先级越高
          predicates:  #断言(条件判断，返回值是Boolean，转发请求要求满足的条件)
            - Path=/product-serv/** # 当请求路径满足path指定的规则时，此路由信息才会正常转发
          filters: # 过滤器（在请求传递过程中 对请求做一些手脚）
            - StripPrefix=1 # 在请求转发之前去掉一层路径
            - Log=true,false # 控制日志是否开启

• 第2步：自定义一个过滤器工厂，实现方法

/**
 * 自定义局部过滤器工厂类
 */
@Component
public class LogGatewayFilterFactory extends AbstractGatewayFilterFactory<LogGatewayFilterFactory.Config> {

    /**
     * 构造器
     */
    public LogGatewayFilterFactory(){
        super(LogGatewayFilterFactory.Config.class);
    }

    /**
     * 读取配置文件中的参数 赋值到 配置类中
     * @return
     */
    @Override
    public List<String> shortcutFieldOrder() {
        return Arrays.asList("consoleLog","cacheLog");
    }

    /**
     * 过滤器逻辑
     * @param config
     * @return
     */
    @Override
    public GatewayFilter apply(LogGatewayFilterFactory.Config config) {
        return new GatewayFilter() {
            @Override
            public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
                if(config.isCacheLog()){
                    System.out.println("cacheLog已经开启...");
                }
                if(config.isConsoleLog()){
                    System.out.println("consoleLog已经开启...");
                }
                return chain.filter(exchange);
            }
        };
    }

    /**
     * 配置类 接收配置参数
     */
    @Data
    @NoArgsConstructor
    public static class Config {
        private boolean consoleLog;
        private boolean cacheLog;
    }
}