Java ThreadLocal 的原理与实现
2021-01-086.1k 阅读
Java ThreadLocal 的原理与实现
一、ThreadLocal 概述
在多线程编程中，我们常常会面临数据共享的问题。一般情况下，多个线程访问共享变量时需要通过同步机制（如 synchronized 关键字）来保证数据的一致性。然而，ThreadLocal 提供了另一种思路：每个线程都拥有自己独立的变量副本，这样各个线程之间的数据相互隔离，避免了线程安全问题。
ThreadLocal 类位于 java.lang 包下，它允许我们创建一个线程局部变量。简单来说，就是每个线程访问 ThreadLocal 变量时，都会获取到属于自己的独立值，即使多个线程同时操作 ThreadLocal，它们之间的数据也不会相互干扰。
二、ThreadLocal 的基本使用
- 示例代码
public class ThreadLocalExample {
// 创建一个 ThreadLocal 实例
private static ThreadLocal<Integer> threadLocal = ThreadLocal.withInitial(() -> 0);
public static void main(String[] args) {
Thread thread1 = new Thread(() -> {
// 获取 ThreadLocal 的值并增加 10
int value = threadLocal.get();
value += 10;
threadLocal.set(value);
System.out.println("Thread1: " + threadLocal.get());
});
Thread thread2 = new Thread(() -> {
// 获取 ThreadLocal 的值并增加 20
int value = threadLocal.get();
value += 20;
threadLocal.set(value);
System.out.println("Thread2: " + threadLocal.get());
});
thread1.start();
thread2.start();
try {
thread1.join();
thread2.join();
} catch (InterruptedException e) {
e.printStackTrace();
}
// 主线程获取 ThreadLocal 的值
System.out.println("Main Thread: " + threadLocal.get());
}
}
在上述代码中：
- 首先创建了一个
ThreadLocal实例threadLocal，并通过withInitial方法设置了初始值为 0。 thread1和thread2分别获取threadLocal的值，进行不同的操作（thread1增加 10，thread2增加 20），然后再设置回去并打印。- 主线程最后获取
threadLocal的值并打印。运行结果可以看到，thread1、thread2和主线程的threadLocal值相互独立，互不影响。
- 常用方法
T get()：返回当前线程中ThreadLocal变量的副本值。如果该线程还没有设置过值，则会调用initialValue方法进行初始化（如果没有通过withInitial设置初始值）。void set(T value)：设置当前线程中ThreadLocal变量的副本值。void remove()：移除当前线程中ThreadLocal变量的副本值。后续调用get方法时，如果没有重新设置值，会重新调用initialValue方法进行初始化。protected T initialValue()：这个方法会在get方法首次调用且线程还没有设置过值时被调用，用于返回初始值。默认返回null，通常我们会通过withInitial方法来设置初始值，或者重写这个方法。
三、ThreadLocal 的原理
- 关键类和数据结构
- ThreadLocalMap：
ThreadLocal类内部有一个静态内部类ThreadLocalMap，它是实现线程局部变量的关键。ThreadLocalMap类似HashMap，用于存储每个线程的ThreadLocal变量副本。它以ThreadLocal实例作为键，以线程对应的变量副本作为值。 - Entry：
ThreadLocalMap中的Entry继承自WeakReference<ThreadLocal<?>>，它存储了ThreadLocal实例（弱引用）和对应的线程局部变量值。
static class ThreadLocalMap {
static class Entry extends WeakReference<ThreadLocal<?>> {
/** The value associated with this ThreadLocal. */
Object value;
Entry(ThreadLocal<?> k, Object v) {
super(k);
value = v;
}
}
// 其他方法和字段
}
- 内存结构关系
每个
Thread实例内部都有一个ThreadLocal.ThreadLocalMap类型的变量threadLocals。当一个线程访问ThreadLocal的get或set方法时，实际上是在操作该线程内部的ThreadLocalMap。
public class Thread implements Runnable {
// 省略其他字段和方法
ThreadLocal.ThreadLocalMap threadLocals = null;
}
- get 方法原理
public T get() {
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if (map != null) {
ThreadLocalMap.Entry e = map.getEntry(this);
if (e != null) {
@SuppressWarnings("unchecked")
T result = (T)e.value;
return result;
}
}
return setInitialValue();
}
- 首先获取当前线程
t。 - 然后通过
getMap(t)方法获取当前线程的ThreadLocalMap，getMap方法实际上就是返回线程的threadLocals变量。 - 如果
ThreadLocalMap不为null，尝试从ThreadLocalMap中获取以当前ThreadLocal实例为键的Entry。如果找到Entry，则返回对应的value。 - 如果
ThreadLocalMap为null或者没有找到对应的Entry，则调用setInitialValue方法进行初始化并返回初始值。
- set 方法原理
public void set(T value) {
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if (map != null)
map.set(this, value);
else
createMap(t, value);
}
- 同样先获取当前线程
t。 - 然后获取当前线程的
ThreadLocalMap。 - 如果
ThreadLocalMap已经存在，则调用map.set(this, value)方法，将当前ThreadLocal实例作为键，value作为值存入ThreadLocalMap中。 - 如果
ThreadLocalMap不存在，则调用createMap(t, value)方法创建一个新的ThreadLocalMap并初始化第一个键值对。
- remove 方法原理
public void remove() {
ThreadLocalMap m = getMap(Thread.currentThread());
if (m != null)
m.remove(this);
}
- 获取当前线程的
ThreadLocalMap。 - 如果
ThreadLocalMap不为null，调用m.remove(this)方法移除当前ThreadLocal实例对应的键值对。
四、ThreadLocal 与内存泄漏问题
- 内存泄漏的产生原因
由于
ThreadLocalMap中的Entry对ThreadLocal的引用是弱引用，当ThreadLocal实例在其他地方不再被强引用时，在垃圾回收时ThreadLocal实例就可能被回收。但是Entry中的value还是被Entry强引用着，如果线程一直存活，value就无法被回收，从而导致内存泄漏。 例如，在一个线程池中，线程可能会被复用，如果在线程执行任务过程中使用了ThreadLocal，并且在任务结束后没有调用remove方法，当ThreadLocal实例不再被其他地方引用时，ThreadLocal可能被回收，但ThreadLocalMap中的value依然存在，随着线程不断复用，可能会导致大量的内存浪费。 - 避免内存泄漏的方法
- 手动调用 remove 方法：在使用完
ThreadLocal后，及时调用remove方法，这样可以在ThreadLocal不再使用时，将ThreadLocalMap中对应的键值对移除，避免内存泄漏。 - 使用 try - finally 块：在涉及到
ThreadLocal的代码块中，使用try - finally块来确保无论代码是否出现异常，remove方法都会被调用。
ThreadLocal<Integer> local = new ThreadLocal<>();
try {
local.set(10);
// 业务逻辑代码
} finally {
local.remove();
}
五、InheritableThreadLocal
- 概念与作用
InheritableThreadLocal是ThreadLocal的子类，它解决了子线程如何继承父线程的ThreadLocal变量的问题。在普通的ThreadLocal中，子线程无法访问父线程的ThreadLocal变量副本。而InheritableThreadLocal使得子线程可以获取到父线程中InheritableThreadLocal变量的初始值。 - 实现原理
Thread类中有一个inheritableThreadLocals变量，类型也是ThreadLocalMap。当创建子线程时，会调用父线程的init方法，在这个方法中会检查父线程的inheritableThreadLocals是否为空，如果不为空，则会将父线程inheritableThreadLocals中的键值对复制到子线程的inheritableThreadLocals中。
private void init(ThreadGroup g, Runnable target, String name,
long stackSize, AccessControlContext acc,
boolean inheritThreadLocals) {
// 省略其他代码
if (inheritThreadLocals && parent.inheritableThreadLocals != null)
this.inheritableThreadLocals =
ThreadLocal.createInheritedMap(parent.inheritableThreadLocals);
// 省略其他代码
}
- 示例代码
public class InheritableThreadLocalExample {
private static InheritableThreadLocal<Integer> inheritableThreadLocal = new InheritableThreadLocal<>() {
@Override
protected Integer initialValue() {
return 10;
}
};
public static void main(String[] args) {
System.out.println("Main Thread: " + inheritableThreadLocal.get());
Thread childThread = new Thread(() -> {
System.out.println("Child Thread: " + inheritableThreadLocal.get());
});
childThread.start();
try {
childThread.join();
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}
在上述代码中，主线程设置了 InheritableThreadLocal 的初始值为 10。子线程启动后，可以获取到主线程中 InheritableThreadLocal 的值并打印。运行结果可以看到，子线程能够访问到父线程的 InheritableThreadLocal 变量值。
六、应用场景
- 数据库连接管理
在多线程的 Web 应用中，每个线程可能需要独立的数据库连接。使用
ThreadLocal可以为每个线程维护一个独立的数据库连接实例，避免了多个线程共享连接带来的线程安全问题。
public class DatabaseConnectionUtil {
private static ThreadLocal<Connection> connectionThreadLocal = ThreadLocal.withInitial(() -> {
try {
return DriverManager.getConnection("jdbc:mysql://localhost:3306/mydb", "root", "password");
} catch (SQLException e) {
throw new RuntimeException(e);
}
});
public static Connection getConnection() {
return connectionThreadLocal.get();
}
public static void closeConnection() {
Connection connection = connectionThreadLocal.get();
if (connection != null) {
try {
connection.close();
} catch (SQLException e) {
e.printStackTrace();
} finally {
connectionThreadLocal.remove();
}
}
}
}
- 事务管理
在一个业务逻辑中，可能涉及多个数据库操作，需要保证这些操作在同一个事务中。通过
ThreadLocal可以在一个线程内共享事务状态，确保整个线程内的数据库操作都在同一个事务上下文内。
public class TransactionManager {
private static ThreadLocal<Boolean> inTransaction = ThreadLocal.withInitial(() -> false);
public static void beginTransaction() {
inTransaction.set(true);
// 开启数据库事务的实际代码
}
public static void commitTransaction() {
if (inTransaction.get()) {
// 提交数据库事务的实际代码
inTransaction.remove();
}
}
public static void rollbackTransaction() {
if (inTransaction.get()) {
// 回滚数据库事务的实际代码
inTransaction.remove();
}
}
}
- 日志记录
在多线程环境下，每个线程可能需要记录自己独立的日志信息。
ThreadLocal可以用于存储每个线程的日志上下文，使得日志记录不会相互混淆。
public class LoggerUtil {
private static ThreadLocal<String> threadLogContext = ThreadLocal.withInitial(() -> "defaultContext");
public static void setLogContext(String context) {
threadLogContext.set(context);
}
public static String getLogContext() {
return threadLogContext.get();
}
public static void logMessage(String message) {
System.out.println("[" + getLogContext() + "] " + message);
}
}
七、性能考虑
- 开销分析
ThreadLocal的操作（get、set、remove）主要涉及到ThreadLocalMap的操作。ThreadLocalMap采用开放地址法解决哈希冲突，相比于HashMap的链地址法，在数据量较小时性能较好。但是，如果ThreadLocal的使用频率非常高，且每个线程中ThreadLocal变量副本占用的内存较大，可能会导致内存占用增加。 - 与同步机制的对比
与使用
synchronized等同步机制相比，ThreadLocal避免了线程间的竞争，在某些场景下性能更好。例如，在每个线程都需要独立操作数据，且数据不需要在多个线程间共享的情况下，ThreadLocal可以避免同步带来的开销。然而，如果数据确实需要在多个线程间共享，并且需要保证数据一致性，synchronized等同步机制仍然是必要的。
在实际应用中，需要根据具体的业务场景和性能需求来选择合适的方案。如果能够确定数据不需要在多个线程间共享，并且每个线程对数据的操作是独立的，ThreadLocal 是一个很好的选择，可以有效提高性能和避免线程安全问题。
通过深入理解 ThreadLocal 的原理与实现，我们可以更好地在多线程编程中利用它来提高程序的性能和稳定性，同时避免可能出现的内存泄漏等问题。无论是在数据库连接管理、事务管理还是日志记录等场景中，ThreadLocal 都能发挥重要作用，为多线程编程提供强大的支持。