关于 SimpleDateFormat 的非线程安全问题及其解决方案

一直以来都是直接用SimpleDateFormat开发的,没想着考虑线程安全的问题,特记录下来(摘抄的):

1、问题:

先来看一段可能引起错误的代码:

package test.date;

import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Locale; public class ProveNotSafe {
static SimpleDateFormat df = new SimpleDateFormat("dd-MMM-yyyy", Locale.US);
static String testdata[] = { "01-Jan-1999", "14-Feb-2001", "31-Dec-2007" }; public static void main(String[] args) {
Runnable r[] = new Runnable[testdata.length];
for (int i = 0; i < r.length; i++) {
final int i2 = i;
r[i] = new Runnable() {
public void run() {
try {
for (int j = 0; j < 1000; j++) {
String str = testdata[i2];
String str2 = null;
/* synchronized(df) */{
Date d = df.parse(str);
str2 = df.format(d);
System.out.println("i: " + i2 + "\tj: " + j + "\tThreadID: "
+ Thread.currentThread().getId() + "\tThreadName: "
+ Thread.currentThread().getName() + "\t" + str + "\t" + str2);
}
if (!str.equals(str2)) {
throw new RuntimeException("date conversion failed after " + j
+ " iterations. Expected " + str + " but got " + str2);
}
}
} catch (ParseException e) {
throw new RuntimeException("parse failed");
}
}
};
new Thread(r[i]).start();
}
}
}

结果(随机失败):

i: 2    j: 0    ThreadID: 10    ThreadName: Thread-2    31-Dec-2007    31-Dec-2007
i: 2 j: 1 ThreadID: 10 ThreadName: Thread-2 31-Dec-2007 31-Dec-2007
i: 2 j: 2 ThreadID: 10 ThreadName: Thread-2 31-Dec-2007 31-Dec-2007
i: 2 j: 3 ThreadID: 10 ThreadName: Thread-2 31-Dec-2007 31-Dec-2007
i: 2 j: 4 ThreadID: 10 ThreadName: Thread-2 31-Dec-2007 31-Dec-2007
i: 2 j: 5 ThreadID: 10 ThreadName: Thread-2 31-Dec-2007 31-Dec-2007
i: 2 j: 6 ThreadID: 10 ThreadName: Thread-2 31-Dec-2007 31-Dec-2007
i: 2 j: 7 ThreadID: 10 ThreadName: Thread-2 31-Dec-2007 31-Dec-2007
i: 2 j: 8 ThreadID: 10 ThreadName: Thread-2 31-Dec-2007 31-Dec-2007
i: 2 j: 9 ThreadID: 10 ThreadName: Thread-2 31-Dec-2007 31-Dec-2007
i: 2 j: 10 ThreadID: 10 ThreadName: Thread-2 31-Dec-2007 31-Dec-2007
i: 2 j: 11 ThreadID: 10 ThreadName: Thread-2 31-Dec-2007 31-Dec-2007
i: 2 j: 12 ThreadID: 10 ThreadName: Thread-2 31-Dec-2007 31-Dec-2007
i: 2 j: 13 ThreadID: 10 ThreadName: Thread-2 31-Dec-2007 31-Dec-2007
i: 2 j: 14 ThreadID: 10 ThreadName: Thread-2 31-Dec-2007 31-Dec-2007
i: 2 j: 15 ThreadID: 10 ThreadName: Thread-2 31-Dec-2007 31-Dec-2007
i: 2 j: 16 ThreadID: 10 ThreadName: Thread-2 31-Dec-2007 31-Dec-2007
i: 2 j: 17 ThreadID: 10 ThreadName: Thread-2 31-Dec-2007 11-Jan-1999
i: 0 j: 0 ThreadID: 8 ThreadName: Thread-0 01-Jan-1999 11-Jan-1999
Exception in thread "Thread-2" i: 1 j: 0 ThreadID: 9 ThreadName: Thread-1 14-Feb-2001 11-Jan-2001
Exception in thread "Thread-0" java.lang.RuntimeException: date conversion failed after 0 iterations. Expected 01-Jan-1999 but got 11-Jan-1999
at test.date.ProveNotSafe$1.run(ProveNotSafe.java:30)
at java.lang.Thread.run(Thread.java:619)
Exception in thread "Thread-1" java.lang.RuntimeException: date conversion failed after 0 iterations. Expected 14-Feb-2001 but got 11-Jan-2001
at test.date.ProveNotSafe$1.run(ProveNotSafe.java:30)
at java.lang.Thread.run(Thread.java:619)
java.lang.RuntimeException: date conversion failed after 17 iterations. Expected 31-Dec-2007 but got 11-Jan-1999
at test.date.ProveNotSafe$1.run(ProveNotSafe.java:30)
at java.lang.Thread.run(Thread.java:619)

恩,原因你是知道了,这是由于  SimpleDateFormat 的非线程安全问题引起的,

我们现在简化下问题,错误的代码应该是这样的:

import java.text.SimpleDateFormat;
import java.util.Date; public class DateUtil { SimpleDateFormat sdf = new SimpleDateFormat("dd/MM/yyyy"); public String formatDate(Date input) {
return sdf.format(input);
} }

2、解决方案

(1)使用局部变量:

import java.text.SimpleDateFormat;
import java.util.Date; public class DateUtil { private static final String SIMPLE_FORMAT = "dd/MM/yyyy"; public String formatDate(Date input) { if(input == null){
return null;
} SimpleDateFormat sdf = new SimpleDateFormat(SIMPLE_FORMAT);//local variable
return sdf.format(input);
}
}

恩,这是线程安全的了,不是吗?

(2)使用 ThreadLocal

这里每个线程将有它自己的 SimpleDateFormat 副本。

import java.text.SimpleDateFormat;
import java.util.Date; public class DateUtil { // anonymous inner class. Each thread will have its own copy of the SimpleDateFormat
private final static ThreadLocal<simpledateformat> tl = new ThreadLocal<simpledateformat>() {
protected SimpleDateFormat initialValue() {
return new SimpleDateFormat("dd/MM/yyyy");
}
};http://my.oschina.net/huangyong/blog/159725 public String formatDate(Date input) {
if (input == null) {
return null;
} return tl.get().format(input);
}
}

PS:顺便聊聊这个 ThreadLocal:

ThreadLocal 按我的理解是一个Map容器,视作其key是当前线程,value就是我们想保证数据安全一致的某对象。从它的功能上来说,应该叫做 ThreadLocalVariable(线程局部变量)更合适些。

具体的含义与作用请参考如下两篇文摘:ThreadLocal 那点事儿

http://my.oschina.net/huangyong/blog/159489

http://my.oschina.net/huangyong/blog/159725

(3)同步代码块 synchronized(code)

或者使用装饰器设计模式包装下 SimpleDateFormat ,使之变得线程安全。

(4)使用第三方的日期处理函数:

比如 JODA 来避免这些问题,你也可以使用 commons-lang 包中的 FastDateFormat 工具类。

(5)最后的提问:

上面几种方案中,有最佳方案吗?如果不是最佳,各有什么优劣?

PS:

顺便吐槽下 java 的日期处理类真TMD是个渣。。。有坑不说,关键是难用。。。这点 shell 的 date 命令应该是用户体验做的最好的了~ 

REF:

http://java-success.blogspot.com/2012/07/java-coding-question-and-answer-on.html

http://www.codefutures.com/weblog/andygrove/2007/10/simpledateformat-and-thread-safety.html

关于变量的线程安全问题,请参考:

java 线程安全问题之静态变量、实例变量、局部变量

http://my.oschina.net/leejun2005/blog/130043

关于 SimpleDateFormat 的非线程安全问题及其解决方案的相关教程结束。

相关推荐:

如何在 Tkinter 中安全地将走法计算移至独立线程

本文详解如何通过单例工作线程+队列机制,避免多线程竞争与ui冻结,实现在tkinter棋类游戏中异步执行ai走法计算,同时保障界面响应性与逻辑一致性。 本文详解如何通过单例工作线程+队列机制,避免多线程竞争与ui冻结,实现在tkinter棋类游戏中异步执行ai走法计算,同时保障界面响应性与逻辑一致性...

Plotly 图像导出在 Windows 11 上卡死的解决方案

在Windows11中使用Plotly的write_image()导出PNG时进程无响应,根本原因是Kaleido依赖版本存在兼容性问题;降级至kaleido==0.1.0.post1可稳定解决该问题。 在windows11中使用plotly的`write_image()`导出png时进程无响应,根...

如何在 GUI 应用中安全地多次启停测量线程

本文介绍如何在长期运行的gui主循环中,通过事件(event)机制灵活控制后台测量线程的启停,避免“线程无法重复启动”问题,实现可反复启用/暂停/终止的可靠多线程测量逻辑。 本文介绍如何在长期运行的gui主循环中,通过事件(event)机制灵活控制后台测量线程的启停,避免“线程无法重复启动”问题,实...

如何在 Tkinter 中安全地将走法计算移至独立线程以避免界面卡顿

本文介绍如何通过单例工作线程+队列机制,将跳棋AI的深度搜索计算(如__predict_optimal_moves)完全剥离出Tkinter主线程,从而彻底解决界面冻结问题,同时避免多线程竞争和重复启动开销。 本文介绍如何通过单例工作线程+队列机制,将跳棋ai的深度搜索计算(如`__predict_...