Java
语言基础

SimpleDateFormat的线程安全性问题及解决方案

简介:SimpleDateFormat是Java中一个非常常用的类,该类用来对日期字符串进行解析和格式化输出,但由于DateFormat和SimpleDateFormat类都不是线程安全的,在多线程环境下调用format()和parse()方法应该使用同步代码来避免问题。

SimpleDateFormat是Java中一个非常常用的类,该类用来对日期字符串进行解析和格式化输出,但由于DateFormatSimpleDateFormat类都不是线程安全的,在多线程环境下调用format()parse()方法应该使用同步代码来避免问题。

在使用静态的SimpleDateFormat实例,同一进行日期操作时,会减少创建的SimpleDateFormat对象数量,节省JVM内存占用:

  • package com.coderap.dateformat;
  • import java.text.ParseException;
  • import java.text.SimpleDateFormat;
  • import java.util.Date;
  • public class DateUtil {
  • private static final SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
  • public static String formatDate(Date date) throws ParseException {
  • return sdf.format(date);
  • }
  • public static Date parse(String strDate) throws ParseException {
  • return sdf.parse(strDate);
  • }
  • }

但当在生产环境中使用一段时间之后,会发现这么一个事实:它不是线程安全的。这种方式会出现各种不同的情况,比如转化的时间不正确、报错、线程被饿死等等。我们看下面的测试用例:

  • package com.coderap.dateformat;
  • import java.text.ParseException;
  • import java.text.SimpleDateFormat;
  • import java.util.Date;
  • public class DateUtil {
  • private static final SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
  • public static String formatDate(Date date) throws ParseException {
  • return sdf.format(date);
  • }
  • public static Date parse(String strDate) throws ParseException {
  • return sdf.parse(strDate);
  • }
  • }

测试类代码如下:

  • package com.coderap.dateformat;
  • import java.text.ParseException;
  • import java.util.Date;
  • public class DateUtilTest {
  • public static class TestSimpleDateFormatThreadSafe extends Thread {
  • @Override
  • public void run() {
  • while (true) {
  • try {
  • this.join(2000);
  • } catch (InterruptedException e1) {
  • e1.printStackTrace();
  • }
  • try {
  • System.out.println(this.getName() + ":" + DateUtil.parse("2013-05-24 06:02:20"));
  • } catch (ParseException e) {
  • e.printStackTrace();
  • }
  • }
  • }
  • }
  • public static void main(String[] args) {
  • for (int i = 0; i < 3; i++) {
  • new TestSimpleDateFormatThreadSafe().start();
  • }
  • }
  • }

执行输出如下:

  • Exception in thread "Thread-1" java.lang.NumberFormatException: multiple points
  • at sun.misc.FloatingDecimal.readJavaFormatString(FloatingDecimal.java:1082)
  • at java.lang.Double.parseDouble(Double.java:510)
  • at java.text.DigitList.getDouble(DigitList.java:151)
  • at java.text.DecimalFormat.parse(DecimalFormat.java:1302)
  • at java.text.SimpleDateFormat.subParse(SimpleDateFormat.java:1589)
  • at java.text.SimpleDateFormat.parse(SimpleDateFormat.java:1311)
  • at java.text.DateFormat.parse(DateFormat.java:335)
  • at com.coderap.orm.dateformat.DateNoStaticUtil.parse(DateNoStaticUtil.java:17)
  • at com.coderap.orm.dateformat.DateUtilTest$TestSimpleDateFormatThreadSafe.run(DateUtilTest.java:20)
  • Exception in thread "Thread-0" java.lang.NumberFormatException: multiple points
  • at sun.misc.FloatingDecimal.readJavaFormatString(FloatingDecimal.java:1082)
  • at java.lang.Double.parseDouble(Double.java:510)
  • at java.text.DigitList.getDouble(DigitList.java:151)
  • at java.text.DecimalFormat.parse(DecimalFormat.java:1302)
  • at java.text.SimpleDateFormat.subParse(SimpleDateFormat.java:1589)
  • at java.text.SimpleDateFormat.parse(SimpleDateFormat.java:1311)
  • at java.text.DateFormat.parse(DateFormat.java:335)
  • at com.coderap.orm.dateformat.DateNoStaticUtil.parse(DateNoStaticUtil.java:17)
  • at com.coderap.orm.dateformat.DateUtilTest$TestSimpleDateFormatThreadSafe.run(DateUtilTest.java:20)
  • Thread-2:Mon May 24 06:02:20 CST 2021
  • Thread-2:Fri May 24 06:02:20 CST 2013
  • Thread-2:Fri May 24 06:02:20 CST 2013
  • Thread-2:Fri May 24 06:02:20 CST 2013

Thread-1和Thread-0报java.lang.NumberFormatException: multiple points错误;Thread-2输出的时间是有错误的,比如输入的时间是2013-05-24 06:02:20,当会输出Mon May 24 06:02:20 CST 2021

共享一个静态变量的开销要比每次创建一个新变量要小很多,但出现上面的各种错误情况,是因为SimpleDateFormat和DateFormat类不是线程安全的。从SimpleDateFormat和DateFormat类提供的接口上来看,看不出它与线程安全有何相干。只是在JDK文档的最下面有如下说明:

SimpleDateFormat中的日期格式不是同步的。推荐(建议)为每个线程创建独立的格式实例。如果多个线程同时访问一个格式,则它必须保持外部同步。JDK原始文档如下:
Synchronization:
Date formats are not synchronized.
It is recommended to create separate format instances for each thread.
If multiple threads access a format concurrently, it must be synchronized externally.

下面通过看JDK源码来看看为什么SimpleDateFormat和DateFormat类不是线程安全的真正原因。

SimpleDateFormat继承了DateFormat,在DateFormat中定义了一个protected属性的Calendar类的对象calendar。只是因为Calendar类的概念复杂,牵扯到时区与本地化等等,JDK的实现中使用了成员变量来传递参数,这就造成在多线程的时候会出现错误。在format方法里,有这样一段代码:

  • private StringBuffer format(Date date, StringBuffer toAppendTo, FieldDelegate delegate) {
  • // Convert input date to time field list
  • calendar.setTime(date);
  • boolean useDateFormatSymbols = useDateFormatSymbols();
  • for (int i = 0; i < compiledPattern.length; ) {
  • int tag = compiledPattern[i] >>> 8;
  • int count = compiledPattern[i++] & 0xff;
  • if (count == 255) {
  • count = compiledPattern[i++] << 16;
  • count |= compiledPattern[i++];
  • }
  • switch (tag) {
  • case TAG_QUOTE_ASCII_CHAR:
  • toAppendTo.append((char)count);
  • break;
  • case TAG_QUOTE_CHARS:
  • toAppendTo.append(compiledPattern, i, count);
  • i += count;
  • break;
  • default:
  • subFormat(tag, count, delegate, toAppendTo, useDateFormatSymbols);
  • break;
  • }
  • }
  • return toAppendTo;
  • }

calendar.setTime(date)这条语句改变了calendar,稍后calendar还会用到(在subFormat()方法里),而这就是引发问题的根源。在一个多线程环境下,有两个线程持有了同一个SimpleDateFormat的实例,分别调用format()方法;线程A调用format()方法,改变了calendar这个字段然后阻塞了,线程B开始执行,它也改变了calendar,阻塞后线程A继续执行,此时,calendar已经被线程B修改过了。如果多个线程同时争抢calendar对象,则会出现各种问题。

这个问题背后隐藏着一个更为重要的问题:无状态。无状态方法的好处之一,就是它在各种环境下,都可以安全的调用。衡量一个方法是否是有状态的,就看它是否改动了其它的东西,比如全局变量,比如实例的字段。format()方法在运行过程中改动了SimpleDateFormat的calendar字段,所以,它是有状态的。

这也同时提醒我们在开发和设计系统的时候注意下一下三点:

  1. 自己写公用类的时候,要对多线程调用情况下的后果在注释里进行明确说明;
  2. 对线程环境下,对每一个共享的可变变量都要注意其线程安全性;
  3. 我们的类和方法在做设计的时候,要尽量设计成无状态的。

一般来说,有以下几种解决SimpleDateFormat线程安全性的办法:

  1. 需要的时候创建新实例:
  • package com.coderap.dateformat;
  • import java.text.ParseException;
  • import java.text.SimpleDateFormat;
  • import java.util.Date;
  • public class DateUtil {
  • public static String formatDate(Date date) throws ParseException {
  • SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
  • return sdf.format(date);
  • }
  • public static Date parse(String strDate) throws ParseException {
  • SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
  • return sdf.parse(strDate);
  • }
  • }

在需要用到SimpleDateFormat的地方新建一个实例,不管什么时候,将有线程安全问题的对象由共享变为局部私有都能避免多线程问题,不过也加重了创建对象的负担。在一般情况下,这样其实对性能影响比不是很明显的。

  1. 使用同步:同步SimpleDateFormat对象
  • package com.coderap.dateformat;
  • import java.text.ParseException;
  • import java.text.SimpleDateFormat;
  • import java.util.Date;
  • public class DateSyncUtil {
  • private static SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
  • public static String formatDate(Date date) throws ParseException {
  • synchronized (sdf) {
  • return sdf.format(date);
  • }
  • }
  • public static Date parse(String strDate) throws ParseException {
  • synchronized (sdf) {
  • return sdf.parse(strDate);
  • }
  • }
  • }

当线程较多时,当一个线程调用该方法时,其他想要调用此方法的线程就会阻塞,多线程并发量大的时候会对性能有一定的影响。

  1. 使用ThreadLocal: 
  • package com.coderap.dateformat;
  • import java.text.DateFormat;
  • import java.text.ParseException;
  • import java.text.SimpleDateFormat;
  • import java.util.Date;
  • public class ConcurrentDateUtil {
  • private static ThreadLocal<DateFormat> threadLocal = new ThreadLocal<DateFormat>() {
  • @Override
  • protected DateFormat initialValue() {
  • return new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
  • }
  • };
  • public static Date parse(String dateStr) throws ParseException {
  • return threadLocal.get().parse(dateStr);
  • }
  • public static String format(Date date) {
  • return threadLocal.get().format(date);
  • }
  • }

另外一种写法:

  • package com.coderap.dateformat;
  • import java.text.DateFormat;
  • import java.text.ParseException;
  • import java.text.SimpleDateFormat;
  • import java.util.Date;
  • public class ThreadLocalDateUtil {
  • private static final String date_format = "yyyy-MM-dd HH:mm:ss";
  • private static ThreadLocal<DateFormat> threadLocal = new ThreadLocal<DateFormat>();
  • public static DateFormat getDateFormat() {
  • DateFormat df = threadLocal.get();
  • if (df == null) {
  • df = new SimpleDateFormat(date_format);
  • threadLocal.set(df);
  • }
  • return df;
  • }
  • public static String formatDate(Date date) throws ParseException {
  • return getDateFormat().format(date);
  • }
  • public static Date parse(String strDate) throws ParseException {
  • return getDateFormat().parse(strDate);
  • }
  • }

使用ThreadLocal,也是将共享变量变为独享,线程独享肯定能比方法独享在并发环境中能减少不少创建对象的开销。如果对性能要求比较高的情况下,一般推荐使用这种方法。

  1. 使用其他类库中的时间格式化类:
  • 使用Apache commons包里的FastDateFormat,宣称是既快又线程安全的SimpleDateFormat,可惜它只能对日期进行格式化,不能对日期串进行解析。
  • 使用Joda Time类库来处理时间相关问题,建议使用。

做一个简单的压力测试,方法一最慢,方法三最快,但是就算是最慢的方法一性能也不差,一般系统方法一和方法二就可以满足,所以说在这个点很难成为你系统的瓶颈所在。从简单的角度来说,建议使用方法一或者方法二,如果在必要的时候,追求那么一点性能提升的话,可以考虑用方法三,用ThreadLocal做缓存。