springboot獲取當(dāng)前用戶信息的三種方式

更新時(shí)間：2024年10月16日 11:10:40 作者：何中應(yīng)

本文詳細(xì)介紹了在開(kāi)發(fā)中獲取當(dāng)前操作用戶信息的三種方式：使用ThreadLocal存儲(chǔ)用戶信息、通過(guò)攔截器和注解結(jié)合Shiro框架獲取用戶信息、以及使用Redis存儲(chǔ)用戶信息,每種方式都有具體的實(shí)現(xiàn)步驟和注意事項(xiàng),可根據(jù)實(shí)際需求選擇合適的方法

方式一：使用ThreadLocal

ThreadLocal本質(zhì)上是一個(gè)Map，鍵是當(dāng)前線程，值是存入的信息。我們可以在用戶登錄，校驗(yàn)用戶信息后，將所需要的用戶信息存入到ThreadLocal中，如用戶ID、用戶Token等，然后在需要的時(shí)候直接使用即可。

如下，在preHandle()方法中，將當(dāng)前用戶的ID存入到TokenThreadLocal對(duì)象中，

@Component
public class TokenInterceptor implements HandlerInterceptor {

    @Value("${token.key}")
    private String tokenKey;

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    
        // 獲取請(qǐng)求頭 拿到Token
        String token = request.getHeader("Token");
        String authToken = request.getHeader("authentication");

        if (StrUtil.isAllEmpty(token,authToken)){
           return responseHandler(response);
        }

        //  校驗(yàn)Token的合法性和有效性
        JWT jwt = JWTUtil.parseToken(StrUtil.isBlank(token) ? authToken : token);

        try {
            // 校驗(yàn)Token是否合法 校驗(yàn)Token是否過(guò)期
            if (!(jwt.setKey(tokenKey.getBytes()).verify() && jwt.validate(0))){
                return responseHandler(response);
            }
        } catch (Exception e) {
            // 拋出自定義異常 Token是非法的
            // throw new RuntimeException(e);
            return responseHandler(response);
        }

        // 把Token的信息解析出來(lái)放到ThreadLocal
        Long id = Convert.toLong(jwt.getPayload("id"));

        // 設(shè)置本地線程池中的用戶ID
        TokenThreadLocal.set(id);
        
        // 放行
        return true;
    }

本地線程對(duì)象，TokenThreadLocal

/**
 * 本地線程對(duì)象
 *
 * 存放用戶ID
 */
public class TokenThreadLocal {

    /**
     * 創(chuàng)建一個(gè)ThreadLocal對(duì)象
     */
    private static final ThreadLocal<Long> THREAD_LOCAL= new ThreadLocal<>();

    /**
     * 添加一個(gè)數(shù)據(jù)
     * @param key
     */
    public static void set(Long key){
        THREAD_LOCAL.set(key);
    }

    /**
     * 獲取一個(gè)數(shù)據(jù)
     * @return
     */
    public static Long get(){
        return THREAD_LOCAL.get();
    }

    /**
     * 刪除一個(gè)數(shù)據(jù)
     */
    public static void remove(){
        THREAD_LOCAL.remove();
    }
}

需要的時(shí)候，直接調(diào)用其get()方法，下面是使用AOP+自定義注解實(shí)現(xiàn)對(duì)創(chuàng)建、更新操作字段的填充；

在這里插入圖片描述

注意，需要在afterCompletion()方法中調(diào)用ThreadLocal的remove()方法，避免內(nèi)存泄漏；

在這里插入圖片描述

方式二：通過(guò)攔截器和相應(yīng)注解實(shí)現(xiàn)

如果項(xiàng)目中，登錄校驗(yàn)框架使用的是Shiro，有一種更方便的方式，如下：

第一步：創(chuàng)建一個(gè)自定義注解，如LoginInfo，表示登錄用戶的信息，注意元注解的屬性；

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 登錄用戶
 * @author 
 */
@Target(value = ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface LoginInfo {
}

第二步：創(chuàng)建MVC的配置類(lèi)，注入一個(gè)在線用戶解析對(duì)象，后面實(shí)現(xiàn)；

import org.decent.modules.integral.resolver.LoginUserArgumentResolver;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import javax.annotation.Resource;
import java.util.List;

/**
 * web設(shè)置
 * @author
 */
@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Resource
    private LoginUserArgumentResolver loginUserArgumentResolver;

    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
        resolvers.add(loginUserArgumentResolver);
    }
}

第三步：創(chuàng)建在線用戶解析類(lèi)，其中獲取當(dāng)前用戶的信息使用的是Shiro框架的方法，SecurityUtils.getSubject().getPrincipal()，該方法返回的是一個(gè)Object類(lèi)型的對(duì)象；

import org.apache.shiro.SecurityUtils;
import org.decent.modules.integral.annotation.LoginInfo;
import org.springframework.core.MethodParameter;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.support.WebDataBinderFactory;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.method.support.ModelAndViewContainer;

/**
 * 登錄解析實(shí)現(xiàn)
 *
 * @author
 */
@Component
public class LoginUserArgumentResolver implements HandlerMethodArgumentResolver {
    @Override
    public boolean supportsParameter(MethodParameter methodParameter) {
        return methodParameter.hasParameterAnnotation(LoginInfo.class);
    }

    @Override
    public Object resolveArgument(MethodParameter methodParameter, ModelAndViewContainer modelAndViewContainer, NativeWebRequest nativeWebRequest, WebDataBinderFactory webDataBinderFactory) throws Exception {
        return SecurityUtils.getSubject().getPrincipal();
    }
}

第四步：創(chuàng)建一個(gè)在線用戶的JavaBean，存放一些可能會(huì)用得上的屬性；

import lombok.Data;

/**
 * 在線用戶信息
 */
@Data
public class LoginUser {

    /**
     * 登錄人id
     */
    private String id;

    /**
     * 登錄人賬號(hào)
     */
    private String username;

    /**
     * 登錄人名字
     */
    private String realname;
}

第五步：在需要使用的接口上，直接使用注解即可。當(dāng)請(qǐng)求訪問(wèn)該接口時(shí)，會(huì)被前面的攔截器攔截住，然后把當(dāng)前用戶的信息取出來(lái)并封裝到JavaBean對(duì)象中，非常方便；

	@PostMapping(value = "/add")
	public Result<?> add(@LoginInfo LoginUser loginUser) {
        ......
	}

方式三：使用Redis存儲(chǔ)用戶信息

這種方式思路和第一種相同，當(dāng)用戶通過(guò)校驗(yàn)時(shí)，將用戶信息查詢出來(lái)并存起來(lái)，需要的時(shí)候再取出來(lái)用。當(dāng)然，使用Redis存儲(chǔ)比ThreadLocal更靈活一點(diǎn)，可以設(shè)置有效時(shí)間。實(shí)現(xiàn)如下：

第一步：登錄驗(yàn)證通過(guò)，將用戶信息存入Redis；

    @PostMapping("/login")
    public Result<?> counterLogin(@RequestBody LoginBody LoginUser){
        // 登錄
        LoginUser userInfo = sysLoginService.login(LoginUser.getUsername(), LoginUser.getPassword(),LoginUser.getCounterType());
        
        // 創(chuàng)建Token并返回
        return Result.success(tokenService.createToken(userInfo));
    }

     @Autowired
    private RedisService redisService;

	// 定義有效時(shí)間，為720 * 60 秒，即12小時(shí)
    private final static long EXPIRE_TIME = 720 * 60;

	/**
     * 創(chuàng)建令牌
     */
    public Map<String, Object> createToken(LoginUser loginUser){
        // 生成token
        String token = IdUtils.fastUUID();
        loginUser.setToken(token);
        loginUser.setUserid(loginUser.getSysUser().getUserId());
        loginUser.setUsername(loginUser.getSysUser().getUserName());

        // 保存用戶token
        Map<String, Object> map = new HashMap<String, Object>();
        map.put("token", token);
        map.put("loginUser",loginUser);

		// 將該用戶的信息存入到Redis中
        redisService.setCacheObject(token, loginUser, EXPIRE_TIME, TimeUnit.SECONDS);
        
        return map;
    }

RedisService類(lèi)相關(guān)方法

/**
 * spring redis 工具類(lèi)
 **/
@Component
public class RedisService{

    @Autowired
    public RedisTemplate redisTemplate;
    
    /**
     * 緩存基本的對(duì)象
     */
    public <T> void setCacheObject(final String key, final T value, final Long timeout, final TimeUnit timeUnit){
        redisTemplate.opsForValue().set(key, value, timeout, timeUnit);
    }

    /**
     * 獲得緩存的基本對(duì)象
     */
    public <T> T getCacheObject(final String key){
        ValueOperations<String, T> operation = redisTemplate.opsForValue();
        return operation.get(key);
    }
}

第三步：需要時(shí)，根據(jù)當(dāng)前用戶的Token，去Redis中取出該用戶的信息；

    /**
     * 根據(jù)用戶Token獲取用戶身份信息
     *
     * @return 用戶信息
     */
    public LoginUser getLoginUser(String token){
        if (StringUtils.isNotEmpty(token)){
            String userKey = getTokenKey(token);
            LoginUser user = redisService.getCacheObject(userKey);
            return user;
        }
        return null;
    }

用戶的Token是需要放在Request對(duì)象里面的，所以可以再寫(xiě)一個(gè)TokenService對(duì)象，用來(lái)獲取當(dāng)前用戶的Token，并調(diào)用RedisService獲取當(dāng)前用戶信息，進(jìn)行進(jìn)一步的封裝。