关于springcloud:gateway使用全局过滤器进行token校验

45次阅读

共计 1971 个字符,预计需要花费 5 分钟才能阅读完成。

引入依赖

<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 不正确");
                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()办法,当有多个过滤器时,这个办法返回的值越小优先级越高。

正文完
 0