当官方提供的过滤器不能满足业务需求,可以自定义路由过滤器。
添加自定过滤器类
自定义过滤器工厂需要注意以下几点:
- 需要声明是Springboot的Bean,添加注解@Component,名称必须以GatewayFilterFactory结尾,这个是命名约束。
- 如果不按照命名约束来命名,那么就会找不到该过滤器工厂。前缀就是配置中配置的断言。
- 可以直接复制Gateway中已经实现的过滤器工厂,修改对应的内容,避免踩坑。
- 继承父类AbstractGatewayFilterFactory,并重写方法。
- 需要定义一个Config静态内部类,来接收断言配置的数据。
- 在重写的shortcutFieldOrder方法中,绑定Config中的属性。传入数组的内容需要与Config中的属性一致。
- 在重写的apply方法中,实现过滤器具体业务逻辑。
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import java.util.Arrays;
import java.util.List;
/**
* @ClassName CustomGatewayFilterFactory
* @Description
* @Author tigerkin
* @Date 2022/3/14 16:24
*/
@Component
public class CustomGatewayFilterFactory extends AbstractGatewayFilterFactory<CustomGatewayFilterFactory.Config> {
/**
* Filter key.
*/
public static final String FILTER_KEY = "filterKey";
/**
* Filter key.
*/
public static final String FILTER_VAL = "filterVal";
private final Logger log = LoggerFactory.getLogger(this.getClass());
public CustomGatewayFilterFactory() {
super(CustomGatewayFilterFactory.Config.class);
}
@Override
public List<String> shortcutFieldOrder() {
return Arrays.asList(FILTER_KEY, FILTER_VAL);
}
@Override
public GatewayFilter apply(CustomGatewayFilterFactory.Config config) {
/**
* 可以是用lamda表达式,也可以new GatewayFilter() {}
*/
return (exchange, chain) -> {
log.info("========> 进入自定义过滤器 key:{} val:{}", config.getFilterKey(), config.getFilterVal());
ServerHttpRequest request = exchange.getRequest();
log.info("========> 请求内容 url:{} method:{} param:{} headers:{}",
request.getURI(), request.getMethodValue(), request.getQueryParams(), request.getHeaders());
return chain.filter(exchange);
};
}
public static class Config {
private String filterKey;
private String filterVal;
public String getFilterKey() {
return filterKey;
}
public void setFilterKey(String filterKey) {
this.filterKey = filterKey;
}
public String getFilterVal() {
return filterVal;
}
public void setFilterVal(String filterVal) {
this.filterVal = filterVal;
}
}
}
配置自定义的过滤器
spring:
cloud:
gateway:
routes:
- id: user-route # 路由ID,唯一标识,自定义命名
uri: lb://gateway-user
predicates:
- Path=/user-server/**
# 自定义的断言工厂,多个参数按逗号(,)隔开,参数对应断言工厂中shortcutFieldOrder方法定义的数组,一一对应。
- CustomVerify=verify, success
filters:
- StripPrefix=1
# 自定义过滤器配置,与断言工厂一致
- Custom=filter, custom
自定义路由过滤配置完成