引入依赖

<dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>

为什么不使用拦截器interceptor

使用interceptor需要引入spring-boot-starter-web这个依赖,但是这个依赖会导致gateway服务无法启动,报出No qualifying bean of type 'org.springframework.core.convert.ConversionService' available的异常,原因是gateway不能在tomcat等传统servlet容器中运行,而是需要netty,如果有这个报错则把spring-boot-starter-web依赖去掉即可。

编写过滤器

@Component
@Slf4j
public class AuthFilter implements GlobalFilter, Ordered {

    private AntPathMatcher matcher = new AntPathMatcher();

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        ServerHttpRequest request = exchange.getRequest();
        String path = request.getURI().getPath();
        log.info("请求路径: {}", path);
        if (matcher.match("/api/**/auth/**", path)){
            if (getUserId(request) == null){
                log.error("token不正确");
                return out(exchange.getResponse(), ResultCodeEnum.LOGIN_AUTH);
            }
        }
        return chain.filter(exchange);
    }

    private Long getUserId(ServerHttpRequest request){
        List<String> tokens = request.getHeaders().get("token");
        if (tokens == null || StringUtils.isEmpty(tokens)){
            log.error("请求未携带token");
            return null;
        }
        return JwtUtil.getUserId(tokens.get(0));
    }

    /**
     * api接口鉴权失败返回数据
     * @param response
     * @return
     */
    private Mono<Void> out(ServerHttpResponse response, ResultCodeEnum resultCodeEnum) {
        Result result = Result.build(null, resultCodeEnum);
        byte[] bits = JSONObject.toJSONString(result).getBytes(StandardCharsets.UTF_8);
        DataBuffer buffer = response.bufferFactory().wrap(bits);
        //指定编码,否则在浏览器中会中文乱码
        response.getHeaders().add("Content-Type", "application/json;charset=UTF-8");
        return response.writeWith(Mono.just(buffer));
    }

    @Override
    public int getOrder() {
        return 0;
    }
}

过滤器类需要实现GlobalFilter接口实现filter()方法,当前的http请求对象request通过ServerWebExchange的getRequest()方法获取,request对象的getURI().getPath()方法可以获得请求的地址(例如请求访问localhost:8080/test/name则地址为/test/name)。
使用AntPathMatcher可以使用匹配字符串对请求地址进行匹配,示例中对带auth即需要登录的访问进行了匹配拦截,之后通过request获取header中的token进行token的验证。如果token验证失败,使用out()方法将错误信息输出,这里采用的是将输出对象进行json序列化后再转为bit流输出。
实现Order接口是为了进行过滤器优先级的定义,即实现getOrder()方法,当有多个过滤器时,这个方法返回的值越小优先级越高。

03-05 16:14