欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

java ThreadLocal使用案例详解

程序员文章站 2022-06-05 08:37:14
本文借由并发环境下使用线程不安全的simpledateformat优化案例,帮助大家理解threadlocal. 最近整理公司项目,发现不少写的比较糟糕的地方,比如下面这...

本文借由并发环境下使用线程不安全的simpledateformat优化案例,帮助大家理解threadlocal.

最近整理公司项目,发现不少写的比较糟糕的地方,比如下面这个:

public class dateutil {

  private final static simpledateformat sdfyhm = new simpledateformat(
      "yyyymmdd");
      
  public synchronized static date parseymdhms(string source) {
    try {
      return sdfyhm.parse(source);
    } catch (parseexception e) {
      e.printstacktrace();
      return new date();
    }
  }

}

首先分析下:
该处的函数parseymdhms()使用了synchronized修饰,意味着该操作是线程不安全的,所以需要同步,线程不安全也只能是simpledateformat的parse()方法,查看下源码,在simpledateformat里面有一个全局变量

protected calendar calendar;

date parse() {

  calendar.clear();

 ... // 执行一些操作, 设置 calendar 的日期什么的

 calendar.gettime(); // 获取calendar的时间

}

该clear()操作会造成线程不安全.

此外使用synchronized 关键字对性能有很大影响,尤其是多线程的时候,每一次调用parseymdhms方法都会进行同步判断,并且同步本身开销就很大,因此这是不合理的解决方案.

改进方法

线程不安全是源于多线程使用了共享变量造成,所以这里使用threadlocal<simpledateformat>来给每个线程单独创建副本变量,先给出代码,再分析这样的解决问题的原因.

/**
 * 日期工具类(使用了threadlocal获取simpledateformat,其他方法可以直接拷贝common-lang)
 * @author niu li
 * @date 2016/11/19
 */
public class dateutil {

  private static map<string,threadlocal<simpledateformat>> sdfmap = new hashmap<string, threadlocal<simpledateformat>>();

  private static logger logger = loggerfactory.getlogger(dateutil.class);

  public final static string mdhmss = "mmddhhmmsssss";
  public final static string ymdhms = "yyyymmddhhmmss";
  public final static string ymdhms_ = "yyyy-mm-dd hh:mm:ss";
  public final static string ymd = "yyyymmdd";
  public final static string ymd_ = "yyyy-mm-dd";
  public final static string hms = "hhmmss";

  /**
   * 根据map中的key得到对应线程的sdf实例
   * @param pattern map中的key
   * @return 该实例
   */
  private static simpledateformat getsdf(final string pattern){
    threadlocal<simpledateformat> sdfthread = sdfmap.get(pattern);
    if (sdfthread == null){
      //双重检验,防止sdfmap被多次put进去值,和双重锁单例原因是一样的
      synchronized (dateutil.class){
        sdfthread = sdfmap.get(pattern);
        if (sdfthread == null){
          logger.debug("put new sdf of pattern " + pattern + " to map");
          sdfthread = new threadlocal<simpledateformat>(){
            @override
            protected simpledateformat initialvalue() {
              logger.debug("thread: " + thread.currentthread() + " init pattern: " + pattern);
              return new simpledateformat(pattern);
            }
          };
          sdfmap.put(pattern,sdfthread);
        }
      }
    }
    return sdfthread.get();
  }

  /**
   * 按照指定pattern解析日期
   * @param date 要解析的date
   * @param pattern 指定格式
   * @return 解析后date实例
   */
  public static date parsedate(string date,string pattern){
    if(date == null) {
      throw new illegalargumentexception("the date must not be null");
    }
    try {
      return getsdf(pattern).parse(date);
    } catch (parseexception e) {
      e.printstacktrace();
      logger.error("解析的格式不支持:"+pattern);
    }
    return null;
  }
  /**
   * 按照指定pattern格式化日期
   * @param date 要格式化的date
   * @param pattern 指定格式
   * @return 解析后格式
   */
  public static string formatdate(date date,string pattern){
    if (date == null){
      throw new illegalargumentexception("the date must not be null");
    }else {
      return getsdf(pattern).format(date);
    }
  }
}

测试

在主线程中执行一个,另外两个在子线程执行,使用的都是同一个pattern

public static void main(string[] args) {
    dateutil.formatdate(new date(),mdhmss);
    new thread(()->{
      dateutil.formatdate(new date(),mdhmss);
    }).start();
    new thread(()->{
      dateutil.formatdate(new date(),mdhmss);
    }).start();
  }

日志分析

put new sdf of pattern mmddhhmmsssss to map
thread: thread[main,5,main] init pattern: mmddhhmmsssss
thread: thread[thread-0,5,main] init pattern: mmddhhmmsssss
thread: thread[thread-1,5,main] init pattern: mmddhhmmsssss

分析

可以看出来sdfmap put进去了一次,而simpledateformat被new了三次,因为代码中有三个线程.那么这是为什么呢?

对于每一个线程thread,其内部有一个threadlocal.threadlocalmap threadlocals的全局变量引用,threadlocal.threadlocalmap里面有一个保存该threadlocal和对应value,一图胜千言,结构图如下:

java ThreadLocal使用案例详解

那么对于sdfmap的话,结构图就变更了下

java ThreadLocal使用案例详解

1.首先第一次执行dateutil.formatdate(new date(),mdhmss);

//第一次执行dateutil.formatdate(new date(),mdhmss)分析
  private static simpledateformat getsdf(final string pattern){
    threadlocal<simpledateformat> sdfthread = sdfmap.get(pattern);
    //得到的sdfthread为null,进入if语句
    if (sdfthread == null){
      synchronized (dateutil.class){
        sdfthread = sdfmap.get(pattern);
        //sdfthread仍然为null,进入if语句
        if (sdfthread == null){
          //打印日志
          logger.debug("put new sdf of pattern " + pattern + " to map");
          //创建threadlocal实例,并覆盖initialvalue方法
          sdfthread = new threadlocal<simpledateformat>(){
            @override
            protected simpledateformat initialvalue() {
              logger.debug("thread: " + thread.currentthread() + " init pattern: " + pattern);
              return new simpledateformat(pattern);
            }
          };
          //设置进如sdfmap
          sdfmap.put(pattern,sdfthread);
        }
      }
    }
    return sdfthread.get();
  }

这个时候可能有人会问,这里并没有调用threadlocal的set方法,那么值是怎么设置进入的呢?
这就需要看sdfthread.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();
  }

也就是说当值不存在的时候会调用setinitialvalue()方法,该方法会调用initialvalue()方法,也就是我们覆盖的方法.

对应日志打印.

put new sdf of pattern mmddhhmmsssss to map
thread: thread[main,5,main] init pattern: mmddhhmmsssss

2.第二次在子线程执行dateutil.formatdate(new date(),mdhmss);

//第二次在子线程执行`dateutil.formatdate(new date(),mdhmss);`
  private static simpledateformat getsdf(final string pattern){
    threadlocal<simpledateformat> sdfthread = sdfmap.get(pattern);
    //这里得到的sdfthread不为null,跳过if块
    if (sdfthread == null){
      synchronized (dateutil.class){
        sdfthread = sdfmap.get(pattern);
        if (sdfthread == null){
          logger.debug("put new sdf of pattern " + pattern + " to map");
          sdfthread = new threadlocal<simpledateformat>(){
            @override
            protected simpledateformat initialvalue() {
              logger.debug("thread: " + thread.currentthread() + " init pattern: " + pattern);
              return new simpledateformat(pattern);
            }
          };
          sdfmap.put(pattern,sdfthread);
        }
      }
    }
    //直接调用sdfthread.get()返回
    return sdfthread.get();
  }

分析sdfthread.get()

//第二次在子线程执行`dateutil.formatdate(new date(),mdhmss);`
  public t get() {
    thread t = thread.currentthread();//得到当前子线程
    threadlocalmap map = getmap(t);
    //子线程中得到的map为null,跳过if块
    if (map != null) {
      threadlocalmap.entry e = map.getentry(this);
      if (e != null) {
        @suppresswarnings("unchecked")
        t result = (t)e.value;
        return result;
      }
    }
    //直接执行初始化,也就是调用我们覆盖的initialvalue()方法
    return setinitialvalue();
  }

对应日志:

thread[thread-1,5,main] init pattern: mmddhhmmsssss

总结

在什么场景下比较适合使用threadlocal?*上有人给出了还不错的回答。
when and how should i use a threadlocal variable?
one possible (and common) use is when you have some object that is not thread-safe, but you want to avoid synchronizing access to that object (i'm looking at you, simpledateformat). instead, give each thread its own instance of the object.

参考代码:

https://github.com/nl101531/javaweb 下util-demo

参考资料:

深入浅出的学习java threadlocal

simpledateformat的线程安全问题与解决方案

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。