SpringCloud Gateway 自定义Filter用代码怎么写？别再说我只会配置基本Filter了，来学学如何定制Filter过滤器

学习SpringCloud Gateway

SpringCloud Gateway使用及原理分析大全——断言及过滤器（上篇）
SpringCloud Gateway使用及原理分析大全（下篇）

自定义全局Filter（GlobalFilter）

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.core.io.buffer.DataBuffer;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.server.reactive.ServerHttpResponse;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

import java.nio.charset.StandardCharsets;

/**
 * 作为一个Bean放在容器中即可生效
 * 
 * 注意：Gateway只支持响应式，所有的语法都需要使用响应式的语法
 */
@Component
public class MyFilter implements GlobalFilter, Ordered {

    public static final Logger logger = LoggerFactory.getLogger(SessionIdFilter.class);

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {

        // exchange可以获取到http请求的所有东西
        HttpHeaders headers = exchange.getRequest().getHeaders();
        String uname = exchange.getRequest().getQueryParams().getFirst("uname");

        if(headers == null){
            // 可以手动写回请求，直接拦截住不放行
            ServerHttpResponse response = exchange.getResponse();
            String errorInfo = "{\"code\": 401,\"success\": false}";
            DataBuffer buffer = response.bufferFactory().wrap(errorInfo.getBytes(StandardCharsets.UTF_8));
            response.setStatusCode(HttpStatus.UNAUTHORIZED);
            response.getHeaders().set(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE);
            // 注意，这里如果不需要写信息的话，可以直接return response.setComplete();
            return response.writeWith(Mono.just(buffer));
        }

        // 放行，进入下一个拦截器链
        return chain.filter(exchange);
    }

    /**
     * 优先级顺序，数字越小优先级越高
     */
    @Override
    public int getOrder() {
        return Integer.MIN_VALUE;
    }

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

ServerWebExchange

ServerWebExchange是一个响应式接口类，它提供对HTTP请求和响应的访问，还公开其他与服务器端处理相关的属性和特性，如请求属性。

在这里，你几乎可以拿到所有的请求属性和响应。

自定义非全局Filter（GatewayFilter）

其实，GatewayFilter和GlobalFilter用法是一样的，但是GatewayFilter只能用于限定的路由，比如说可以这样用：

@Bean
public RouteLocator customRouteLocator(RouteLocatorBuilder builder, MyFilter filter) {
    return builder.routes()
            .route(r -> r.host("**.abc.org").and().path("/image/png")
                    .filters(f ->
                            f.filter(filter)) // 此处定义GatewayFilter，不能用GlobalFilter
                    .uri("http://httpbin.org:80")
            )
            .build();
}
1
2
3
4
5
6
7
8
9
10