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

原文：http://www.cnblogs.com/zemliu/archive/2013/08/29/3290585.html

以前写多线程代码的情况比较少，一直没有注意这个问题，直到今天才发现。

我发现，一般我们写DateUtils工具类，都是先创建几个SimpleDateFormat静态常量供下面的方法使用，没有考虑多线程的问题。

原因

SimpleDateFormat(下面简称sdf)类内部有一个Calendar对象引用，它用来储存和这个sdf相关的日期信息，例如sdf.parse(dateStr)，sdf.format(date)诸如此类的方法参数传入的日期相关String，Date等等，都是交由Calendar引用来储存的.这样就会导致一个问题，如果你的sdf是个static的，那么多个thread之间就会共享这个sdf，同时也是共享这个Calendar引用，并且，观察sdf.parse()方法，你会发现有如下的调用:

public Date parse(String text, ParsePosition pos) {

	calendar.clear(); // 清理calendar

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

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

}

这里会导致的问题就是,如果线程A调用了sdf.parse(),并且进行了calendar.clear()后还未执行calendar.getTime()的时候,线程B又调用了sdf.parse(),这时候线程B也执行了sdf.clear()方法,这样就导致线程A的的calendar数据被清空了(实际上A,B的同时被清空了).又或者当A执行了calendar.clear()后被挂起,这时候B开始调用sdf.parse()并顺利i结束,这样A的calendar内存储的的date变成了后来B设置的calendar的date

解决方案

最简单的解决方案就是每次都创建一个SimpleDateFormat对象，这样在多线程的环境下就不会有问题。

但是这种方案，在高并发的情况下，会大量的创建、销毁SimpleDateFormat对象，特别消耗资源。

在并发情况下,网站的请求任务与线程执行情况大概可以理解为如下

例如Tomcat的线程池的最大Thread数为4, 现在需要执行的任务有1000个(理解为有1000个用户点了你的网站的某个功能),

而这1000个任务都会用到我们写的日期函数处理类

1) 假如说日期函数处理类使用的是new SimpleDateFormat的方法,那么这里就会有1000次sdf的创建和销毁

2) Java中提供了一种ThreadLocal的解决方案,它的工作方式是,每个线程只会有一个实例,也就是说我们执行完这1000个任务,总共只会实例化4个sdf.

而且,它并不会有多线程的并发问题,因为,单个线程执行任务肯定是顺序的,例如Thread #1负责执行Task #1-#250, 那么他是顺序而执行Task #1-#250；而Thread #2拥有自己的sdf实例,他也是顺序执行任务 Task #251-#500, 以此类推

下面是一个使用ThreadLocal解决SimpleDateFormat多线程问题的例子

import java.lang.ref.SoftReference;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import java.util.TimeZone;

public final class DateUtils {
	public static final TimeZone GMT = TimeZone.getTimeZone("GMT");

	/**
	 * 将字符串转为Date类型
	 * 
	 * @param dateValue
	 *            字符串日期
	 * @param dateFormat
	 *            格式
	 * @return
	 * @throws ParseException
	 */
	public static Date parseDate(String dateValue, String dateFormat) throws ParseException {
		SimpleDateFormat dateParser = DateFormatHolder.formatFor(dateFormat);
		return dateParser.parse(dateValue);
	}

	/**
	 * 格式化指定日期的字符串
	 * 
	 * @param date
	 *            日期
	 * @return
	 */
	public static String formatDate(Date date) {
		return formatDate(date, "yyy-mm-dd");
	}

	/**
	 * 格式化自定日期的字符串
	 * 
	 * @param date
	 *            日期
	 * @param pattern
	 *            格式
	 * @return
	 */
	public static String formatDate(Date date, String pattern) {
		if (date == null)
			throw new IllegalArgumentException("date is null");
		if (pattern == null)
			throw new IllegalArgumentException("pattern is null");

		SimpleDateFormat formatter = DateFormatHolder.formatFor(pattern);
		return formatter.format(date);
	}

	/**
	 * 
	 * @ClassName: DateFormatHolder
	 * @Description: 日期格式化帮助类
	 * @author yinjw
	 * @date 2014-11-6 上午11:43:59
	 * 
	 */
	static final class DateFormatHolder {
		@SuppressWarnings({ "unchecked", "rawtypes" })
		private static final ThreadLocal<SoftReference<Map<String, SimpleDateFormat>>> THREADLOCAL_FORMATS = new ThreadLocal() {
			protected SoftReference<Map<String, SimpleDateFormat>> initialValue() {
				return new SoftReference(new HashMap());
			}
		};

		/**
		 * 获取SimpleDateFormat对象
		 * 
		 * @param pattern
		 *            格式
		 * @return
		 */
		@SuppressWarnings({ "unchecked", "rawtypes" })
		public static SimpleDateFormat formatFor(String pattern) {
			SoftReference ref = (SoftReference) THREADLOCAL_FORMATS.get();
			Map formats = (Map) ref.get();
			if (formats == null) {
				formats = new HashMap();
				THREADLOCAL_FORMATS.set(new SoftReference(formats));
			}

			SimpleDateFormat format = (SimpleDateFormat) formats.get(pattern);
			if (format == null) {
				format = new SimpleDateFormat(pattern);
				formats.put(pattern, format);
			}
			return format;
		}
	}
}