ThreadLocal介绍

官方介绍

从Java官方文档中的描述:ThreadLocal类用来提供线程内部的局部变量。这种变量在多线程环境下访问(通过get和set方法访问)时能保证各个线程的变量相对独立于其他线程内的变量。ThreadLocal实例通常来说都是private static类型的,用于关联线程和线程上下文。

我们可以得知 ThreadLocal 的作用是:提供线程内的局部变量,不同的线程之间不会相互干扰,这种变量在线程的生命周期内起作用,减少同一个线程内多个函数或组件之间一些公共变量传递的复杂度。


总结

  1. 线程并发: 在多线程并发的场景下
  2. 传递数据: 我们可以通过ThreadLocal在同一线程,不同组件中传递公共变量
  3. 线程隔离: 每个线程的变量都是独立的,不会互相影响

    基本使用

    常用方法

    | ThreadLocal() | 创建ThreadLocal对象 | | —- | —- | | public void set( T value) | 设置当前线程绑定的局部变量 | | public T get() | 获取当前线程绑定的局部变量 | | public void remove() | 移除当前线程绑定的局部变量 |

使用案例

  1. public class MyDemo {
  2. private String content;
  3. private String getContent() {
  4. return content;
  5. }
  6. private void setContent(String content) {
  7. this.content = content;
  8. }
  9. public static void main(String[] args) {
  10. MyDemo demo = new MyDemo();
  11. for (int i = 0; i < 5; i++) {
  12. Thread thread = new Thread(new Runnable() {
  13. @Override
  14. public void run() {
  15. demo.setContent(Thread.currentThread().getName() + "的数据");
  16. System.out.println("-----------------------");
  17. System.out.println(Thread.currentThread().getName() + "--->" + demo.getContent());
  18. }
  19. });
  20. thread.setName("线程" + i);
  21. thread.start();
  22. }
  23. }
  24. }

结果:
image.png
从结果可以看出多个线程在访问同一个变量的时候出现的异常,线程间的数据没有隔离。下面我们来看下采用 ThreadLocal 的方式来解决这个问题的例子。

  1. public class MyDemo1 {
  2. private static ThreadLocal<String> tl = new ThreadLocal<>();
  3. private String content;
  4. private String getContent() {
  5. return tl.get();
  6. }
  7. private void setContent(String content) {
  8. tl.set(content);
  9. }
  10. public static void main(String[] args) {
  11. MyDemo demo = new MyDemo();
  12. for (int i = 0; i < 5; i++) {
  13. Thread thread = new Thread(new Runnable() {
  14. @Override
  15. public void run() {
  16. demo.setContent(Thread.currentThread().getName() + "的数据");
  17. System.out.println("-----------------------");
  18. System.out.println(Thread.currentThread().getName() + "--->" + demo.getContent());
  19. }
  20. });
  21. thread.setName("线程" + i);
  22. thread.start();
  23. }
  24. }
  25. }

结果:
image.png

ThreadLocal类与synchronized关键字

ThreadLocal与synchronized的区别

虽然ThreadLocal模式与synchronized关键字都用于处理多线程并发访问变量的问题, 不过两者处理问题的角度和思路不同。

synchronized ThreadLocal
原理 同步机制采用’以时间换空间’的方式, 只提供了一份变量,让不同的线程排队访问 ThreadLocal采用’以空间换时间’的方式, 为每一个线程都提供了一份变量的副本,从而实现同时访问而相不干扰
侧重点 多个线程之间访问资源的同步 多线程中让每个线程之间的数据相互隔离

在刚刚的案例中,虽然使用ThreadLocal和synchronized都能解决问题,但是使用ThreadLocal更为合适,因为这样可以使程序拥有更高的并发性。

运用场景

这里我们先构建一个简单的转账场景: 有一个数据表account,里面有两个用户Jack和Rose,用户Jack 给用户Rose 转账。
案例的实现主要用mysql数据库,JDBC 和 C3P0 框架。以下是详细代码:

service层代码 : AccountService

  1. public class AccountService {
  2. public boolean transfer(String outUser, String inUser, int money) {
  3. AccountDao ad = new AccountDao();
  4. try {
  5. // 转出
  6. ad.out(outUser, money);
  7. // 转入
  8. ad.in(inUser, money);
  9. } catch (Exception e) {
  10. e.printStackTrace();
  11. return false;
  12. }
  13. return true;
  14. }
  15. }

dao层代码 : AccountDao

  1. public class AccountDao {
  2. public void out(String outUser, int money) throws SQLException {
  3. String sql = "update account set money = money - ? where name = ?";
  4. Connection conn = JdbcUtils.getConnection();
  5. PreparedStatement pstm = conn.prepareStatement(sql);
  6. pstm.setInt(1,money);
  7. pstm.setString(2,outUser);
  8. pstm.executeUpdate();
  9. JdbcUtils.release(pstm,conn);
  10. }
  11. public void in(String inUser, int money) throws SQLException {
  12. String sql = "update account set money = money + ? where name = ?";
  13. Connection conn = JdbcUtils.getConnection();
  14. PreparedStatement pstm = conn.prepareStatement(sql);
  15. pstm.setInt(1,money);
  16. pstm.setString(2,inUser);
  17. pstm.executeUpdate();
  18. JdbcUtils.release(pstm,conn);
  19. }
  20. }

案例中的转账涉及两个DML操作: 一个转出,一个转入。这些操作是需要具备原子性的,不可分割。不然就有可能出现数据修改异常情况,需要使用事务进行回滚。

  1. public class AccountService {
  2. public boolean transfer(String outUser, String inUser, int money) {
  3. AccountDao ad = new AccountDao();
  4. try {
  5. // 转出
  6. ad.out(outUser, money);
  7. // 模拟转账过程中的异常
  8. int i = 1/0;
  9. // 转入
  10. ad.in(inUser, money);
  11. } catch (Exception e) {
  12. e.printStackTrace();
  13. return false;
  14. }
  15. return true;
  16. }
  17. }

开启事务的注意点:

  • 为了保证所有的操作在一个事务中,案例中使用的连接必须是同一个: service层开启事务的connection需要跟dao层访问数据库的connection保持一致
  • 线程并发情况下, 每个线程只能操作各自的 connection

    常规方案的实现

    基于上面给出的前提, 大家通常想到的解决方案是 :

  • 传参: 从service层将connection对象向dao层传递,通过con进行事务控制

AccountService 类

  1. public class AccountService {
  2. public boolean transfer(String outUser, String inUser, int money) {
  3. AccountDao ad = new AccountDao();
  4. //线程并发情况下,为了保证每个线程使用各自的connection,故加锁
  5. synchronized (AccountService.class) {
  6. Connection conn = null;
  7. try {
  8. conn = JdbcUtils.getConnection();
  9. //开启事务
  10. conn.setAutoCommit(false);
  11. // 转出
  12. ad.out(conn, outUser, money);
  13. // 模拟转账过程中的异常
  14. // int i = 1/0;
  15. // 转入
  16. ad.in(conn, inUser, money);
  17. //事务提交
  18. JdbcUtils.commitAndClose(conn);
  19. } catch (Exception e) {
  20. e.printStackTrace();
  21. //事务回滚
  22. JdbcUtils.rollbackAndClose(conn);
  23. return false;
  24. }
  25. return true;
  26. }
  27. }
  28. }

AccountDao 类 (这里需要注意的是: connection不能在dao层释放,要在service层,不然在dao层释放,service层就无法使用了)

  1. public class AccountDao {
  2. public void out(Connection conn, String outUser, int money) throws SQLException{
  3. String sql = "update account set money = money - ? where name = ?";
  4. //注释从连接池获取连接的代码,使用从service中传递过来的connection
  5. // Connection conn = JdbcUtils.getConnection();
  6. PreparedStatement pstm = conn.prepareStatement(sql);
  7. pstm.setInt(1,money);
  8. pstm.setString(2,outUser);
  9. pstm.executeUpdate();
  10. //连接不能在这里释放,service层中还需要使用
  11. // JdbcUtils.release(pstm,conn);
  12. JdbcUtils.release(pstm);
  13. }
  14. public void in(Connection conn, String inUser, int money) throws SQLException {
  15. String sql = "update account set money = money + ? where name = ?";
  16. // Connection conn = JdbcUtils.getConnection();
  17. PreparedStatement pstm = conn.prepareStatement(sql);
  18. pstm.setInt(1,money);
  19. pstm.setString(2,inUser);
  20. pstm.executeUpdate();
  21. // JdbcUtils.release(pstm,conn);
  22. JdbcUtils.release(pstm);
  23. }
  24. }

上述方式我们看到的确按要求解决了问题,但是仔细观察,会发现这样实现的弊端:
直接从service层传递connection到dao层, 造成代码耦合度提高

ThreadLocal解决方案

像这种需要在项目中进行数据传递线程隔离的场景,我们不妨用ThreadLocal来解决:

工具类的修改: 加入ThreadLocal

  1. public class JdbcUtils {
  2. //ThreadLocal对象 : 将connection绑定在当前线程中
  3. private static final ThreadLocal<Connection> tl = new ThreadLocal();
  4. // c3p0 数据库连接池对象属性
  5. private static final ComboPooledDataSource ds = new ComboPooledDataSource();
  6. // 获取连接
  7. public static Connection getConnection() throws SQLException {
  8. //取出当前线程绑定的connection对象
  9. Connection conn = tl.get();
  10. if (conn == null) {
  11. //如果没有,则从连接池中取出
  12. conn = ds.getConnection();
  13. //再将connection对象绑定到当前线程中
  14. tl.set(conn);
  15. }
  16. return conn;
  17. }
  18. //释放资源
  19. public static void release(AutoCloseable... ios) {
  20. for (AutoCloseable io : ios) {
  21. if (io != null) {
  22. try {
  23. io.close();
  24. } catch (Exception e) {
  25. e.printStackTrace();
  26. }
  27. }
  28. }
  29. }
  30. public static void commitAndClose() {
  31. try {
  32. Connection conn = getConnection();
  33. //提交事务
  34. conn.commit();
  35. //解除绑定
  36. tl.remove();
  37. //释放连接
  38. conn.close();
  39. } catch (SQLException e) {
  40. e.printStackTrace();
  41. }
  42. }
  43. public static void rollbackAndClose() {
  44. try {
  45. Connection conn = getConnection();
  46. //回滚事务
  47. conn.rollback();
  48. //解除绑定
  49. tl.remove();
  50. //释放连接
  51. conn.close();
  52. } catch (SQLException e) {
  53. e.printStackTrace();
  54. }
  55. }
  56. }

AccountService类的修改:不需要传递connection对象

  1. public class AccountService {
  2. public boolean transfer(String outUser, String inUser, int money) {
  3. AccountDao ad = new AccountDao();
  4. try {
  5. Connection conn = JdbcUtils.getConnection();
  6. //开启事务
  7. conn.setAutoCommit(false);
  8. // 转出 : 这里不需要传参了 !
  9. ad.out(outUser, money);
  10. // 模拟转账过程中的异常
  11. // int i = 1 / 0;
  12. // 转入
  13. ad.in(inUser, money);
  14. //事务提交
  15. JdbcUtils.commitAndClose();
  16. } catch (Exception e) {
  17. e.printStackTrace();
  18. //事务回滚
  19. JdbcUtils.rollbackAndClose();
  20. return false;
  21. }
  22. return true;
  23. }
  24. }

AccountDao类的修改:照常使用

ThreadLocal方案的好处

从上述的案例中我们可以看到, 在一些特定场景下,ThreadLocal方案有两个突出的优势:

  1. 传递数据 : 保存每个线程绑定的数据,在需要的地方可以直接获取, 避免参数直接传递带来的代码耦合问题

  2. 线程隔离 : 各线程之间的数据相互隔离却又具备并发性,避免同步方式带来的性能损失


ThreadLocal的内部结构

如果我们不去看源代码的话,可能会猜测ThreadLocal是这样子设计的:每个ThreadLocal都创建一个Map,然后用线程作为Map的key,要存储的局部变量作为Map的value,这样就能达到各个线程的局部变量隔离的效果。这是最简单的设计方法,JDK最早期的ThreadLocal 确实是这样设计的,但现在早已不是了。
image.png
但是,JDK后面优化了设计方案,在JDK8中 ThreadLocal的设计是:每个Thread维护一个ThreadLocalMap,这个Map的key是ThreadLocal实例本身,value才是真正要存储的值Object。

具体的过程是这样的:

  • 每个Thread线程内部都有一个Map (ThreadLocalMap)

  • Map里面存储ThreadLocal对象(key)和线程的变量副本(value)

  • Thread内部的Map是由ThreadLocal维护的,由ThreadLocal负责向map获取和设置线程的变量值。

  • 对于不同的线程,每次获取副本值时,别的线程并不能获取到当前线程的副本值,形成了副本的隔离,互不干扰。

image.png

这样设计的好处

这个设计与我们一开始说的设计刚好相反,这样设计有如下两个优势:

  1. 这样设计之后每个Map存储的Entry数量就会变少。因为之前的存储数量由Thread的数量决定,现在是由ThreadLocal的数量决定。在实际运用当中,往往ThreadLocal的数量要少于Thread的数量。
  2. 当Thread销毁之后,对应的ThreadLocalMap也会随之销毁,能减少内存的使用。


ThreadLocal的核心方法源码

基于ThreadLocal的内部结构,我们继续分析它的核心方法源码,更深入的了解其操作原理。
除了构造方法之外, ThreadLocal对外暴露的方法有以下4个:

方法声明 描述
protected T initialValue() 返回当前线程局部变量的初始值
public void set( T value) 设置当前线程绑定的局部变量
public T get() 获取当前线程绑定的局部变量
public void remove() 移除当前线程绑定的局部变量

set方法

  1. /**
  2. * 设置当前线程对应的ThreadLocal的值
  3. *
  4. * @param value 将要保存在当前线程对应的ThreadLocal的值
  5. */
  6. public void set(T value) {
  7. // 获取当前线程对象
  8. Thread t = Thread.currentThread();
  9. // 获取此线程对象中维护的ThreadLocalMap对象
  10. ThreadLocalMap map = getMap(t);
  11. // 判断map是否存在
  12. if (map != null)
  13. // 存在则调用map.set设置此实体entry
  14. map.set(this, value);
  15. else
  16. // 1)当前线程Thread 不存在ThreadLocalMap对象
  17. // 2)则调用createMap进行ThreadLocalMap对象的初始化
  18. // 3)并将 t(当前线程)和value(t对应的值)作为第一个entry存放至ThreadLocalMap中
  19. createMap(t, value);
  20. }
  21. /**
  22. * 获取当前线程Thread对应维护的ThreadLocalMap
  23. *
  24. * @param t the current thread 当前线程
  25. * @return the map 对应维护的ThreadLocalMap
  26. */
  27. ThreadLocalMap getMap(Thread t) {
  28. return t.threadLocals;
  29. }
  30. /**
  31. *创建当前线程Thread对应维护的ThreadLocalMap
  32. *
  33. * @param t 当前线程
  34. * @param firstValue 存放到map中第一个entry的值
  35. */
  36. void createMap(Thread t, T firstValue) {
  37. //这里的this是调用此方法的threadLocal
  38. t.threadLocals = new ThreadLocalMap(this, firstValue);
  39. }

代码执行流程
A. 首先获取当前线程,并根据当前线程获取对应的ThreadLocalMap
B. 如果获取的ThreadLocalMap不为空,则将参数设置到ThreadLocalMap中(当前ThreadLocal的引用作为key)
C. 如果ThreadLocalMap为空,则给该线程创建 ThreadLocalMap,并设置初始值

get方法

  1. /**
  2. * 返回当前线程中保存ThreadLocal的值
  3. * 如果当前线程没有此ThreadLocal变量,
  4. * 则它会通过调用{@link #initialValue} 方法进行初始化值
  5. *
  6. * @return 返回当前线程对应此ThreadLocal的值
  7. */
  8. public T get() {
  9. // 获取当前线程对象
  10. Thread t = Thread.currentThread();
  11. // 获取此线程对象中维护的ThreadLocalMap对象
  12. ThreadLocalMap map = getMap(t);
  13. // 如果此map存在
  14. if (map != null) {
  15. // 以当前的ThreadLocal 为 key,调用getEntry获取对应的存储实体e
  16. ThreadLocalMap.Entry e = map.getEntry(this);
  17. // 对e进行判空
  18. if (e != null) {
  19. @SuppressWarnings("unchecked")
  20. // 获取存储实体 e 对应的 value值
  21. // 即为我们想要的当前线程对应此ThreadLocal的值
  22. T result = (T)e.value;
  23. return result;
  24. }
  25. }
  26. /*
  27. 初始化 : 有两种情况有执行当前代码
  28. 第一种情况: map不存在,表示此线程没有维护的ThreadLocalMap对象
  29. 第二种情况: map存在, 但是没有与当前ThreadLocal关联的entry
  30. */
  31. return setInitialValue();
  32. }
  33. /**
  34. * 初始化
  35. *
  36. * @return the initial value 初始化后的值
  37. */
  38. private T setInitialValue() {
  39. // 调用initialValue获取初始化的值
  40. // 此方法可以被子类重写, 如果不重写默认返回null
  41. T value = initialValue();
  42. // 获取当前线程对象
  43. Thread t = Thread.currentThread();
  44. // 获取此线程对象中维护的ThreadLocalMap对象
  45. ThreadLocalMap map = getMap(t);
  46. // 判断map是否存在
  47. if (map != null)
  48. // 存在则调用map.set设置此实体entry
  49. map.set(this, value);
  50. else
  51. // 1)当前线程Thread 不存在ThreadLocalMap对象
  52. // 2)则调用createMap进行ThreadLocalMap对象的初始化
  53. // 3)并将 t(当前线程)和value(t对应的值)作为第一个entry存放至ThreadLocalMap中
  54. createMap(t, value);
  55. // 返回设置的值value
  56. return value;
  57. }

代码执行流程

A. 首先获取当前线程, 根据当前线程获取一个Map

B. 如果获取的Map不为空,则在Map中以ThreadLocal的引用作为key来在Map中获取对应的Entry e,否则转到D

C. 如果e不为null,则返回e.value,否则转到D

D. Map为空或者e为空,则通过initialValue函数获取初始值value,然后用ThreadLocal的引用和value作为firstKey和firstValue创建一个新的Map

总结: 先获取当前线程的 ThreadLocalMap 变量,如果存在则返回值,不存在则创建并返回初始值。

remove方法

  1. /**
  2. * 删除当前线程中保存的ThreadLocal对应的实体entry
  3. */
  4. public void remove() {
  5. // 获取当前线程对象中维护的ThreadLocalMap对象
  6. ThreadLocalMap m = getMap(Thread.currentThread());
  7. // 如果此map存在
  8. if (m != null)
  9. // 存在则调用map.remove
  10. // 以当前ThreadLocal为key删除对应的实体entry
  11. m.remove(this);
  12. }

代码执行流程
A. 首先获取当前线程,并根据当前线程获取一个Map

B. 如果获取的Map不为空,则移除当前ThreadLocal对象对应的entry

initialValue方法

  1. /**
  2. * 返回当前线程对应的ThreadLocal的初始值
  3. * 此方法的第一次调用发生在,当线程通过get方法访问此线程的ThreadLocal值时
  4. * 除非线程先调用了set方法,在这种情况下,initialValue 才不会被这个线程调用。
  5. * 通常情况下,每个线程最多调用一次这个方法。
  6. *
  7. * <p>这个方法仅仅简单的返回null {@code null};
  8. * 如果程序员想ThreadLocal线程局部变量有一个除null以外的初始值,
  9. * 必须通过子类继承{@code ThreadLocal} 的方式去重写此方法
  10. * 通常, 可以通过匿名内部类的方式实现
  11. *
  12. * @return 当前ThreadLocal的初始值
  13. */
  14. protected T initialValue() {
  15. return null;
  16. }

此方法的作用是 返回该线程局部变量的初始值。

(1) 这个方法是一个延迟调用方法,从上面的代码我们得知,在set方法还未调用而先调用了get方法时才执行,并且仅执行1次。

(2)这个方法缺省实现直接返回一个null。

(3)如果想要一个除null之外的初始值,可以重写此方法。(备注: 该方法是一个protected的方法,显然是为了让子类覆盖而设计的)

ThreadLocalMap源码分析

在分析ThreadLocal方法的时候,我们了解到ThreadLocal的操作实际上是围绕ThreadLocalMap展开的。ThreadLocalMap的源码相对比较复杂, 我们从以下三个方面进行讨论。

基本结构

ThreadLocalMap是ThreadLocal的内部类,没有实现Map接口,用独立的方式实现了Map的功能,其内部的Entry也是独立实现。
image.png

成员变量

  1. /**
  2. * 初始容量 —— 必须是2的整次幂
  3. */
  4. private static final int INITIAL_CAPACITY = 16;
  5. /**
  6. * 存放数据的table,Entry类的定义在下面分析
  7. * 同样,数组长度必须是2的整次幂。
  8. */
  9. private Entry[] table;
  10. /**
  11. * 数组里面entrys的个数,可以用于判断table当前使用量是否超过阈值。
  12. */
  13. private int size = 0;
  14. /**
  15. * 进行扩容的阈值,表使用量大于它的时候进行扩容。
  16. */
  17. private int threshold; // Default to 0

跟HashMap类似,INITIAL_CAPACITY代表这个Map的初始容量;table 是一个Entry 类型的数组,用于存储数据;size 代表表中的存储数目; threshold 代表需要扩容时对应 size 的阈值。

存储结构 - Entry

  1. /*
  2. * Entry继承WeakReference,并且用ThreadLocal作为key.
  3. * 如果key为null(entry.get() == null),意味着key不再被引用,
  4. * 因此这时候entry也可以从table中清除。
  5. */
  6. static class Entry extends WeakReference<ThreadLocal<?>> {
  7. /** The value associated with this ThreadLocal. */
  8. Object value;
  9. Entry(ThreadLocal<?> k, Object v) {
  10. super(k);
  11. value = v;
  12. }
  13. }

在ThreadLocalMap中,也是用Entry来保存K-V结构数据的。不过Entry中的key只能是ThreadLocal对象,这点在构造方法中已经限定死了。

另外,Entry继承WeakReference,也就是key(ThreadLocal)是弱引用。

弱引用和内存泄漏

如果key使用强引用

假设ThreadLocalMap中的key使用了强引用,那么会出现内存泄漏吗?
此时ThreadLocal的内存图(实线表示强引用)如下:
image.png
假设在业务代码中使用完ThreadLocal ,threadLocal Ref被回收了。

但是因为threadLocalMap的Entry强引用了threadLocal,造成threadLocal无法被回收。

在没有手动删除这个Entry以及CurrentThread依然运行的前提下,始终有强引用链 threadRef->currentThread->threadLocalMap->entry,Entry就不会被回收(Entry中包括了ThreadLocal实例和value),导致Entry内存泄漏。

也就是说,ThreadLocalMap中的key使用了强引用, 是无法完全避免内存泄漏的。


如果key使用弱引用

那么ThreadLocalMap中的key使用了弱引用,会出现内存泄漏吗?
此时ThreadLocal的内存图(实线表示强引用,虚线表示弱引用)如下:
image.png
同样假设在业务代码中使用完ThreadLocal ,threadLocal Ref被回收了。

由于ThreadLocalMap只持有ThreadLocal的弱引用,没有任何强引用指向threadlocal实例, 所以threadlocal就可以顺利被gc回收,此时Entry中的key=null。

但是在没有手动删除这个Entry以及CurrentThread依然运行的前提下,也存在有强引用链 threadRef->currentThread->threadLocalMap->entry -> value ,value不会被回收, 而这块value永远不会被访问到了,导致value内存泄漏。

也就是说,ThreadLocalMap中的key使用了弱引用, 也有可能内存泄漏。

出现内存泄漏的真实原因

比较以上两种情况,我们就会发现,内存泄漏的发生跟ThreadLocalMap中的key是否使用弱引用是没有关系的。那么内存泄漏的的真正原因是什么呢?

细心的同学会发现,在以上两种内存泄漏的情况中,都有两个前提:

没有手动删除这个Entry
CurrentThread依然运行
第一点很好理解,只要在使用完ThreadLocal,调用其remove方法删除对应的Entry,就能避免内存泄漏。

第二点稍微复杂一点, 由于ThreadLocalMap是Thread的一个属性,被当前线程所引用,所以它的生命周期跟Thread一样长。那么在使用完ThreadLocal之后,如果当前Thread也随之执行结束,ThreadLocalMap自然也会被gc回收,从根源上避免了内存泄漏。

综上,ThreadLocal内存泄漏的根源是:由于ThreadLocalMap的生命周期跟Thread一样长,如果没有手动删除对应key就会导致内存泄漏。

为什么使用弱引用

根据刚才的分析, 我们知道了: 无论ThreadLocalMap中的key使用哪种类型引用都无法完全避免内存泄漏,跟使用弱引用没有关系。

要避免内存泄漏有两种方式:

使用完ThreadLocal,调用其remove方法删除对应的Entry

使用完ThreadLocal,当前Thread也随之运行结束

相对第一种方式,第二种方式显然更不好控制,特别是使用线程池的时候,线程结束是不会销毁的。

也就是说,只要记得在使用完ThreadLocal及时的调用remove,无论key是强引用还是弱引用都不会有问题。那么为什么key要用弱引用呢?

事实上,在ThreadLocalMap中的set/getEntry方法中,会对key为null(也即是ThreadLocal为null)进行判断,如果为null的话,那么是会对value置为null的。

这就意味着使用完ThreadLocal,CurrentThread依然运行的前提下,就算忘记调用remove方法,弱引用比强引用可以多一层保障:弱引用的ThreadLocal会被回收,对应的value在下一次ThreadLocalMap调用set,get,remove中的任一方法的时候会被清除,从而避免内存泄漏。

hash冲突的解决

hash冲突的解决是Map中的一个重要内容。我们以hash冲突的解决为线索,来研究一下ThreadLocalMap的核心源码。

首先从ThreadLocal的set() 方法入手

  1. public void set(T value) {
  2. Thread t = Thread.currentThread();
  3. ThreadLocal.ThreadLocalMap map = getMap(t);
  4. if (map != null)
  5. //调用了ThreadLocalMap的set方法
  6. map.set(this, value);
  7. else
  8. createMap(t, value);
  9. }
  10. ThreadLocal.ThreadLocalMap getMap(Thread t) {
  11. return t.threadLocals;
  12. }
  13. void createMap(Thread t, T firstValue) {
  14. //调用了ThreadLocalMap的构造方法
  15. t.threadLocals = new ThreadLocal.ThreadLocalMap(this, firstValue);
  16. }

这个方法我们刚才分析过, 其作用是设置当前线程绑定的局部变量 :

A. 首先获取当前线程,并根据当前线程获取一个Map

B. 如果获取的Map不为空,则将参数设置到Map中(当前ThreadLocal的引用作为key)
(这里调用了ThreadLocalMap的set方法)

C. 如果Map为空,则给该线程创建 Map,并设置初始值
(这里调用了ThreadLocalMap的构造方法)
这段代码有两个地方分别涉及到ThreadLocalMap的两个方法, 我们接着分析这两个方法。

构造方法ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue)

  1. /*
  2. * firstKey : 本ThreadLocal实例(this)
  3. * firstValue : 要保存的线程本地变量
  4. */
  5. ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
  6. //初始化table
  7. table = new ThreadLocal.ThreadLocalMap.Entry[INITIAL_CAPACITY];
  8. //计算索引(重点代码)
  9. int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
  10. //设置值
  11. table[i] = new ThreadLocal.ThreadLocalMap.Entry(firstKey, firstValue);
  12. size = 1;
  13. //设置阈值
  14. setThreshold(INITIAL_CAPACITY);
  15. }

构造函数首先创建一个长度为16的Entry数组,然后计算出firstKey对应的索引,然后存储到table中,并设置size和threshold。

重点分析: int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1)。

关于firstKey.threadLocalHashCode:

  1. private final int threadLocalHashCode = nextHashCode();
  2. private static int nextHashCode() {
  3. return nextHashCode.getAndAdd(HASH_INCREMENT);
  4. }
  5. //AtomicInteger是一个提供原子操作的Integer类,通过线程安全的方式操作加减,适合高并发情况下的使用
  6. private static AtomicInteger nextHashCode = new AtomicInteger();
  7. //特殊的hash值
  8. private static final int HASH_INCREMENT = 0x61c88647;

这里定义了一个AtomicInteger类型,每次获取当前值并加上HASH_INCREMENT,HASH_INCREMENT = 0x61c88647,这个值跟斐波那契数列(黄金分割数)有关,其主要目的就是为了让哈希码能均匀的分布在2的n次方的数组里, 也就是Entry[] table中,这样做可以尽量避免hash冲突。


关于& (INITIAL_CAPACITY - 1)
计算hash的时候里面采用了hashCode & (size - 1)的算法,这相当于取模运算hashCode % size的一个更高效的实现。正是因为这种算法,我们要求size必须是2的整次幂,这也能保证在索引不越界的前提下,使得hash发生冲突的次数减小。

ThreadLocalMap中的set方法

  1. private void set(ThreadLocal<?> key, Object value) {
  2. ThreadLocal.ThreadLocalMap.Entry[] tab = table;
  3. int len = tab.length;
  4. //计算索引(重点代码,刚才分析过了)
  5. int i = key.threadLocalHashCode & (len-1);
  6. /**
  7. * 使用线性探测法查找元素(重点代码)
  8. */
  9. for (ThreadLocal.ThreadLocalMap.Entry e = tab[i];
  10. e != null;
  11. e = tab[i = nextIndex(i, len)]) {
  12. ThreadLocal<?> k = e.get();
  13. //ThreadLocal 对应的 key 存在,直接覆盖之前的值
  14. if (k == key) {
  15. e.value = value;
  16. return;
  17. }
  18. // key为 null,但是值不为 null,说明之前的 ThreadLocal 对象已经被回收了,
  19. // 当前数组中的 Entry 是一个陈旧(stale)的元素
  20. if (k == null) {
  21. //用新元素替换陈旧的元素,这个方法进行了不少的垃圾清理动作,防止内存泄漏
  22. replaceStaleEntry(key, value, i);
  23. return;
  24. }
  25. }
  26. //ThreadLocal对应的key不存在并且没有找到陈旧的元素,则在空元素的位置创建一个新的Entry。
  27. tab[i] = new Entry(key, value);
  28. int sz = ++size;
  29. /**
  30. * cleanSomeSlots用于清除那些e.get()==null的元素,
  31. * 这种数据key关联的对象已经被回收,所以这个Entry(table[index])可以被置null。
  32. * 如果没有清除任何entry,并且当前使用量达到了负载因子所定义(长度的2/3),那么进行 * rehash(执行一次全表的扫描清理工作)
  33. */
  34. if (!cleanSomeSlots(i, sz) && sz >= threshold)
  35. rehash();
  36. }
  37. /**
  38. * 获取环形数组的下一个索引
  39. */
  40. private static int nextIndex(int i, int len) {
  41. return ((i + 1 < len) ? i + 1 : 0);
  42. }

代码执行流程:

A. 首先还是根据key计算出索引 i,然后查找i位置上的Entry,

B. 若是Entry已经存在并且key等于传入的key,那么这时候直接给这个Entry赋新的value值,

C. 若是Entry存在,但是key为null,则调用replaceStaleEntry来更换这个key为空的Entry,

D. 不断循环检测,直到遇到为null的地方,这时候要是还没在循环过程中return,那么就在这个null的位置新建一个Entry,并且插入,同时size增加1。

最后调用cleanSomeSlots,清理key为null的Entry,最后返回是否清理了Entry,接下来再判断sz 是否>= thresgold达到了rehash的条件,达到的话就会调用rehash函数执行一次全表的扫描清理。

重点分析 : ThreadLocalMap使用线性探测法来解决哈希冲突的。

该方法一次探测下一个地址,直到有空的地址后插入,若整个空间都找不到空余的地址,则产生溢出。

举个例子,假设当前table长度为16,也就是说如果计算出来key的hash值为14,如果table[14]上已经有值,并且其key与当前key不一致,那么就发生了hash冲突,这个时候将14加1得到15,取table[15]进行判断,这个时候如果还是冲突会回到0,取table[0],以此类推,直到可以插入。

按照上面的描述,可以把Entry[] table看成一个环形数组。

说说ThreadLocal ,ThreadLocalMap 和Thread 的关系?

image.png

为什么ThreadLocalMap 设计为ThreadLocal 内部类

image.png
主要是说明ThreadLocalMap 是一个线程本地的值,它所有的方法都是private 的,也就意味着除了ThreadLocal 这个类,其他类是不能操作ThreadLocalMap 中的任何方法的,这样就可以对其他类是透明的。同时这个类的权限是包级别的,也就意味着只有同一个包下面的类才能引用ThreadLocalMap 这个类,这也是Thread 为什么可以引用ThreadLocalMap 的原因,因为他们在同一个包下面。
虽然Thread 可以引用ThreadLocalMap,但是不能调用任何ThreadLocalMap 中的方法。这也就是我们平时都是通过ThreadLocal 来获取值和设置值,看下以下代码

  1. public T get() {
  2. //这里通过获取当前的线程
  3. Thread t = Thread.currentThread();
  4. //通过线程来获取ThreadLocalMap ,还记得我们上面说的Thread 里面有一个ThreadLocalMap 属性吗?就是这里用上了
  5. ThreadLocalMap map = getMap(t);
  6. if (map != null) {
  7. ThreadLocalMap.Entry e = map.getEntry(this);
  8. if (e != null) {
  9. @SuppressWarnings("unchecked")
  10. T result = (T)e.value;
  11. return result;
  12. }
  13. }
  14. return setInitialValue();
  15. }
  1. ThreadLocalMap getMap(Thread t) {
  2. return t.threadLocals;
  3. }

到这里,读者应该大概明白了,其实ThreadLdocalMap 对使用者来说是透明的,可以当作空气,我们一值使用的都是ThreadLocal,这样的设计在使用的时候就显得简单,然后封装性又特别好。

ThreadLdocalMap 什么时候开始和Thread 进行绑定的呢

在第一次调用ThreadLocal set() 方法的时候开始绑定的,来我们看下set 方法的源码

  1. public void set(T value) {
  2. Thread t = Thread.currentThread();
  3. ThreadLocalMap map = getMap(t);
  4. if (map != null)
  5. map.set(this, value);
  6. else
  7. //第一次的时候进来这里,因为ThreadLocalMap 还没和Thread 绑定
  8. createMap(t, value);
  9. }
  10. //这个时候开始创建一个新的ThreadLocalMap 赋值给Thread 进行绑定
  11. void createMap(Thread t, T firstValue) {
  12. t.threadLocals = new ThreadLocalMap(this, firstValue);
  13. }