5种解决方案应对SimpleDateFormat线程不安全问题

摘要：我们知道SimpleDateFormat是线程不安全，本文会介绍5种解决方案来保证线程安全。

1、场景

在java8以前，要格式化日期时间，就需要用到SimpleDateFormat。

但我们知道SimpleDateFormat是线程不安全的，处理时要特别小心，要加锁或者不能定义为static，要在方法内new出对象，再进行格式化。很麻烦，而且重复地new出对象，也加大了内存开销。

2、SimpleDateFormat线程为什么是线程不安全的呢？

来看看SimpleDateFormat的源码，先看format方法：

//CalledfromFormataftercreatingaFieldDelegateprivateStringBufferformat(Datedate,StringBuffertoAppendTo,FieldDelegatedelegate){//Convertinputdatetotimefieldlistcalendar.setTime(date);...}

问题就出在成员变量calendar，如果在使用SimpleDateFormat时，用static定义，那SimpleDateFormat变成了共享变量。那SimpleDateFormat中的calendar就可以被多个线程访问到。

SimpleDateFormat的parse方法也是线程不安全的：

publicDateparse(Stringtext,ParsePositionpos){...DateparsedDate;try{parsedDate=calb.establish(calendar).getTime();//Iftheyearvalueisambiguous,//thenthetwo-digityear==thedefaultstartyearif(ambiguousYear[0]){if(parsedDate.before(defaultCenturyStart)){parsedDate=calb.addYear(100).establish(calendar).getTime();}}}//AnIllegalArgumentExceptionwillbethrownbyCalendar.getTime()//ifanyfieldsareoutofrange,e.g.,MONTH==17.catch(IllegalArgumentExceptione){pos.errorIndex=start;pos.index=oldStart;returnnull;}returnparsedDate;}

由源码可知，最后是调用**parsedDate= calb.establish(calendar).getTime();**获取返回值。方法的参数是calendar，calendar可以被多个线程访问到，存在线程不安全问题。

我们再来看看**calb.establish(calendar)**的源码

calb.establish(calendar)方法先后调用了cal.clear()和cal.set(),先清理值，再设值。但是这两个操作并不是原子性的，也没有线程安全机制来保证，导致多线程并发时，可能会引起cal的值出现问题了。

2.1 验证SimpleDateFormat线程不安全

publicclassSimpleDateFormatDemoTest{privatestaticSimpleDateFormatsimpleDateFormat=newSimpleDateFormat("yyyy-MM-ddHH:mm:ss");publicstaticvoidmain(String[]args){//1、创建线程池ExecutorServicepool=Executors.newFixedThreadPool(5);//2、为线程池分配任务ThreadPoolTestthreadPoolTest=newThreadPoolTest();for(inti=0;i<10;i++){pool.submit(threadPoolTest);}//3、关闭线程池pool.shutdown();}staticclassThreadPoolTestimplementsRunnable{@Overridepublicvoidrun(){StringdateString=simpleDateFormat.format(newDate());try{DateparseDate=simpleDateFormat.parse(dateString);StringdateString2=simpleDateFormat.format(parseDate);System.out.println(Thread.currentThread().getName()+"线程是否安全:"+dateString.equals(dateString2));}catch(Exceptione){System.out.println(Thread.currentThread().getName()+"格式化失败");}}}}

出现了两次false，说明线程是不安全的。而且还抛异常，这个就严重了。

3、解决方案

3.1 解决方案1：不要定义为static变量，使用局部变量

就是要使用SimpleDateFormat对象进行format或parse时，再定义为局部变量。就能保证线程安全。

publicclassSimpleDateFormatDemoTest1{publicstaticvoidmain(String[]args){//1、创建线程池ExecutorServicepool=Executors.newFixedThreadPool(5);//2、为线程池分配任务ThreadPoolTestthreadPoolTest=newThreadPoolTest();for(inti=0;i<10;i++){pool.submit(threadPoolTest);}//3、关闭线程池pool.shutdown();}staticclassThreadPoolTestimplementsRunnable{@Overridepublicvoidrun(){SimpleDateFormatsimpleDateFormat=newSimpleDateFormat("yyyy-MM-ddHH:mm:ss");StringdateString=simpleDateFormat.format(newDate());try{DateparseDate=simpleDateFormat.parse(dateString);StringdateString2=simpleDateFormat.format(parseDate);System.out.println(Thread.currentThread().getName()+"线程是否安全:"+dateString.equals(dateString2));}catch(Exceptione){System.out.println(Thread.currentThread().getName()+"格式化失败");}}}}

由图可知，已经保证了线程安全，但这种方案不建议在高并发场景下使用，因为会创建大量的SimpleDateFormat对象，影响性能。

3.2 解决方案2：加锁：synchronized锁和Lock锁

3.2.1 加synchronized锁

SimpleDateFormat对象还是定义为全局变量，然后需要调用SimpleDateFormat进行格式化时间时，再用synchronized保证线程安全。

publicclassSimpleDateFormatDemoTest2{privatestaticSimpleDateFormatsimpleDateFormat=newSimpleDateFormat("yyyy-MM-ddHH:mm:ss");publicstaticvoidmain(String[]args){//1、创建线程池ExecutorServicepool=Executors.newFixedThreadPool(5);//2、为线程池分配任务ThreadPoolTestthreadPoolTest=newThreadPoolTest();for(inti=0;i<10;i++){pool.submit(threadPoolTest);}//3、关闭线程池pool.shutdown();}staticclassThreadPoolTestimplementsRunnable{@Overridepublicvoidrun(){try{synchronized(simpleDateFormat){StringdateString=simpleDateFormat.format(newDate());DateparseDate=simpleDateFormat.parse(dateString);StringdateString2=simpleDateFormat.format(parseDate);System.out.println(Thread.currentThread().getName()+"线程是否安全:"+dateString.equals(dateString2));}}catch(Exceptione){System.out.println(Thread.currentThread().getName()+"格式化失败");}}}}

如图所示，线程是安全的。定义了全局变量SimpleDateFormat，减少了创建大量SimpleDateFormat对象的损耗。但是使用synchronized锁，同一时刻只有一个线程能执行锁住的代码块，在高并发的情况下会影响性能。但这种方案不建议在高并发场景下使用

3.2.2 加Lock锁

加Lock锁和synchronized锁原理是一样的，都是使用锁机制保证线程的安全。

publicclassSimpleDateFormatDemoTest3{privatestaticSimpleDateFormatsimpleDateFormat=newSimpleDateFormat("yyyy-MM-ddHH:mm:ss");privatestaticLocklock=newReentrantLock();publicstaticvoidmain(String[]args){//1、创建线程池ExecutorServicepool=Executors.newFixedThreadPool(5);//2、为线程池分配任务ThreadPoolTestthreadPoolTest=newThreadPoolTest();for(inti=0;i<10;i++){pool.submit(threadPoolTest);}//3、关闭线程池pool.shutdown();}staticclassThreadPoolTestimplementsRunnable{@Overridepublicvoidrun(){try{lock.lock();StringdateString=simpleDateFormat.format(newDate());DateparseDate=simpleDateFormat.parse(dateString);StringdateString2=simpleDateFormat.format(parseDate);System.out.println(Thread.currentThread().getName()+"线程是否安全:"+dateString.equals(dateString2));}catch(Exceptione){System.out.println(Thread.currentThread().getName()+"格式化失败");}finally{lock.unlock();}}}}

由结果可知，加Lock锁也能保证线程安全。要注意的是，最后一定要释放锁，代码里在finally里增加了lock.unlock();，保证释放锁。

在高并发的情况下会影响性能。这种方案不建议在高并发场景下使用

3.3 解决方案3：使用ThreadLocal方式

使用ThreadLocal保证每一个线程有SimpleDateFormat对象副本。这样就能保证线程的安全。

publicclassSimpleDateFormatDemoTest4{privatestaticThreadLocal<DateFormat>threadLocal=newThreadLocal<DateFormat>(){@OverrideprotectedDateFormatinitialValue(){returnnewSimpleDateFormat("yyyy-MM-ddHH:mm:ss");}};publicstaticvoidmain(String[]args){//1、创建线程池ExecutorServicepool=Executors.newFixedThreadPool(5);//2、为线程池分配任务ThreadPoolTestthreadPoolTest=newThreadPoolTest();for(inti=0;i<10;i++){pool.submit(threadPoolTest);}//3、关闭线程池pool.shutdown();}staticclassThreadPoolTestimplementsRunnable{@Overridepublicvoidrun(){try{StringdateString=threadLocal.get().format(newDate());DateparseDate=threadLocal.get().parse(dateString);StringdateString2=threadLocal.get().format(parseDate);System.out.println(Thread.currentThread().getName()+"线程是否安全:"+dateString.equals(dateString2));}catch(Exceptione){System.out.println(Thread.currentThread().getName()+"格式化失败");}finally{//避免内存泄漏，使用完threadLocal后要调用remove方法清除数据threadLocal.remove();}}}}

使用ThreadLocal能保证线程安全，且效率也是挺高的。适合高并发场景使用。

3.4解决方案4：使用DateTimeFormatter代替SimpleDateFormat

使用DateTimeFormatter代替SimpleDateFormat（DateTimeFormatter是线程安全的，java 8+支持）

DateTimeFormatter介绍 传送门：万字博文教你搞懂java源码的日期和时间相关用法

publicclassDateTimeFormatterDemoTest5{privatestaticDateTimeFormatterdateTimeFormatter=DateTimeFormatter.ofPattern("yyyy-MM-ddHH:mm:ss");publicstaticvoidmain(String[]args){//1、创建线程池ExecutorServicepool=Executors.newFixedThreadPool(5);//2、为线程池分配任务ThreadPoolTestthreadPoolTest=newThreadPoolTest();for(inti=0;i<10;i++){pool.submit(threadPoolTest);}//3、关闭线程池pool.shutdown();}staticclassThreadPoolTestimplementsRunnable{@Overridepublicvoidrun(){try{StringdateString=dateTimeFormatter.format(LocalDateTime.now());TemporalAccessortemporalAccessor=dateTimeFormatter.parse(dateString);StringdateString2=dateTimeFormatter.format(temporalAccessor);System.out.println(Thread.currentThread().getName()+"线程是否安全:"+dateString.equals(dateString2));}catch(Exceptione){e.printStackTrace();System.out.println(Thread.currentThread().getName()+"格式化失败");}}}}

使用DateTimeFormatter能保证线程安全，且效率也是挺高的。适合高并发场景使用。

3.5 解决方案5：使用FastDateFormat 替换SimpleDateFormat

使用FastDateFormat 替换SimpleDateFormat（FastDateFormat 是线程安全的，Apache Commons Lang包支持，不受限于java版本）

publicclassFastDateFormatDemo6{privatestaticFastDateFormatfastDateFormat=FastDateFormat.getInstance("yyyy-MM-ddHH:mm:ss");publicstaticvoidmain(String[]args){//1、创建线程池ExecutorServicepool=Executors.newFixedThreadPool(5);//2、为线程池分配任务ThreadPoolTestthreadPoolTest=newThreadPoolTest();for(inti=0;i<10;i++){pool.submit(threadPoolTest);}//3、关闭线程池pool.shutdown();}staticclassThreadPoolTestimplementsRunnable{@Overridepublicvoidrun(){try{StringdateString=fastDateFormat.format(newDate());DateparseDate=fastDateFormat.parse(dateString);StringdateString2=fastDateFormat.format(parseDate);System.out.println(Thread.currentThread().getName()+"线程是否安全:"+dateString.equals(dateString2));}catch(Exceptione){e.printStackTrace();System.out.println(Thread.currentThread().getName()+"格式化失败");}}}}

使用FastDateFormat能保证线程安全，且效率也是挺高的。适合高并发场景使用。

3.5.1 FastDateFormat源码分析

ApacheCommonsLang3.5//FastDateFormat@OverridepublicStringformat(finalDatedate){returnprinter.format(date);}@OverridepublicStringformat(finalDatedate){finalCalendarc=Calendar.getInstance(timeZone,locale);c.setTime(date);returnapplyRulesToString(c);}

源码中 Calender 是在 format 方法里创建的，肯定不会出现 setTime 的线程安全问题。这样线程安全疑惑解决了。那还有性能问题要考虑？

我们来看下FastDateFormat是怎么获取的

publicDateparse(Stringtext,ParsePositionpos){...DateparsedDate;try{parsedDate=calb.establish(calendar).getTime();//Iftheyearvalueisambiguous,//thenthetwo-digityear==thedefaultstartyearif(ambiguousYear[0]){if(parsedDate.before(defaultCenturyStart)){parsedDate=calb.addYear(100).establish(calendar).getTime();}}}//AnIllegalArgumentExceptionwillbethrownbyCalendar.getTime()//ifanyfieldsareoutofrange,e.g.,MONTH==17.catch(IllegalArgumentExceptione){pos.errorIndex=start;pos.index=oldStart;returnnull;}returnparsedDate;}0

看下对应的源码

publicDateparse(Stringtext,ParsePositionpos){...DateparsedDate;try{parsedDate=calb.establish(calendar).getTime();//Iftheyearvalueisambiguous,//thenthetwo-digityear==thedefaultstartyearif(ambiguousYear[0]){if(parsedDate.before(defaultCenturyStart)){parsedDate=calb.addYear(100).establish(calendar).getTime();}}}//AnIllegalArgumentExceptionwillbethrownbyCalendar.getTime()//ifanyfieldsareoutofrange,e.g.,MONTH==17.catch(IllegalArgumentExceptione){pos.errorIndex=start;pos.index=oldStart;returnnull;}returnparsedDate;}1

这里有用到一个CACHE，看来用了缓存，往下看

publicDateparse(Stringtext,ParsePositionpos){...DateparsedDate;try{parsedDate=calb.establish(calendar).getTime();//Iftheyearvalueisambiguous,//thenthetwo-digityear==thedefaultstartyearif(ambiguousYear[0]){if(parsedDate.before(defaultCenturyStart)){parsedDate=calb.addYear(100).establish(calendar).getTime();}}}//AnIllegalArgumentExceptionwillbethrownbyCalendar.getTime()//ifanyfieldsareoutofrange,e.g.,MONTH==17.catch(IllegalArgumentExceptione){pos.errorIndex=start;pos.index=oldStart;returnnull;}returnparsedDate;}2

在getInstance 方法中加了ConcurrentMap 做缓存，提高了性能。且我们知道ConcurrentMap 也是线程安全的。

3.5.2 实践

publicDateparse(Stringtext,ParsePositionpos){...DateparsedDate;try{parsedDate=calb.establish(calendar).getTime();//Iftheyearvalueisambiguous,//thenthetwo-digityear==thedefaultstartyearif(ambiguousYear[0]){if(parsedDate.before(defaultCenturyStart)){parsedDate=calb.addYear(100).establish(calendar).getTime();}}}//AnIllegalArgumentExceptionwillbethrownbyCalendar.getTime()//ifanyfieldsareoutofrange,e.g.,MONTH==17.catch(IllegalArgumentExceptione){pos.errorIndex=start;pos.index=oldStart;returnnull;}returnparsedDate;}3

publicDateparse(Stringtext,ParsePositionpos){...DateparsedDate;try{parsedDate=calb.establish(calendar).getTime();//Iftheyearvalueisambiguous,//thenthetwo-digityear==thedefaultstartyearif(ambiguousYear[0]){if(parsedDate.before(defaultCenturyStart)){parsedDate=calb.addYear(100).establish(calendar).getTime();}}}//AnIllegalArgumentExceptionwillbethrownbyCalendar.getTime()//ifanyfieldsareoutofrange,e.g.,MONTH==17.catch(IllegalArgumentExceptione){pos.errorIndex=start;pos.index=oldStart;returnnull;}returnparsedDate;}4

如图可证，是使用了ConcurrentMap做缓存。且key值是格式，时区和locale（语境）三者都相同为相同的key。

4、结论

1、不要定义为static变量，使用局部变量

2、加锁：synchronized锁和Lock锁

3、使用ThreadLocal方式

4、使用DateTimeFormatter代替SimpleDateFormat（DateTimeFormatter是线程安全的，java 8+支持）

5、使用FastDateFormat 替换SimpleDateFormat（FastDateFormat 是线程安全的，Apache Commons Lang包支持，java8之前推荐此用法）

本文分享自华为云社区，作者：小虚竹 。