ThreadLocal 内存泄漏

个人对内存泄漏的理解：如果一个我用不到对象一直在内存里，那么就出现内存泄漏了。

简单说一下TheadLocal实现原理：

        通过线程私有的空间来存储数据，即在Thread类里有一个ThreadLocalMap类型的变量：

/* ThreadLocal values pertaining to this thread. This map is maintained
     * by the ThreadLocal class. */
ThreadLocal.ThreadLocalMap threadLocals = null;

    ThreadLocal.ThreadLocalMap就是一个Map，内部使用了一个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是继承弱引用WeakReference的，k对于Entry就是一个弱引用，如果k不存在强引用，那么它将会被回收，此时Entry的k是空。

    一个关键信息：Entry的k就是一个ThreadLocal对象，ThreadLocal相对于Entry来说就是一个弱引用。

    TheadLocal对象如果在外部不存在强引用，那么对应Entry的k将会被回收掉，有部分文章认为此时如果不调用ThreadLocal#remove()方法，将会出现Entry和value不会被回收掉，从而出现内存泄漏。但我认为此时不一定出现内存泄漏的，因为ThreadLoocal有一个cleanSomeSlots方法，它会把key==null的Entry给回收掉。测试：

public static void main(String[] args) throws Exception {
         for (int i = 0; i < 100000; i++) { 
                ThreadLocal t = new ThreadLocal(); 
                t.set(new byte[1024 * 100]); 
         } 
         System.out.println(getThreadLocalMapSize()); 
} 

/** 获取Entry的数量 */    
private static int getThreadLocalMapSize() throws Exception {
        Field threadLocalsField = Class.forName("java.lang.Thread").getDeclaredField("threadLocals");  
        threadLocalsField.setAccessible(true);        
        Object threadLocals = threadLocalsField.get(Thread.currentThread());


        Field threadLocalMapSizeField =  Class.forName("java.lang.ThreadLocal$ThreadLocalMap").getDeclaredField("size");
        threadLocalMapSizeField.setAccessible(true);

        return (int) threadLocalMapSizeField.get(threadLocals);    
}

    执行完成后，主线程的ThreadLocalMap的Entry的size远远小于100000。证明ThreadLocalMap中的无效Entry会被自动回收。

    这种情况也是会有内存泄漏的风险，因为cleanSomeSlots方法依赖于下一次get、set、remove方法调用，如果get、set、remove方法再也没有被调用过，那么此时对应Entry也不会被回收掉，从而导致内存泄漏。

 

    另外一种情况就是申明一个是全局的ThreadLocal变量：

public static final ThreadLocal threadLocal = new ThreadLocal();

    此时threadLocal就会被所有线程所共享，它一直都将会是一个强引用，导致Entry的k一直得不到回收从而内存泄漏(实际上可能此时我的线程已经不需要这个ThreadLocal了)，更好的做法是如果当前线程确定不会用到这个ThreadLocal，就手动调动ThreadLocal#remove方法，remove方法会将当前线程的ThreadLocalMap中对应Entry给回收掉。

 

    总结：如果我们能确定我们的线程不会再用到ThreadLocal了，就手动调用ThreadLocal#remove以避免内存泄漏！