如果你觉得我分享的内容或者我的努力对你有帮助,或者你只是想表达对我的支持和鼓励,请考虑给我点赞、评论、收藏。您的鼓励是我前进的动力,让我感到非常感激。
1.3 ThreadLocal
ThreadLocal的作用是提供线程内的局部变量,在多线程环境下访问时能保证各个线程内的ThreadLocal变量各自独立。它的主要作用是在多线程环境下为每个线程提供一个独立的变量副本,使得每个线程在访问 ThreadLocal 时获取到的都是自己的私有变量,而不是共享的同一个变量。换句话说,ThreadLocal 能够隔离线程间的数据共享,提供线程级别的数据存储。
主要用于实例需要在多个方法中共享,但不希望被多线程共享的场景中.
Thread Local的方法:
- 初始化/设置值: ThreadLocal.set(T value) 方法用来设置当前线程的变量副本值。
- 获取值: T get() 方法用来获取当前线程所对应的变量副本的值,如果此线程从未设置过值,那么返回 null 或者初始值(如果有的话)。
- 移除值: remove() 方法用于删除当前线程保存的变量副本,如果不主动清理,可能会造成内存泄露。
ThreadLocal使用注意点:
- 初始化线程中对象,防止空指针异常,方便设置对象属性值, 因为它默认是返回的空;
- 不能用来存储大的对象
- 使用private static final进行修饰,防止多实例时内存泄漏的问题
- 分布式环境不能用ThreadLocal直接传递参数,因为不是同一个JVM;
使用时需要注意的问题:
-
内存泄露: 当线程结束生命周期后,如果没有显式调用 remove() 方法,存储在线程本地变量表中的 ThreadLocal 变量副本不会自动删除,这可能导致它们无法被垃圾回收,尤其是在线程池场景中,如果线程会被复用,这个问题更为突出。
-
线程安全的误解: 虽然 ThreadLocal 保证了每个线程只能访问自己的变量副本,但是它并不能保证变量副本本身的线程安全性,即如果存放在 ThreadLocal 中的对象不是线程安全的,多个线程通过各自的 ThreadLocal 访问相同的非线程安全对象时,还需要采取额外的同步措施。
-
过度使用: 不恰当的使用 ThreadLocal 可能导致代码逻辑变得复杂,增加维护难度,尤其是当线程间本来就需要共享数据时,不应该滥用 ThreadLocal 避免数据交换。
使用中可能出现的事故:
-
内存泄露: 当线程结束生命周期后,如果没有显式调用 remove() 方法,存储在线程本地变量表中的 ThreadLocal 变量副本不会自动删除,这可能导致它们无法被垃圾回收,尤其是在线程池场景中,如果线程会被复用,这个问题更为突出。
-
线程安全的误解: 虽然 ThreadLocal 保证了每个线程只能访问自己的变量副本,但是它并不能保证变量副本本身的线程安全性,即如果存放在 ThreadLocal 中的对象不是线程安全的,多个线程通过各自的 ThreadLocal 访问相同的非线程安全对象时,还需要采取额外的同步措施。
-
过度使用: 不恰当的使用 ThreadLocal 可能导致代码逻辑变得复杂,增加维护难度,尤其是当线程间本来就需要共享数据时,不应该滥用 ThreadLocal 避免数据交换。
1.3.1 简单使用
public static void main(String[] args) {
// 创建两个线程并启动
new Thread(() -> {
// 设置当前线程的ThreadLocal变量
threadLocal.set("Thread A");
System.out.println("In Thread A: " + threadLocal.get());
}).start();
new Thread(() -> {
// 设置当前线程的ThreadLocal变量,不影响其他线程
threadLocal.set("Thread B");
System.out.println("In Thread B: " + threadLocal.get());
// 清理本线程的ThreadLocal变量
threadLocal.remove();
// 此时尝试获取已经移除的ThreadLocal变量,应该返回null
System.out.println("After remove in Thread B: " + threadLocal.get());
}).start();
// 注意:主线程直接调用get()会报空指针异常,因为它没有设置过任何值
// System.out.println("In Main Thread: " + threadLocal.get()); // 这行代码应避免运行,否则可能抛出NullPointerException
}
示例解释:
- 我们首先创建了一个 ThreadLocal 类型的静态变量 threadLocal。
- 在每个线程内部,我们使用 set(String value) 方法给当前线程设置了一个本地变量的值。
- 同样在每个线程内部,我们使用 get() 方法来获取当前线程关联的本地变量的值。注意,每个线程只能获取到自己设置的那个值,相互之间不会干扰。
- 在第二个线程里展示了如何使用 remove() 方法清除当前线程的 ThreadLocal 变量。
1.3.2 复杂使用
场景: 我们模拟同时有100个人发起请求访问某接口,然后输出100次租户id和租户name,即100个线程做同一件事情。事先分析:每个租户都有自己的id和名称,各自独立。最后我们输出租户id和租户名,为了方便演示我们租户名用“杨+线程id”表示。
1.首先我们定义一个租户Tenant 对象
import com.alibaba.fastjson.JSONObject;
import lombok.Data;
@Data
public class Tenant {
private String tenantId;
private String tenantName;
@Override
public String toString () {
return JSONObject.toJSONString(this);
}
}
2 创建一个全局ThreadLocal租户对象,并对租户进行初始化;
public class TenantContext {
// 初始化线程中对象,防止空指针异常,方便设置对象属性值,因为它默认是返回的空;
// 不能用来存储大的对象
// 使用private static final进行修饰,防止多实例时内存泄漏的问题
// 分布式环境不能用ThreadLocal直接传递参数,因为不是同一个JVM;
private static final ThreadLocal<Tenant> threadLocal = new ThreadLocal<Tenant>(){
// 此处一定要对租户初始化实例对象,否则会报空指针异常,默认返回的空。
@Override
protected Tenant initialValue() {
return new Tenant();
}
};
// 定义获取线程中租户静态方法
public static Tenant getTenant(){
return threadLocal.get();
}
// 定义移除线程中的租户静态方法
public static void removeValue(Object key){
Tenant tenant = threadLocal.get();
if(null != tenant){
threadLocal.remove();
}
}
}
3 模拟具体的业务操作:给租户设置tenantId和设置tenantName
/**
* @Description: 为上下文中取出的租户设置tenantId和tenantName
*/
public class TenantIdAction {
// 从上下问获取租户对象,并给租户对象设置id值;id为当前线程的id;
public void setTenantId(){
Tenant tenant = TenantContext.getTenant();
tenant.setTenantId(this.getTenantId());
}
// 用"租户-线程id"来拼接租户名称
public void setTenantName(){
Tenant tenant = TenantContext.getTenant();
String name = "杨" + tenant.getTenantId();
tenant.setTenantName(name);
}
// 获取线程id作为租户id
public String getTenantId(){
return String.valueOf(Thread.currentThread().getId());
}
}
4 模拟前端的访问请求,我们定义线程具体执行逻辑
/**
* @Description: 模拟前端发送请求,进行参数的预封装;
*/
public class HtmlRequest implements Runnable {
private TenantIdAction tenantIdAction = new TenantIdAction();
@Override
public void run() {
// 上下文获取租户对象,此时租户对象为初始化对象,属性均为null;
Tenant tenant = TenantContext.getTenant();
// 模拟前端准备发送请求:开始设置租户的id
tenantIdAction.setTenantId();
tenantIdAction.setTenantName();
System.out.println("tenantId:"+tenant.getTenantId()+" --- "+tenant.getTenantName());
// 每个线程设置完属性以后,要清除掉上下文中的对象,是Tenant实例重新回到初始化状态;
// 可以保证每个线程取到的上下文里的初始对象都是一样的;
TenantContext.removeValue(tenant);
// 因为上一行的已经清空了上下文中的租户对象,所以下面这行代码打印的租户id和name应该都是null;需要看执行效果的同学放开下面代码注释即可。
// System.out.println("remove----tenantId : "+ TenantContext.getTenant().getTenantId() +"name : "+ TenantContext.getTenant().getTenantName());
}
}
5 最后main方法进行测试
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
public class TestTenant {
public static void main(String[] args) {
HtmlRequest htmlRequest = new HtmlRequest();
// 新创建线程,线程id不会出现重复,都是新创建的
for(int i = 1; i <= 100; i++){
new Thread(htmlRequest).start();
}
}
}
另一版参考ThreadLocal来存储用户的登录信息
区别:
// 创建一个ThreadLocal来存放CurrentUserInfo
public class UserContext {
private static final ThreadLocal<CurrentUser> currentUserThreadLocal = new ThreadLocal<>();
public static void setCurrentUser(CurrentUser user) {
currentUserThreadLocal.set(user);
}
public static CurrentUser getCurrentUser() {
return currentUserThreadLocal.get();
}
public static void clearCurrentUser() {
currentUserThreadLocal.remove();
}
}
/ 在登录验证成功后,我们会在登录拦截器或者登录成功的处理逻辑中设置当前用户的上下文:
// 登录成功后设置ThreadLocal
public class LoginInterceptor implements Filter {
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
HttpServletRequest httpServletRequest = (HttpServletRequest) request;
// 假设 authenticate(...) 方法完成了验证并返回了登录用户对象
CurrentUser loggedInUser = authenticate(httpServletRequest);
if (loggedInUser != null) {
UserContext.setCurrentUser(loggedInUser);
}
try {
chain.doFilter(request, response);
} finally {
// 请求处理完毕后清理ThreadLocal,防止内存泄漏
UserContext.clearCurrentUser();
}
}
}
// 在需要用户上下文的地方,可以直接从ThreadLocal中获取:
public class UserService {
public void processUserData() {
CurrentUser currentUser = UserContext.getCurrentUser();
if (currentUser != null) {
// 处理当前登录用户的数据...
}
}
}