Spring Cloud Gateway全局过滤器（GlobalFilter）

全局过滤器作用于所有的路由，不需要单独配置，我们可以用它来实现很多统一化处理的业务需求，比如权限认证、IP 访问限制等。

接口定义类 org.springframework.cloud.gateway.filter.GlobalFilter，具体代码如下所示。

1. public interface GlobalFilter {
2. Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
3. }

Spring Cloud Gateway 自带的 GlobalFilter 实现类有很多，如图 1 所示。

图 1 框架自带全局过滤器

 

有转发、路由、负载等相关的 GlobalFilter，感兴趣的朋友可以去看下源码自行了解。我们如何通过定义 GlobalFilter 来实现我们的业务逻辑？

这里给出一个官方文档上的案例，代码如下所示。

1. @Configuration
2. public class ExampleConfiguration {
3. private Logger log = LoggerFactory.getLogger(ExampleConfiguration.class);
4. @Bean
5. @Order(-1)
6. public GlobalFilter a() {
7. return (exchange, chain) -> {
8. log.info("first pre filter");
9. return chain.filter(exchange).then(Mono.fromRunnable(() -> {
10. log.info("third post filter");
11. }));
12. };
13. }
14. @Bean
15. @Order(0)
16. public GlobalFilter b() {
17. return (exchange, chain) -> {
18. log.info("second pre filter");
19. return chain.filter(exchange).then(Mono.fromRunnable(() -> {
20. log.info("second post filter");
21. }));
22. };
23. }
24. @Bean
25. @Order(1)
26. public GlobalFilter c() {
27. return (exchange, chain) -> {
28. log.info("third pre filter");
29. return chain.filter(exchange).then(Mono.fromRunnable(() -> {
30. log.info("first post filter");
31. }));
32. };
33. }
34. }

上面定义了 3 个 GlobalFilter，通过 @Order 来指定执行的顺序，数字越小，优先级越高。下面就是输出的日志，从日志就可以看出执行的顺序，如下所示。

1. 2019-8-26 16:08:52.406 INFO 55062 --- [ioEventLoop-4-1] c.c.gateway.config.ExampleConfiguration : first pre filter
2. 2019-8-26 16:08:52.406 INFO 55062 --- [ioEventLoop-4-1] c.c.gateway.config.ExampleConfiguration : second pre filter
3. 2019-8-26 16:08:52.407 INFO 55062 --- [ioEventLoop-4-1] c.c.gateway.config.ExampleConfiguration : third pre filter
4. 2019-8-26 16:08:52.437 INFO 55062 --- [ctor-http-nio-7] c.c.gateway.config.ExampleConfiguration : first post filter
5. 2019-8-26 16:08:52.438 INFO 55062 --- [ctor-http-nio-7] c.c.gateway.config.ExampleConfiguration : second post filter
6. 2019-8-26 16:08:52.438 INFO 55062 --- [ctor-http-nio-7] c.c.gateway.config.ExampleConfiguration : third post filter

当 GlobalFilter 的逻辑比较多时，笔者还是推荐大家单独写一个 GlobalFilter 来处理，比如我们要实现对 IP 的访问限制，即不在 IP 白名单中就不能调用的需求。

单独定义只需要实现 GlobalFilter、Ordered 两个接口就可以了，具体代码如下所示。

1. @Component
2. public class IPCheckFilter implements GlobalFilter, Ordered {
3. @Override
4. public int getOrder() {
5. return 0;
6. }
7. @Override
8. public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
9. HttpHeaders headers = exchange.getRequest().getHeaders();
10. // 此处写得非常绝对, 只作演示用, 实际中需要采取配置的方式
11. if (getIp(headers).equals("127.0.0.1")) {
12. ServerHttpResponse response = exchange.getResponse();
13. ResponseData data = new ResponseData();
14. data.setCode(401);
15. data.setMessage("非法请求");
16. byte[] datas = JsonUtils.toJson(data).getBytes(StandardCharsets.UTF_8);
17. DataBuffer buffer = response.bufferFactory().wrap(datas);
18. response.setStatusCode(HttpStatus.UNAUTHORIZED);
19. response.getHeaders().add("Content-Type", "application/json;charset=UTF-8");
20. return response.writeWith(Mono.just(buffer));
21. }
22. return chain.filter(exchange);
23. }
24. // 这里从请求头中获取用户的实际IP,根据Nginx转发的请求头获取
25. private String getIp(HttpHeaders headers) {
26. return "127.0.0.1";
27. }
28. }

过滤的使用虽然比较简单，但作用很大，可以处理很多需求，上面讲的 IP 认证拦截只是冰山一角，更多的功能需要我们自己基于过滤器去实现。