最近想实现一些功能,求诸于网络之后,得到了使用 ThreadLocal 实现的方式,那么 ThreadLocal 到底是什么呢 ? 遂写此文,抽丝剥茧的来看一下这个 Java 并发类 。
最近,me 的 gpt 账号没了,所以不能让 gpt 帮 me 美化语言了,大家将就看吧…
一、看看作者怎么说 😏 —— 有什么用篇
(ps:大家再去看这些 Java 原生功能,就别一顿乱搜了呗,当然万能的GPT除外,呜呜呜,JDK 源码里有作者的介绍,看看作者怎么说,可以防止我们走进误区)
作为 ThreadLocal 0基础小白,我带大家读一下哈 …
1. 首先
首先,作者告诉我们,ThreadLocal 提供了一个 thread-local 的变量,也就是以线程为单位的一个线程的局部变量 , 访问这个变量的每个线程都有属于自己的这个变量的副本 。
2. 接着
接着呢,作者告诉我们,这个 ThreadLocal 通常被类定义为 static 的 (为什么定义成 static 的,我们在后面说,现在先大概了解一下),并且这个线程和某些状态相关联,这些状态包括某些用户的 ID 或者 某些事务的 ID 等 。 但是这样直接翻译,我觉得不是很信达雅,我觉得这么说比较好,执行某个操作的线程需要携带某些状态,比如需要携带用户 ID,这时候我们就可以使用 ThreadLocal 。
3. 然后
然后,作者给我们举了个使用例子 。
4. 最后
最后,作者和我们说了一下,ThreadLocal 实例的生命周期,它和持有它的线程共存亡,持有它的线程活着,它就活着,否则,它就会被垃圾回收掉 。
总结
通过上面作者说的话,我们可以大概了解 ThreadLocal 是什么了,下面我尝试用一句话概括 —— ThreadLocal 是我们某个线程独占的变量 , 其可以携带某些状态,这些状态对当前线程有用,我们就带上它,然后它和线程共存亡,线程 g 了, 它被垃圾回收掉 。
(ps : 感觉我说话太不正经了,大家平时别这么说话,给人一种半吊子的感觉 , 会掉印象分的,QWQ)
二、原理篇
我不想带着大家看源码了,源码太长了,这里取几个我觉得重要的点说一下 :
- 每个 Thread 里都有一个ThreadLocal.ThreadLocalMap, 我们定义的 ThreadLocal 变量就存放在这个 map 里,其中 ThreadLocal 对象作为 key, ThreadLocal 对象携带的 value 作为值,形成一个个 Entry —— 之所以共生命周期的原因
- ThreadLocal 在遍历上面的 map 执行 get 和 set 方法时候,会自动帮我们释放 key 为 null 的 value 的空间
三、潜在风险篇
在上文,我们了解到了 ThreadLocal 是什么,以及它的实现原理。然后,我已经决定使用它作为我的当前业务代码的解决方案,所以,我必须做一件事 —— 分析一下是不是可能有潜在风险,不然万一我走了,代码给后人维护,然后突然出了个大 bug,那个方法上面赫然写着我的名字,我可不想我都走了,还要被人骂 …
下面是我画的一张 ThreadLocal 的内存分析图,毕竟一图胜过千言嘛 ~ 但是,要理解下面的图,需要知道以下几个概念 :
- JVM 内存模型中的 栈 和 堆, 栈内存中存放对象的引用,堆内存中存放对象的实例 ,对应下图,ThreadLocal 类的引用和实例, 以及当前线程类的引用和实例 。
- 引用就是指针,虽然 Java 中没有指针的概念,但是可以这么去理解,引用指向实例。
- Java 中对象的引用分为强引用、软引用、弱引用 和 虚引用
- Java 垃圾回收,找到需要回收的对象的方法 —— 可达性分析法,翻译过来就是没有引用的对象直接回收。具有弱引用的对象进行垃圾回收时,扫描到就直接回收。但是,对于强引用,宁可内存溢出也不能回收强引用对象,我们平时创建的普通对象就是强引用的,Java 宁可发生 OOM 也不能释放我们还没用完的强引用对象 。
- 内存泄漏是值:动态分配的堆内存因为某些原因未被释放,但是过多的内存泄漏会导致内存溢出
通过上面的分析,我们可以得出之所以会出现内存泄漏,是因为没有手动释放 value 造成的,所以解决方式也是不要等我们的 ThreadLocal 通过 get 或者 set 自动删除,而是每次都手动 remove
四、尝试用一下
按照作者的推荐,其适合用来为一个线程存放事务ID或者用户ID,从而使得这个ID可以被当前线程所把持,不存在被其他线程修改的线程安全问题 。
功能描述
我的一个业务功能需要获取当前登录的用户的信息,这个用户信息我存放在 Session 中了。我希望可以实现下面的链路 :
所以,我使用 ThreadLocal 来解决,每个请求相当于一个线程,我为这个线程封装好 ThreadLocal, 其 value 是用户相关的信息 。
1. 在当前业务拦截器中将用户信息放入 ThreadLocal
public class CartInterceptor implements HandlerInterceptor {
public static ThreadLocal<UserInfoTO> threadLocal = new ThreadLocal<>();
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
// 获取会话信息,获取登录用户信息
HttpSession session = request.getSession();
MemberResponseVO attribute = (MemberResponseVO) session.getAttribute(AuthConstant.LOGIN_USER);
// 判断是否登录,并封装User对象给controller使用
UserInfoTO user = new UserInfoTO();
if (attribute != null) {
// 登录状态,封装用户ID,供controller使用
user.setUserId(attribute.getId());
}
// 获取当前请求游客用户标识user-key
Cookie[] cookies = request.getCookies();
if (ArrayUtils.isNotEmpty(cookies)) {
for (Cookie cookie : cookies) {
if (cookie.getName().equals(CartConstant.TEMP_USER_COOKIE_NAME)) {
// 获取user-key值封装到user,供controller使用
user.setUserKey(cookie.getValue());
user.setTempUser(true);// 不需要重新分配
break;
}
}
}
// 判断当前是否存在游客用户标识
if (StringUtils.isBlank(user.getUserKey())) {
// 无游客标识,分配游客标识
user.setUserKey(UUID.randomUUID().toString());
}
// 封装用户信息(登录状态userId非空,游客状态userId空)
threadLocal.set(user);
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
UserInfoTO user = threadLocal.get();
if (user != null && !user.isTempUser()) {
// 需要为客户端分配游客信息
Cookie cookie = new Cookie(CartConstant.TEMP_USER_COOKIE_NAME, user.getUserKey());
cookie.setDomain("gulimall.com");// 作用域
cookie.setMaxAge(CartConstant.TEMP_USER_COOKIE_TIMEOUT);// 过期时间
response.addCookie(cookie);
}
}
}
2. 在业务要使用时,拿出 ThreadLocal 中的用户信息进行判断
@Override
public List<CartItemVO> getUserCartItems() {
// 获取当前用户登录的信息
UserInfoTO userInfo = CartInterceptor.threadLocal.get();
if (userInfo.getUserId() == null) {
// 未登录
return null;
} else {
// 已登录,查询redis用户购物车
List<CartItemVO> items = getCartItems(CartConstant.CART_PREFIX + userInfo.getUserId());
if (CollectionUtils.isEmpty(items)) {
throw new CartExceptionHandler();
}
// 筛选所有选中的sku
Map<Long, CartItemVO> itemMap = items.stream().filter(item -> item.getCheck())
.collect(Collectors.toMap(CartItemVO::getSkuId, val -> val));
// 调用远程获取最新价格
Map<Long, BigDecimal> priceMap = productFeignService.getPrice(itemMap.keySet());
// 遍历封装真实价格返回
return itemMap.entrySet().stream().map(entry -> {
CartItemVO item = entry.getValue();
item.setPrice(priceMap.get(entry.getKey()));// 封装真实价格
return item;
}).collect(Collectors.toList());
}
}
思考其他实现方案 对比 ThreadLocal
每次要用到 user 信息的时候,我都去读一遍 Session 然后取出来用 —— 代码冗余量太大,而且多线程并发下,可能会产生线程安全问题 (要进行控制,但是同步之后又会影响并发量)。