Android-ThreadLocal

概述

  • ThreadLocal用于保存线程作用域内的对象;对象是线程共享的,所以为了达到线程之间使用不同的对象,使用者不能将对象赋值给类变量或者实例变量,只能赋值给局部变量,ThreadLocal对象无限制,但是ThreadLocal需要static(一般为static final或者private static,但是禁止外部方法重复创建ThreadLocal对象);
  • 主要涉及ThreadLocal和ThreadLocalMap两个类,简单说下两个类的作用,方便源码解析;ThreadLocal对象相当于一份数据在不同线程的数据对象的集合,通过ThreadLocal获取数据时,只能获取到当前线程对应的数据;ThreadLocalMap相当于一个线程内所有的ThreadLocal对象在该线程内的数据对象Map,key是ThreadLocal的hashCode(定制hashCode,并非Object.hashCode生成);ThreadLocalMap外部不能访问,只能通过ThreadLocal获取数据;
  • 很多SDK源码或者第三方库中都用到了ThreadLocal,比如Looper对象就是保存在ThreadLocal中;
  • 源码是基于Android-SDK-29;

源码

ThreadLocalMap
  • ThreadLocalMap相当于单线程作用域的Map,是所有ThreadLocal对象在本线程的数据的Map集合;
  • ThreadLocalMap是存储在Thraed对象中,也就确保了一个线程对应了一个ThredLocalMap,ThreadLocalMap里存储的都是本线程对应的所有数据;
  • ThreadLocal.ThreadLocalMap.Entry
    static class Entry extends WeakReference<ThreadLocal<?>> {
      /** The value associated with this ThreadLocal. */
      Object value;
      Entry(ThreadLocal<?> k, Object v) {
        super(k);
        value = v;
      }
    }
    
    • Entry类似于HashMap中的Entry,用来保存真正的数据;
    • Entry继承于WeakReference<ThreadLocal>,如果ThreadLocal(可以理解成对数据的封装了一层,get/set都是和当前相关联的数据)被回收了(比如static的ThreadLocal被重新赋值并触发GC,原来的ThreadLocal对象就会被回收),但是Entry对象或者数据并没有回收,在相关方法调用时做后续处理;
  • ThreadLocal.ThreadLocalMap
    • ThreadLocalMap的数据结构是数组,数组元素是Entry,根据ThreadLocal对象的hashCode和数组长度求模算出对应的索引,如果数组对应的引用为null,则直接存储,否则,循环索引递增求模,直到数组对应索引为null存储;
    • ThreadLocalMap有个很重要的概念,源码中是 run ,可以理解成“链”,即数组中连续不为null的部分称为“链”;
    • ThreadLocalMap.set
      private void set(ThreadLocal<?> key, Object value) {
              // We don't use a fast path as with get() because it is at
              // least as common to use set() to create new entries as
              // it is to replace existing ones, in which case, a fast
              // path would fail more often than not.
      
              Entry[] tab = table;
              int len = tab.length;
              //ThreadLocal对象的hashCode(定制)和数组长度求模,得到数组的索引;
              int i = key.threadLocalHashCode & (len-1); 
              //从索引开始递增,直到索引对应的引用为null
              for (Entry e = tab[i];
                   e != null;
                   e = tab[i = nextIndex(i, len)]) {
                  ThreadLocal<?> k = e.get();
                  //ThreadLocal对象为static,所以直接用 == 做判断
                  if (k == key) {
                      //更新已存在的数据
                      e.value = value;
                      return;
                  }
                  //ThreadLocal对象已被回收
                  if (k == null) {
                      //替换Entry并清除已回收的ThreadLocal
                      replaceStaleEntry(key, value, i);
                      return;
                  }
              }
              //新创建Entry对象,放在末尾处
              tab[i] = new Entry(key, value);
              int sz = ++size;
              //清除已回收ThreadLocal
              if (!cleanSomeSlots(i, sz) && sz >= threshold)
                  rehash(); //扩容
          }
      
      • 1.根据ThreadLocal的hashCode(定制hashCode)求模,算出对应的索引;
      • 2.循环索引递增,如果Entry中的ThreadLocal匹配,则更新数据,如果Entry中ThreadLocal已被回收,则替换Entry并删除其他被回收的Entry;
      • 3.如果没有找到Entry,则创建新的Entry并放在链的末尾;
    • ThreadLocalMap.getEntry
      private Entry getEntry(ThreadLocal<?> key) {
              int i = key.threadLocalHashCode & (table.length - 1);
              Entry e = table[i];
              if (e != null && e.get() == key)
                  return e; //根据求模获取的索引,直接命中
              else
                  return getEntryAfterMiss(key, i, e); //在链中寻找
          }
      
      private Entry getEntryAfterMiss(ThreadLocal<?> key, int i, Entry e) {
              Entry[] tab = table;
              int len = tab.length;
              //循环迭代直到链结束
              while (e != null) {
                  ThreadLocal<?> k = e.get();
                  if (k == key)
                      return e; //ThreadLocal匹配,直接返回
                  if (k == null)
                      expungeStaleEntry(i); //从i开始到链结束,删除已回收ThreadLocal,未被回收的重新求模存储;
                  else
                      i = nextIndex(i, len);
                  e = tab[i];
              }
              return null;
          }
      
    • ThreadLocalMap.remove
      private void remove(ThreadLocal<?> key) {
              Entry[] tab = table;
              int len = tab.length;
              int i = key.threadLocalHashCode & (len-1);
              //循环当前链
              for (Entry e = tab[i];
                   e != null;
                   e = tab[i = nextIndex(i, len)]) {
                  if (e.get() == key) {
                      e.clear();
                      //从i开始循环当前链,删除已回收ThreadLocal,未被回收的重新求模存储;
                      expungeStaleEntry(i);
                      return;
                  }
              }
          }
      
    • ThreadLocalMap.resize
      private void rehash() {
              //删除所有已被回收的ThreadLocal,并重新求模存储
              expungeStaleEntries();
              // Use lower threshold for doubling to avoid hysteresis
              if (size >= threshold - threshold / 4) //超过阈值的3/4,就扩容;阈值是数组长度的2/3;
                  resize(); //扩容
          }
      private void resize() {
              Entry[] oldTab = table;
              int oldLen = oldTab.length;
              int newLen = oldLen * 2; //2倍扩容
              Entry[] newTab = new Entry[newLen];
              int count = 0;
      
              for (int j = 0; j < oldLen; ++j) {
                  Entry e = oldTab[j];
                  if (e != null) {
                      ThreadLocal<?> k = e.get();
                      if (k == null) {
                          e.value = null; // Help the GC,处理已被回收的ThreadLocal
                      } else {
                          //重新求模存储
                          int h = k.threadLocalHashCode & (newLen - 1);
                          while (newTab[h] != null)
                              h = nextIndex(h, newLen);
                          newTab[h] = e;
                          count++;
                      }
                  }
              }
      
              setThreshold(newLen);
              size = count;
              table = newTab;
          }
      
      • 扩容是按照原来数组长度的两倍扩容;触发扩容是大于等于3/4阈值,阈值是数组长度的2/3,触发扩容是数组长度的1/2;
ThreadLocal
  • ThreadLocal对象可以理解为数据对象在不同线程中的备份的集合;ThreadLocal对象是static,才能确保线程内唯一;
  • hashCode
    //当前ThreadLocal对象的hashCode
    private final int threadLocalHashCode = nextHashCode();
    //静态变量,存储最后一个创建的ThreadLocal对象的hashCode
    private static AtomicInteger nextHashCode = new AtomicInteger();
    //ThreadLocal对象之间hashCode的间隔
    private static final int HASH_INCREMENT = 0x61c88647;
    //用于生成下一个ThreadLocal对象的hashCode
    private static int nextHashCode() {
      return nextHashCode.getAndAdd(HASH_INCREMENT);
    }
    
    • ThreadLocal对象的hashCode是定制的,对象之间的hashCode是固定间隔的,对于同一个ThreadLocal的不同线程之间的备份数据对象,由于是同一个ThreadLocal对象,所以hashCode是一样的;
  • ThreadLocal.get
    public T get() {
          Thread t = Thread.currentThread();
          ThreadLocalMap map = getMap(t);
          if (map != null) {
              //获取ThreadLocalMap中ThreadLocal对应的Entry
              ThreadLocalMap.Entry e = map.getEntry(this);
              if (e != null) {
                  @SuppressWarnings("unchecked")
                  //本线程对应的数据
                  T result = (T)e.value;
                  return result;
              }
          }
          return setInitialValue();
      }
    
    ThreadLocalMap getMap(Thread t) {
          return t.threadLocals; //Thread中的ThreadLocalMap变量
      }
    
  • ThreadLocal.set
    private T setInitialValue() {
          T value = initialValue();
          Thread t = Thread.currentThread();
          ThreadLocalMap map = getMap(t);
          if (map != null)
              map.set(this, value);
          else
              createMap(t, value);
          return value;
      }
    
  • ThreadLocal.remove
    public void remove() {
           ThreadLocalMap m = getMap(Thread.currentThread());
           if (m != null)
               m.remove(this);
       }
    

总结

  • 只有在线程内唯一实例的时候,才需要用ThreadLoal,ThreadLocal变量要static,并且确保同一份数据(对于业务层)只有一个ThreadLocal对象;
  • 数据本身不要被类变量或者实例变量引用,只有在方法内部使用的时候,通过ThreadLocal获取;否则,不同线程的数据对象还是可以被其他线程访问;
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,634评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,951评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,427评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,770评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,835评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,799评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,768评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,544评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,979评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,271评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,427评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,121评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,756评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,375评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,579评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,410评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,315评论 2 352

推荐阅读更多精彩内容