SimpleDateFormat格式化日期线程不安全问题分析

1、问题产生

//全局变量
public static SimpleDateFormat dataTimeFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
/**
	 * 计算时间差
	 * 
	 * @return 返回两个时间秒的差别
	 */
public static long timeDiff(String date1, String date2) {
  long diff = 0L;
  try {
   Date d1 = dataTimeFormat.parse(date1);
   Date d2 = dataTimeFormat.parse(date2);
   diff =  new BigDecimal(d1.getTime()).subtract(new BigDecimal(d2.getTime())).longValue();
   LOGGER.info("timeDiff diff:{},date1:{},date1time:{},date2:{},date2time:{}",diff,date1,d1.getTime(),date2,d2.getTime());
  } catch (Exception e) {
   LOGGER.error("timeDiff Exception:{}",e);
   e.printStackTrace();
  }
  return diff / 1000;
 }

日志打印偶尔会出现

2022-10-10 16:47:33.803 INFO 5987 --- [pool-2-thread-9] com.sf.ucs.latas.common.DateUtil         : timeDiff diff:127586275371000,date1:2022-10-10 16:47:33,date1time:1665391653000,date2:2022-10-10 16:44:42,date2time:-125920883718000

2、出现负数原因分析

SimpleDateFormat继承自DateFormat这个抽象类，UML图如下：

DateFormat中有两个全局变量需要注意

public abstract class DateFormat extends Format {

    //日历变量，作为DateFormat的辅助
    protected Calendar calendar;

    //用来Format数字，默认为DecimalFormat
    protected NumberFormat numberFormat;
}

public class DecimalFormat extends NumberFormat {
    //DecimalFormat中的全局变量，用来存放转化好的数据
    //digitList用科学技计数表示，如2019表示成0.2019x10^4
    private transient DigitList digitList = new DigitList();
}

这两个变量的初始化在SimpleDateFormat的构造方法里初始化。
看了类结构，我们仔细分析一下DateFormat的parse方法，直接上代码(省略掉了一些无关紧要的代码)：

public Date parse(String text, ParsePosition pos)
{
    ......
    //注意这个变量calb，日期的转化是通过CalendarBuilder这个类来完成的
    CalendarBuilder calb = new CalendarBuilder();

    //按照DateFormat的pattern逐个循环(年月日时分秒...)
    for (int i = 0; i < compiledPattern.length; ) {
        ......
        //最终调用subParse方法给calb赋值
        start = subParse(text, start, tag, count, obeyCount, ambiguousYear, pos, useFollowingMinusSignAsDelimiter, calb);
    }
    Date parsedDate;
    try {
        //调用CalendarBuilder的establish方法，把值传递给变量calendar
        //通过calendar来获取最终返回的日期
        //注意，这里calendar是个全局变量
        parsedDate = calb.establish(calendar).getTime();
    }
    ......

    return parsedDate;
}

主要分为如下几个步骤：

• 定义一个CalendarBuilder对象calb，用来临时保存parse结果。
• 根据DateFormat定义的Pattern，for循环调用subParse方法，将目标字符串逐个(年月日时分秒...)转化，并存储在calb变量里。
• 调用calb.establish(calendar)方法，把暂存在calb里的数据设置到全局变量calendar里。
• 现在calendar里已经包含转换过的日期数据，最后调用Calendar.getTime()方法返回日期。

前面说到，方法会先把parse好的值放到CalendarBuilder型的临时变量calb里面，然后调用establish方法，将calb中缓存的值设置到SimpleDateFormat的calendar变量中，下面看看establish方法：

class CalendarBuilder {
    Calendar establish(Calendar cal) {
        ......
        //这个cal是SimpleDateFormat中的成员变量calendar
        //先将cal中的数据清除初始化，跟上面digitList一样的套路
        cal.clear();
        
        for (int stamp = MINIMUM_USER_STAMP; stamp < nextStamp; stamp++) {
            for (int index = 0; index <= maxFieldIndex; index++) {
                if (field[index] == stamp) {
                    //前面CalendarBuild暂存的值都放在field数组里，
                    //这里将数组中的值逐个赋给cal
                    cal.set(index, field[MAX_FIELD + index]);
                    break;
                }
            }
        }

        if (weekDate) {
            //设置cal的weekdate field
            cal.setWeekDate(field[MAX_FIELD + WEEK_YEAR], weekOfYear, dayOfWeek);
        }
        return cal;
    }
}

还是同样的问题，由于calendar(cal)是个全局变量，当多个线程同时调用establish方法的时候，会有线程安全问题。举个简单的例子，线程A原先赋值好了"2019/11/11 11:11:11"，结果线程B调用了cal.clear()将数据又给清掉了，于是线程A回到了解放前，输出了日期"1970/01/01 00:00:00"。

3、解决问题方法

方法一：定义局部变量

public static String getNowStr() {
        //把格式化定义到方法里面
        public static SimpleDateFormat dataTimeFormat = new SimpleDateFormat(
			"yyyy-MM-dd HH:mm:ss");
		return dataTimeFormat.format(new Date());
	}

方法二：给方法加同步synchronize关键字

相当于线程只能一个一个地访问parse方法：

    synchronize (this) {
        System.out.println(format.parse("2022/10/11 11:11:11"));
    }

方法三：不要用SimpleDateFormat，而是用Java8新引入的类LocalDateTime或者DateTimeFormatter，不仅线程安全，而且效率更高。

LocalDateTime time1 = LocalDateTime.now();
String = time1.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"))