ThreadLocal具体用法和适用场景

1.什么是ThreadLocal

       ThreadLocal是什么呢？其实ThreadLocal并不是是一个线程的本地实现版本，它并非一个Thread，而是threadlocalvariable(线程局部变量)。也许把它命名为ThreadLocalVar更加合适。线程局部变量(ThreadLocal)其实的功用很是简单，就是为每个使用该变量的线程都提供一个变量值的副本，是Java中一种较为特殊的线程绑定机制，是每个线程均可以独立地改变本身的副本，而不会和其它线程的副本冲突。从线程的角度看，每一个线程都保持一个对其线程局部变量副本的隐式引用，只要线程是活动的而且 ThreadLocal 实例是可访问的；在线程消失以后，其线程局部实例的全部副本都会被垃圾回收（除非存在对这些副本的其余引用）。

2.API说明

ThreadLocal()

          建立一个线程本地变量。

T get()

          返回此线程局部变量的当前线程副本中的值，若是这是线程第一次调用该方法，则建立并初始化此副本。

protected  T initialValue()

          返回此线程局部变量的当前线程的初始值。最多在每次访问线程来得到每一个线程局部变量时调用此方法一次，即线程第一次使用 get() 方法访问变量的时候。若是线程先于 get 方法调用 set(T) 方法，则不会在线程中再调用 initialValue 方法。

   若该实现只返回 null；若是程序员但愿将线程局部变量初始化为 null 之外的某个值，则必须为 ThreadLocal 建立子类，并重写此方法。一般，将使用匿名内部类。initialValue 的典型实现将调用一个适当的构造方法，并返回新构造的对象。

void remove()

          移除此线程局部变量的值。这可能有助于减小线程局部变量的存储需求。若是再次访问此线程局部变量，那么在默认状况下它将拥有其 initialValue。

void set(T value)

          将此线程局部变量的当前线程副本中的值设置为指定值。许多应用程序不须要这项功能，它们只依赖于 initialValue() 方法来设置线程局部变量的值。

 

3.典型用例

一、Hiberante的Session 工具类HibernateUtil

这个类是Hibernate官方文档中HibernateUtil类，用于session管理。

 

public class HibernateUtil {

    private static Log log = LogFactory.getLog(HibernateUtil.class);

    private static final SessionFactory sessionFactory;     //定义SessionFactory

 

    static {
        try {
            // 经过默认配置文件hibernate.cfg.xml建立SessionFactory
            sessionFactory = new Configuration().configure().buildSessionFactory();
        } catch (Throwable ex) {
            log.error("初始化SessionFactory失败！", ex);
            throw new ExceptionInInitializerError(ex);
        }
    }

    //建立线程局部变量session，用来保存Hibernate的Session
    public static final ThreadLocal session = new ThreadLocal();

 

    /**
     * 获取当前线程中的Session
     * @return Session
     * @throws HibernateException
     */
    public static Session currentSession() throws HibernateException {
        Session s = (Session) session.get();
        // 若是Session尚未打开，则新开一个Session
        if (s == null) {
            s = sessionFactory.openSession();
            session.set(s);         //将新开的Session保存到线程局部变量中
        }
        return s;
    }

 

    public static void closeSession() throws HibernateException {
        //获取线程局部变量，并强制转换为Session类型
        Session s = (Session) session.get();
        session.set(null);
        if (s != null)
            s.close();
    }
}

 

在这个类中，因为没有重写ThreadLocal的initialValue()方法，则首次建立线程局部变量session其初始值为null，第一次调用currentSession()的时候，线程局部变量的get()方法也为null。所以，对session作了判断，若是为null，则新开一个Session，并保存到线程局部变量session中，这一步很是的关键，这也是“public static final ThreadLocal session = new ThreadLocal()”所建立对象session能强制转换为Hibernate Session对象的缘由。

 

二、另一个实例

建立一个Bean，经过不一样的线程对象设置Bean属性，保证各个线程Bean对象的独立性。

 

/**
 * Created by IntelliJ IDEA.
 * User: leizhimin
 * Date: 2007-11-23
 * Time: 10:45:02
 * 学生
 */
public class Student {
    private int age = 0;   //年龄

 

    public int getAge() {
        return this.age;
    }

 

    public void setAge(int age) {
        this.age = age;
    }
}

 

/**
 * Created by IntelliJ IDEA.
 * User: leizhimin
 * Date: 2007-11-23
 * Time: 10:53:33
 * 多线程下测试程序
 */
public class ThreadLocalDemo implements Runnable {
    //建立线程局部变量studentLocal，在后面你会发现用来保存Student对象
    private final static ThreadLocal studentLocal = new ThreadLocal();

 

    public static void main(String[] agrs) {
        ThreadLocalDemo td = new ThreadLocalDemo();
        Thread t1 = new Thread(td, "a");
        Thread t2 = new Thread(td, "b");
        t1.start();
        t2.start();
    }

 

    public void run() {
        accessStudent();
    }

 

    /**
     * 示例业务方法，用来测试
     */
    public void accessStudent() {
        //获取当前线程的名字
        String currentThreadName = Thread.currentThread().getName();
        System.out.println(currentThreadName + " is running!");

        //产生一个随机数并打印
        Random random = new Random();
        int age = random.nextInt(100);
        System.out.println("thread " + currentThreadName + " set age to:" + age);

        //获取一个Student对象，并将随机数年龄插入到对象属性中
        Student student = getStudent();
        student.setAge(age);
        System.out.println("thread " + currentThreadName + " first read age is:" + student.getAge());
        try {
            Thread.sleep(500);
        }
        catch (InterruptedException ex) {
            ex.printStackTrace();
        }
        System.out.println("thread " + currentThreadName + " second read age is:" + student.getAge());
    }

 

    protected Student getStudent() {
        //获取本地线程变量并强制转换为Student类型
        Student student = (Student) studentLocal.get();
        //线程首次执行此方法的时候，studentLocal.get()确定为null
        if (student == null) {
            //建立一个Student对象，并保存到本地线程变量studentLocal中
            student = new Student();
            studentLocal.set(student);
        }
        return student;
    }
}

 

运行结果：

a is running! 
thread a set age to:76 
b is running! 
thread b set age to:27 
thread a first read age is:76 
thread b first read age is:27 
thread a second read age is:76 
thread b second read age is:27 

 

能够看到a、b两个线程age在不一样时刻打印的值是彻底相同的。这个程序经过妙用ThreadLocal，既实现多线程并发，游兼顾数据的安全性。

 

*spring里面也常用localthread来处理事务，aop等业务因此说localThread很是具备研究必要，另外在实际使用中，用完localThread必定要手动清空对象，虽然localThread里面保存的对象是WeakReference，可是只针对key没有针对value因此一不当心会有内存泄露风险必定要注意