SpringCloudGateway 网关登录校验实现思路_Java

单体架构时我们只需要完成一次用户登录、身份校验，就可以在所有业务中获取到用户信息。而微服务拆分后，每个微服务都独立部署，不再共享数据。也就意味着每个微服务都需要做登录校验，这显然不可取。

1. 思路分析

既然网关是所有微服务的入口，一切请求都需要先经过网关。我们完全可以把登录校验的工作放到网关去做。

不过，这里存在几个问题：

（1）网关路由是配置的，请求转发是gateway内部代码，我们如何在转发之前做登录校验？

可以使用网关过滤器。

（2）网关校验jwt之后，如何将用户信息传递给微服务？

由于网关发送请求到微服务依然采用的是http请求，因此我们可以将用户信息以请求头的方式传递到下游微服务。然后微服务可以从请求头中获取登录用户信息。

（3）微服务之间也会相互调用，这种调用不经过网关，又该如何传递用户信息？

在微服务发起调用时把用户信息存入请求头。

2. 登录校验过滤器

白名单的配置：

在 application.yml 或 application.properties 文件中配置不需要拦截的路径白名单。

gateway:
  ignoreurls:
    - /auth/login
    - /auth/register
    - /public/**

在这个示例中，/auth/login、/auth/register、/public/** 等路径将不需要进行登录校验。

package com.cyt.gateway.filter;
@component // 声明为spring容器中的一个bean
@requiredargsconstructor // 生成构造方法，注入final成员变量
@enableconfigurationproperties(authproperties.class) // 启用配置类authproperties的属性注入
public class authglobalfilter implements globalfilter, ordered {
    // 从配置文件中注入白名单路径列表，用于存放不需要jwt校验的路径
    @value("${gateway.ignoreurls}")
    private list<string> ignoreurls;
    private final jwttool jwttool; // jwt工具类，用于解析和校验jwt
    @override
    public mono<void> filter(serverwebexchange exchange, gatewayfilterchain chain) {
        // 1. 获取request对象，以访问请求的相关信息
        serverhttprequest request = exchange.getrequest();
        // 2. 判断请求路径是否在白名单中（无需jwt校验）
        if (isignoreurl(request.getpath().tostring())) {
            // 路径在白名单中，直接放行请求
            return chain.filter(exchange);
        }
        // 3. 获取请求头中的token（假设token放在"authorization"头部）
        string token = null;
        list<string> headers = request.getheaders().get("authorization");
        if (!collutils.isempty(headers)) { // 如果请求头包含authorization字段
            token = headers.get(0); // 获取第一个token值
        }
        // 4. 使用jwttool校验并解析token
        long userid = null;
        try {
            userid = jwttool.parsetoken(token); // 解析并获取用户id
        } catch (unauthorizedexception e) {
            // 如果token无效或解析失败，则返回401状态码并拦截请求
            serverhttpresponse response = exchange.getresponse();
            response.setrawstatuscode(401);
            return response.setcomplete(); // 返回空的响应结束处理
        }
        // todo 5. 如果token有效，可在此处传递用户信息（如通过exchange.getattributes()）
        system.out.println("userid = " + userid); // 打印用户id供调试
        // 6. 放行请求
        return chain.filter(exchange);
    }
    /**
     * 判断路径是否在白名单中
     *
     * @param path 请求路径
     * @return 如果路径在白名单中返回true，否则返回false
     */
    private boolean isignoreurl(string path) {
        for (string ignoreurl : ignoreurls) {
            // 使用正则匹配白名单路径中的通配符 "**"
            if (path.matches(ignoreurl.replace("**", ".*"))) {
                return true; // 路径匹配白名单中的某一项，返回true
            }
        }
        return false; // 没有匹配到任何白名单路径，返回false
    }
    @override
    public int getorder() {
        return 0; // 设置过滤器优先级，值越小优先级越高
    }
}

3. 保存用户到请求头

5.6.部分代码可以参照下面修改：

// 5.传递用户信息
// 将解析出的用户id转换为字符串，以便可以在请求头中传递
string userinfo = userid.tostring();
// 使用 exchange.mutate() 方法创建一个新的 serverwebexchange 对象，
// 该对象将携带额外的请求头 "user-info"，包含用户id信息。
// .mutate() 方法用于复制当前请求并进行修改。
// 在这里，我们使用 request(builder -> builder.header(...)) 方式为请求添加一个新的头部。
serverwebexchange modifiedexchange = exchange.mutate()
        .request(builder -> builder.header("user-info", userinfo)) // 将 "user-info" 头设置为用户id字符串
        .build(); // 完成新的 serverwebexchange 对象的构建
// 6.放行
// 使用修改后的 serverwebexchange 对象继续执行过滤链。
// 这样，下游服务可以通过 "user-info" 请求头获取到用户id信息。
return chain.filter(modifiedexchange);

4. openfeign传递用户

在微服务发起调用时把用户信息存入请求头。

如何才能让每一个由openfeign发起的请求自动携带登录用户信息呢？

这里要借助feign中提供的一个拦截器接口：feign.requestinterceptor

我们只需要实现这个接口，然后实现apply方法，利用requesttemplate类来添加请求头，将用户信息保存到请求头中。

可以在openfeign的配置类中添加一个bean：

@bean
public requestinterceptor userinforequestinterceptor(){
    // 定义一个 feign 的 requestinterceptor bean，用于在请求发出前执行自定义拦截操作
    return new requestinterceptor() {
        @override
        public void apply(requesttemplate template) {
            // 获取当前登录用户的id
            // usercontext 是一个上下文工具类，用于存储和获取当前线程的用户信息
            long userid = usercontext.getuser();
            // 检查用户id是否为 null，如果为 null 则表示用户未登录或无法获取用户信息
            if(userid == null) {
                // 如果用户id为空，不做任何处理，直接返回，跳过拦截器逻辑
                return;
            }
            // 如果用户id不为空，将用户id作为请求头添加到 feign 请求中
            // "user-info" 是请求头的键，下游微服务可以从该请求头中获取用户id
            template.header("user-info", userid.tostring());
        }
    };
}