SimpleDateFormat 的執行緒安全問題與解決方案
1. 原因
SimpleDateFormat(下面簡稱sdf)類內部有一個Calendar物件引用,它用來儲存和這個sdf相關的日期資訊,例如sdf.parse(dateStr), sdf.format(date) 諸如此類的方法引數傳入的日期相關String, Date等等, 都是交友Calendar引用來儲存的.這樣就會導致一個問題,如果你的sdf是個static的, 那麼多個thread 之間就會共享這個sdf, 同時也是共享這個Calendar引用, 並且, 觀察 sdf.parse() 方法,你會發現有如下的呼叫:
Date parse() { 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
2、問題重現：
import java.text.ParseException; import java.text.SimpleDateFormat; import java.util.Date; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.TimeUnit; /** * @author zhenwei.liu created on 2013 13-8-29 下午5:35 * @version $Id$ */ public class DateFormatTest extends Thread { private static SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd"); private String name; private String dateStr; private boolean sleep; public DateFormatTest(String name, String dateStr, boolean sleep) { this.name = name; this.dateStr = dateStr; this.sleep = sleep; } @Override public void run() { Date date = null; if (sleep) { try { TimeUnit.MILLISECONDS.sleep(2000); } catch (InterruptedException e) { e.printStackTrace(); } } try { date = sdf.parse(dateStr); } catch (ParseException e) { e.printStackTrace(); } System.out.println(name + " : date: " + date); } public static void main(String[] args) throws InterruptedException { ExecutorService executor = Executors.newCachedThreadPool(); // A 會sleep 2s 後開始執行sdf.parse() executor.execute(new DateFormatTest("A", "1991-09-13", true)); // B 打了斷點,會卡在方法中間 executor.execute(new DateFormatTest("B", "2013-09-13", false)); executor.shutdown(); } }
使用Debug模式執行這段程式碼,並在sdf.parse()方法裡打上斷點
parse() {
calendar.clear()
// 這裡打一個斷點
calendar.getTime()
}過程:
1) 首先A執行緒跑起來以後會進入sleep
2) B執行緒跑起來, 卡在斷點處
3) A執行緒醒過來, 執行 calendar.clear(), 並將設定sdf.calendar的date為1991-09-13, 此時 A B 的 calendar 都為 1991-09-13
4) 讓斷點繼續執行, 輸出如下
A : date: Fri Sep 13 00:00:00 CDT 1991 B : date: Fri Sep 13 00:00:00 CDT 1991
這並不是我們期待的結果
3. 解決方案
1）最簡單的解決方案我們可以把static去掉：
這樣每個新的執行緒都會有一個自己的sdf例項,從而避免執行緒安全的問題，然而,使用這種方法,在高併發的情況下會大量的new sdf以及銷燬sdf,這樣是非常耗費資源的。在併發情況下,網站的請求任務與執行緒執行情況大概可以理解為如下
例如Tomcat的執行緒池的最大Thread數為4, 現在需要執行的任務有1000個(理解為有1000個使用者點了你的網站的某個功能)，而這1000個任務都會用到我們寫的日期函式處理類。 假如說日期函式處理類使用的是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解決sdf多執行緒問題的例子
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
/**
* @author zhenwei.liu created on 2013 13-8-29 下午5:35
* @version $Id$
*/
public class DateUtil {
/** 鎖物件 */
private static final Object lockObj = new Object();
/** 存放不同的日期模板格式的sdf的Map */
private static Map<String, ThreadLocal<SimpleDateFormat>> sdfMap = new HashMap<String, ThreadLocal<SimpleDateFormat>>();
/**
* 返回一個ThreadLocal的sdf,每個執行緒只會new一次sdf
*
* @param pattern
* @return
*/
private static SimpleDateFormat getSdf(final String pattern) {
ThreadLocal<SimpleDateFormat> tl = sdfMap.get(pattern);
// 此處的雙重判斷和同步是為了防止sdfMap這個單例被多次put重複的sdf
if (tl == null) {
synchronized (lockObj) {
tl = sdfMap.get(pattern);
if (tl == null) {
// 只有Map中還沒有這個pattern的sdf才會生成新的sdf並放入map
System.out.println("put new sdf of pattern " + pattern + " to map");
// 這裡是關鍵,使用ThreadLocal<SimpleDateFormat>替代原來直接new SimpleDateFormat
tl = new ThreadLocal<SimpleDateFormat>() {
@Override
protected SimpleDateFormat initialValue() {
System.out.println("thread: " + Thread.currentThread() + " init pattern: " + pattern);
return new SimpleDateFormat(pattern);
}
};
sdfMap.put(pattern, tl);
}
}
}
return tl.get();
}
/**
* 是用ThreadLocal<SimpleDateFormat>來獲取SimpleDateFormat,這樣每個執行緒只會有一個SimpleDateFormat
*
* @param date
* @param pattern
* @return
*/
public static String format(Date date, String pattern) {
return getSdf(pattern).format(date);
}
public static Date parse(String dateStr, String pattern) throws ParseException {
return getSdf(pattern).parse(dateStr);
}
}測試類
import java.text.ParseException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;
/**
* @author zhenyu.nie created on 2013 13-8-26 下午2:13
* @version 1.0.0
*/
public class Test {
public static void main(String[] args) {
final String patten1 = "yyyy-MM-dd";
final String patten2 = "yyyy-MM";
Thread t1 = new Thread() {
@Override
public void run() {
try {
DateUtil.parse("1992-09-13", patten1);
} catch (ParseException e) {
e.printStackTrace();
}
}
};
Thread t2 = new Thread() {
@Override
public void run() {
try {
DateUtil.parse("2000-09", patten2);
} catch (ParseException e) {
e.printStackTrace();
}
}
};
Thread t3 = new Thread() {
@Override
public void run() {
try {
DateUtil.parse("1992-09-13", patten1);
} catch (ParseException e) {
e.printStackTrace();
}
}
};
Thread t4 = new Thread() {
@Override
public void run() {
try {
DateUtil.parse("2000-09", patten2);
} catch (ParseException e) {
e.printStackTrace();
}
}
};
Thread t5 = new Thread() {
@Override
public void run() {
try {
DateUtil.parse("2000-09-13", patten1);
} catch (ParseException e) {
e.printStackTrace();
}
}
};
Thread t6 = new Thread() {
@Override
public void run() {
try {
DateUtil.parse("2000-09", patten2);
} catch (ParseException e) {
e.printStackTrace();
}
}
};
System.out.println("單執行緒執行: ");
ExecutorService exec = Executors.newFixedThreadPool(1);
exec.execute(t1);
exec.execute(t2);
exec.execute(t3);
exec.execute(t4);
exec.execute(t5);
exec.execute(t6);
exec.shutdown();
sleep(1000);
System.out.println("雙執行緒執行: ");
ExecutorService exec2 = Executors.newFixedThreadPool(2);
exec2.execute(t1);
exec2.execute(t2);
exec2.execute(t3);
exec2.execute(t4);
exec2.execute(t5);
exec2.execute(t6);
exec2.shutdown();
}
private static void sleep(long millSec) {
try {
TimeUnit.MILLISECONDS.sleep(millSec);
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}輸出
單執行緒執行:
put new sdf of pattern yyyy-MM-dd to map
thread: Thread[pool-1-thread-1,5,main] init pattern: yyyy-MM-dd
put new sdf of pattern yyyy-MM to map
thread: Thread[pool-1-thread-1,5,main] init pattern: yyyy-MM
雙執行緒執行:
thread: Thread[pool-2-thread-1,5,main] init pattern: yyyy-MM-dd
thread: Thread[pool-2-thread-2,5,main] init pattern: yyyy-MM
thread: Thread[pool-2-thread-1,5,main] init pattern: yyyy-MM
thread: Thread[pool-2-thread-2,5,main] init pattern: yyyy-MM-dd從輸出我們可以看出：
A、1個執行緒執行這6個任務的時候,這個執行緒首次使用過的時候會new一個新的sdf,並且以後都一直用這個sdf,而不是每次處理任務都新建一個新的sdf
B、2個執行緒執行6個任務的時候也是同理,但是2個執行緒的sdf是分開的,每個執行緒都有自己的"yyyy-MM-dd", "yyyy-MM"的sdf,所以他們不會有執行緒安全安全問題
試想,如果使用的是new的實現方法,那麼不管是用1個執行緒去執行,還是用2個執行緒去執行這6個任務,都需要new 6個sdf
3）使用同步程式碼塊（synchronized）或者使用裝飾器設計模式包裝下 SimpleDateFormat ，使之變得執行緒安全。
4）第四種方式，使用第三方日期處理函式：比如 JODA 來避免這些問題，你也可以使用 commons-lang 包中的 FastDateFormat 工具類。