通过ThreadLocal存储登录用户信息
前言
项目中经常需要用到登录用户信息,spring项目中可以选择通过ThreadLocal存储登录用户信息。
优点
- 线程隔离:ThreadLocal 能为每个使用它的线程都提供一个独立的变量副本。在多线程环境下,每个线程对 ThreadLocal 变量的操作都是相互独立的,不会相互影响。在存储登录用户信息时,这意味着不同线程可以同时存储和访问各自的登录用户信息,避免了多线程并发访问共享变量时需要进行的同步操作,从而提高了程序的性能和安全性。
- 简化代码:使用 ThreadLocal 可以避免在方法调用过程中频繁传递用户信息。在需要获取登录用户信息的地方,直接从 ThreadLocal 中获取即可,而不需要将用户信息作为参数在各个方法之间传递,使代码更加简洁和易于维护。
- 上下文关联:ThreadLocal 可以将登录用户信息与当前线程关联起来,使得在整个线程的执行过程中,都可以方便地获取到该用户信息。这对于一些需要在多个方法或组件中使用用户信息的场景非常有用,例如权限验证、日志记录等。
- 与请求生命周期一致:通常与web请求的生命周期绑定,请求结束时自动清理
实现细节
1. 基本实现
public class UserContext {private static final ThreadLocal<UserInfo> userHolder = new ThreadLocal<>();public static void setUser(UserInfo user) {userHolder.set(user);}public static UserInfo getUser() {return userHolder.get();}public static void clear() {userHolder.remove();}
}
2. Web应用中的完整实现(以Spring为例)
// 拦截器实现
@Component
public class AuthInterceptor implements HandlerInterceptor {@Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {String token = request.getHeader("Authorization");LoginUser user = authService.verifyToken(token);UserContext.setUser(user);return true;}@Overridepublic void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {UserContext.clear(); // 确保请求结束后清理,避免内存泄漏}
}// 配置拦截器
@Configuration
public class WebConfig implements WebMvcConfigurer {@Autowiredprivate AuthInterceptor authInterceptor;@Overridepublic void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(authInterceptor).addPathPatterns("/api/**").excludePathPatterns("/api/login");}
}
3. 使用示例
@RestController
@RequestMapping("/api/user")
public class UserController {@GetMapping("/profile")public ResponseEntity<UserProfile> getProfile() {LoginUser currentUser = UserContext.getUser();// 使用currentUser进行业务处理...}
}
注意事项
- 内存泄漏风险:
必须确保在请求结束时调用remove()清理
在Web应用中,通常使用拦截器的afterCompletion进行清理
- 线程池问题:
如果使用线程池,线程会被重用,必须确保每次使用前清理旧数据
建议在任务执行前后进行set/remove操作
- 不可变对象:
存储的用户信息最好是不可变对象,避免被意外修改
- 测试考虑:
在单元测试中需要手动设置ThreadLocal或使用Mock
- 异步编程:
在异步场景下(如CompletableFuture),需要手动传递上下文
ThreadLocal是实现请求级上下文信息的轻量级解决方案,特别适合存储登录用户信息这类与请求生命周期一致的数据。