网关（Gateway）- 自定义过滤器工厂

自定义过滤工厂类

DemoGatewayFilterFactory

1. package com.learning.springcloud.custom;
3. import org.apache.commons.lang.StringUtils;
4. import org.springframework.cloud.gateway.filter.GatewayFilter;
5. import org.springframework.cloud.gateway.filter.GatewayFilterChain;
6. import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
7. import org.springframework.http.HttpStatus;
8. import org.springframework.stereotype.Component;
9. import org.springframework.web.server.ServerWebExchange;
10. import reactor.core.publisher.Mono;
12. import java.util.Arrays;
13. import java.util.List;
15. @Component
16. public class DemoGatewayFilterFactory extends AbstractGatewayFilterFactory<DemoGatewayFilterFactory.Config> {
18.     public DemoGatewayFilterFactory() {
19.         super(Config.class);
20.     }
22.     public List<String> shortcutFieldOrder() {
23.         return Arrays.asList("name", "value");
24.     }
26.     @Override
27.     public GatewayFilter apply(DemoGatewayFilterFactory.Config config) {
28.         return new GatewayFilter() {
29.             public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
30.                 String value = exchange.getRequest().getQueryParams().getFirst("name");
32.                 if (StringUtils.isBlank(value)) {
33.                     // 为空 则证明是正常的请求 需要放行
34.                     return chain.filter(exchange);
35.                 }
36.                 if ("YES".equals(value)) {
37.                     return chain.filter(exchange);
38.                 }
39.                 exchange.getResponse().setStatusCode(HttpStatus.NOT_FOUND);
40.                 return exchange.getResponse().setComplete();
41.             }
42.         };
43.     }
45.     public static class Config {
46.         private String name;
47.         private String value;
49.         public String getName() {
50.             return name;
51.         }
53.         public void setName(String name) {
54.             this.name = name;
55.         }
57.         public String getValue() {
58.             return value;
59.         }
61.         public void setValue(String name) {
62.             this.value = name;
63.         }
64.     }
65. }

复制代码

过滤器配置说明

1. server:
2.   port: 8088
3. spring:
4.   application:
5.     name: api-gateway
6.   cloud:
7.     nacos:
8.       discovery:
9.         server-addr: 127.0.0.1:8847
10.         username: nacos
11.         password: nacos
12.     gateway:
13.       routes:
14.         - id: order_route # 路由唯一标识
15.           #uri: http://localhost:8020 # 需要转发的地址
16.           uri: lb://order-service # 需要转发的地址
17.           # 断言规则  用于路由规则的匹配
18.           predicates:
19. #            - Path=/order-serv/**
20. #            - After=2024-01-01T23:00:11.518+08:00[Asia/Shanghai]
21. #            - Before=2025-01-01T23:00:11.518+08:00[Asia/Shanghai]
22.             - Between=2024-01-01T23:00:11.518+08:00[Asia/Shanghai],2025-01-01T23:00:11.518+08:00[Asia/Shanghai]
23. #            - Header=X-Request-Id,\d+
24. #            - Host=127.0.0.1
25. #            - Query=name,lq
26. #            - Method=GET,POST
27.             # http://localhost:8088/order-serv/order/add  => http://localhost:8020/order-serv/order/add
28.             - Demo=YES
29.           #配置过滤器工厂
30.           filters:
31.             - StripPrefix=1 # 转发去掉第一层路径
32.             - AddRequestHeader=X-Request-name,tom #添加请求头
33.             - AddRequestParameter=color, blue # 添加请求参数
34.             - PrefixPath=/demo
35. #            - RedirectTo=302, https://www.baidu.com/ #重定向到百度
36.             - Demo=name,YES  # 自定义过滤工厂配置
37.             # http://localhost:8020/order-serv/order/add => http://localhost:8020/order/add

复制代码

访问结果

• 不带name参数的请求放行
  

• 带name参数值不是YES的拦截,返回 not found
  

• 带name参数值是YES的放行
  

实现说明 

• 命名必须必要以 FilterFactory 末端（约定规范）
  
• 继承 AbstractGatewayFilterFactory 类
  
• 必须为spring的组件bean（@Component）
  
• 必须要有内部类 Config 以及 对应的 shortcutFieldOrder 方法
  
• 重写 apply 方法的逻辑 （apply(DemoGatewayFilterFactory.Config config)）
  
• 可通过 exchange.getRequest() 获取到 ServerHttpRequest 对象
  
• 从而获取到请求的参数、请求方式、请求头等信息
  

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。