自定义Spring Cloud Gateway过滤器工厂：实现PrintAnyGatewayFilterFactory

在Spring Cloud Gateway中，除了可以实现全局过滤器外，还可以通过自定义过滤器工厂来实现更加灵活的过滤器配置。本文将带领大家学习如何自定义一个Spring Cloud Gateway过滤器工厂，并具体实现一个打印请求头信息的过滤器工厂。以下是完整代码：

package com.hmall.gateway.filters;

import lombok.Data;
import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.OrderedGatewayFilter;
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
import org.springframework.http.HttpHeaders;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

import java.util.List;

/**
 * @author RaoPengFei
 * @since 2024/7/26
 */
@Component
public class PrintAnyGatewayFilterFactory extends AbstractGatewayFilterFactory<PrintAnyGatewayFilterFactory.Config> {

    public PrintAnyGatewayFilterFactory() {
        super(Config.class);
    }

    @Override
    public GatewayFilter apply(Config config) {
        return new OrderedGatewayFilter(new GatewayFilter() {
            @Override
            public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
                ServerHttpRequest request = exchange.getRequest();
                HttpHeaders headers = request.getHeaders();
                System.out.println("headers000=" + headers);
                return chain.filter(exchange);
            }
        }, 1);
    }

    @Override
    public List<String> shortcutFieldOrder() {
        return List.of("a", "b", "c");
    }

    @Data
    public static class Config {
        private String a;
        private String b;
        private String c;
    }
}

代码解析

1. 包路径及导入依赖

package com.hmall.gateway.filters;

import lombok.Data;
import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.OrderedGatewayFilter;
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
import org.springframework.http.HttpHeaders;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

import java.util.List;

首先，我们定义了过滤器工厂的包路径，并引入了Spring Cloud Gateway和Lombok相关的依赖包。

2. 类定义及注解

@Component
public class PrintAnyGatewayFilterFactory extends AbstractGatewayFilterFactory<PrintAnyGatewayFilterFactory.Config> {

@Component注解表明这个类会被Spring容器自动扫描和管理。PrintAnyGatewayFilterFactory类继承了AbstractGatewayFilterFactory，泛型参数为自定义的配置类Config。

3. 构造方法

public PrintAnyGatewayFilterFactory() {
    super(Config.class);
}

构造方法中调用父类的构造方法，传入配置类Config的类型。

4. 实现apply方法

@Override
public GatewayFilter apply(Config config) {
    return new OrderedGatewayFilter(new GatewayFilter() {
        @Override
        public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
            ServerHttpRequest request = exchange.getRequest();
            HttpHeaders headers = request.getHeaders();
            System.out.println("headers000=" + headers);
            return chain.filter(exchange);
        }
    }, 1);
}

apply方法用于创建具体的过滤器实例，这里我们创建了一个OrderedGatewayFilter，内部包含了一个匿名的GatewayFilter实现。

• 在filter方法中，通过exchange.getRequest()获取到当前的HTTP请求，并通过request.getHeaders()获取请求头信息。
• 打印请求头信息，然后调用chain.filter(exchange)将请求放行，传递给下一个过滤器。

5. 实现shortcutFieldOrder方法

@Override
public List<String> shortcutFieldOrder() {
    return List.of("a", "b", "c");
}

该方法返回配置类中字段的顺序，用于简化配置时的字段映射。

6. 配置类Config

@Data
public static class Config {
    private String a;
    private String b;
    private String c;
}

使用@Data注解生成配置类Config的getter和setter方法。配置类包含了三个字符串字段a、b、c。

配置示例

在Spring Cloud Gateway的配置文件中，我们可以这样配置自定义的过滤器工厂：

spring:
  cloud:
    gateway:
      default-filters:
        - PrintAny=1,2,3

这里我们定义了一个默认过滤器，使用PrintAnyGatewayFilterFactory，并传入了三个参数1、2、3，分别对应配置类Config中的a、b、c。

总结

通过以上代码和配置示例，我们实现了一个自定义的Spring Cloud Gateway过滤器工厂，并在过滤器中打印了请求头信息。自定义过滤器工厂可以极大地增强网关的灵活性，满足各种业务需求。