写点什么

SimpleDateFormat 线程不安全了?这里有 5 种解决方案

发布于: 刚刚

​​摘要:我们知道 SimpleDateFormat 是线程不安全,本文会介绍多种解决方案来保证线程安全。

 

本文分享自华为云社区《java的SimpleDateFormat线程不安全出问题了,虚竹教你多种解决方案》,作者:小虚竹 。

1、场景


在 java8 以前,要格式化日期时间,就需要用到 SimpleDateFormat

但我们知道 SimpleDateFormat 是线程不安全的,处理时要特别小心,要加锁或者不能定义为 static,要在方法内 new 出对象,再进行格式化。很麻烦,而且重复地 new 出对象,也加大了内存开销。

2、SimpleDateFormat 线程为什么是线程不安全的呢?


来看看 SimpleDateFormat 的源码,先看 format 方法:


// Called from Format after creating a FieldDelegate    private StringBuffer format(Date date, StringBuffer toAppendTo,                                FieldDelegate delegate) {        // Convert input date to time field list        calendar.setTime(date);		...    }
复制代码


问题就出在成员变量 calendar,如果在使用 SimpleDateFormat 时,用 static 定义,那 SimpleDateFormat 变成了共享变量。那 SimpleDateFormat 中的 calendar 就可以被多个线程访问到。


SimpleDateFormat 的 parse 方法也是线程不安全的:


public Date parse(String text, ParsePosition pos)    {     ...         Date parsedDate;        try {            parsedDate = calb.establish(calendar).getTime();            // If the year value is ambiguous,            // then the two-digit year == the default start year            if (ambiguousYear[0]) {                if (parsedDate.before(defaultCenturyStart)) {                    parsedDate = calb.addYear(100).establish(calendar).getTime();                }            }        }        // An IllegalArgumentException will be thrown by Calendar.getTime()        // if any fields are out of range, e.g., MONTH == 17.        catch (IllegalArgumentException e) {            pos.errorIndex = start;            pos.index = oldStart;            return null;        }
return parsedDate; }
复制代码


由源码可知,最后是调用**parsedDate= calb.establish(calendar).getTime();**获取返回值。方法的参数是 calendar,calendar 可以被多个线程访问到,存在线程不安全问题。


我们再来看看**calb.establish(calendar)**的源码



calb.establish(calendar)方法先后调用了 cal.clear()和 cal.set(),先清理值,再设值。但是这两个操作并不是原子性的,也没有线程安全机制来保证,导致多线程并发时,可能会引起 cal 的值出现问题了。

2.1 验证 SimpleDateFormat 线程不安全


public class SimpleDateFormatDemoTest {
private static SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
public static void main(String[] args) { //1、创建线程池 ExecutorService pool = Executors.newFixedThreadPool(5); //2、为线程池分配任务 ThreadPoolTest threadPoolTest = new ThreadPoolTest(); for (int i = 0; i < 10; i++) { pool.submit(threadPoolTest); } //3、关闭线程池 pool.shutdown(); } static class ThreadPoolTest implements Runnable{
@Override public void run() { String dateString = simpleDateFormat.format(new Date()); try { Date parseDate = simpleDateFormat.parse(dateString); String dateString2 = simpleDateFormat.format(parseDate); System.out.println(Thread.currentThread().getName()+" 线程是否安全: "+dateString.equals(dateString2)); } catch (Exception e) { System.out.println(Thread.currentThread().getName()+" 格式化失败 "); } } }}
复制代码



出现了两次 false,说明线程是不安全的。而且还抛异常,这个就严重了。

3、解决方案

3.1 解决方案 1:不要定义为 static 变量,使用局部变量


就是要使用 SimpleDateFormat 对象进行 format 或 parse 时,再定义为局部变量。就能保证线程安全。


public class SimpleDateFormatDemoTest1 {
public static void main(String[] args) { //1、创建线程池 ExecutorService pool = Executors.newFixedThreadPool(5); //2、为线程池分配任务 ThreadPoolTest threadPoolTest = new ThreadPoolTest(); for (int i = 0; i < 10; i++) { pool.submit(threadPoolTest); } //3、关闭线程池 pool.shutdown(); } static class ThreadPoolTest implements Runnable{
@Override public void run() { SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"); String dateString = simpleDateFormat.format(new Date()); try { Date parseDate = simpleDateFormat.parse(dateString); String dateString2 = simpleDateFormat.format(parseDate); System.out.println(Thread.currentThread().getName()+" 线程是否安全: "+dateString.equals(dateString2)); } catch (Exception e) { System.out.println(Thread.currentThread().getName()+" 格式化失败 "); } } }}
复制代码



由图可知,已经保证了线程安全,但这种方案不建议在高并发场景下使用,因为会创建大量的 SimpleDateFormat 对象,影响性能。

3.2 解决方案 2:加锁:synchronized 锁和 Lock 锁

3.2.1 加 synchronized 锁


SimpleDateFormat 对象还是定义为全局变量,然后需要调用 SimpleDateFormat 进行格式化时间时,再用 synchronized 保证线程安全。


public class SimpleDateFormatDemoTest2 {
private static SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
public static void main(String[] args) { //1、创建线程池 ExecutorService pool = Executors.newFixedThreadPool(5); //2、为线程池分配任务 ThreadPoolTest threadPoolTest = new ThreadPoolTest(); for (int i = 0; i < 10; i++) { pool.submit(threadPoolTest); } //3、关闭线程池 pool.shutdown(); }
static class ThreadPoolTest implements Runnable{
@Override public void run() { try { synchronized (simpleDateFormat){ String dateString = simpleDateFormat.format(new Date()); Date parseDate = simpleDateFormat.parse(dateString); String dateString2 = simpleDateFormat.format(parseDate); System.out.println(Thread.currentThread().getName()+" 线程是否安全: "+dateString.equals(dateString2)); } } catch (Exception e) { System.out.println(Thread.currentThread().getName()+" 格式化失败 "); } } }}
复制代码



如图所示,线程是安全的。定义了全局变量 SimpleDateFormat,减少了创建大量 SimpleDateFormat 对象的损耗。但是使用 synchronized 锁,同一时刻只有一个线程能执行锁住的代码块,在高并发的情况下会影响性能。但这种方案不建议在高并发场景下使用

3.2.2 加 Lock 锁


加 Lock 锁和 synchronized 锁原理是一样的,都是使用锁机制保证线程的安全。


public class SimpleDateFormatDemoTest3 {
private static SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"); private static Lock lock = new ReentrantLock(); public static void main(String[] args) { //1、创建线程池 ExecutorService pool = Executors.newFixedThreadPool(5); //2、为线程池分配任务 ThreadPoolTest threadPoolTest = new ThreadPoolTest(); for (int i = 0; i < 10; i++) { pool.submit(threadPoolTest); } //3、关闭线程池 pool.shutdown(); }
static class ThreadPoolTest implements Runnable{
@Override public void run() { try { lock.lock(); String dateString = simpleDateFormat.format(new Date()); Date parseDate = simpleDateFormat.parse(dateString); String dateString2 = simpleDateFormat.format(parseDate); System.out.println(Thread.currentThread().getName()+" 线程是否安全: "+dateString.equals(dateString2)); } catch (Exception e) { System.out.println(Thread.currentThread().getName()+" 格式化失败 "); }finally { lock.unlock(); } } }}
复制代码



由结果可知,加 Lock 锁也能保证线程安全。要注意的是,最后一定要释放锁,代码里在 finally 里增加了 lock.unlock();,保证释放锁。

在高并发的情况下会影响性能。这种方案不建议在高并发场景下使用

3.3 解决方案 3:使用 ThreadLocal 方式


使用 ThreadLocal 保证每一个线程有 SimpleDateFormat 对象副本。这样就能保证线程的安全。


public class SimpleDateFormatDemoTest4 {
private static ThreadLocal<DateFormat> threadLocal = new ThreadLocal<DateFormat>(){ @Override protected DateFormat initialValue() { return new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"); } }; public static void main(String[] args) { //1、创建线程池 ExecutorService pool = Executors.newFixedThreadPool(5); //2、为线程池分配任务 ThreadPoolTest threadPoolTest = new ThreadPoolTest(); for (int i = 0; i < 10; i++) { pool.submit(threadPoolTest); } //3、关闭线程池 pool.shutdown(); }
static class ThreadPoolTest implements Runnable{
@Override public void run() { try { String dateString = threadLocal.get().format(new Date()); Date parseDate = threadLocal.get().parse(dateString); String dateString2 = threadLocal.get().format(parseDate); System.out.println(Thread.currentThread().getName()+" 线程是否安全: "+dateString.equals(dateString2)); } catch (Exception e) { System.out.println(Thread.currentThread().getName()+" 格式化失败 "); }finally { //避免内存泄漏,使用完threadLocal后要调用remove方法清除数据 threadLocal.remove(); } } }}
复制代码



使用 ThreadLocal 能保证线程安全,且效率也是挺高的。适合高并发场景使用

3.4 解决方案 4:使用 DateTimeFormatter 代替 SimpleDateFormat


使用 DateTimeFormatter 代替 SimpleDateFormat(DateTimeFormatter 是线程安全的,java 8+支持)


DateTimeFormatter 介绍 传送门:万字博文教你搞懂java源码的日期和时间相关用法


public class DateTimeFormatterDemoTest5 {	private static DateTimeFormatter dateTimeFormatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
public static void main(String[] args) { //1、创建线程池 ExecutorService pool = Executors.newFixedThreadPool(5); //2、为线程池分配任务 ThreadPoolTest threadPoolTest = new ThreadPoolTest(); for (int i = 0; i < 10; i++) { pool.submit(threadPoolTest); } //3、关闭线程池 pool.shutdown(); } static class ThreadPoolTest implements Runnable{
@Override public void run() { try { String dateString = dateTimeFormatter.format(LocalDateTime.now()); TemporalAccessor temporalAccessor = dateTimeFormatter.parse(dateString); String dateString2 = dateTimeFormatter.format(temporalAccessor); System.out.println(Thread.currentThread().getName()+" 线程是否安全: "+dateString.equals(dateString2)); } catch (Exception e) { e.printStackTrace(); System.out.println(Thread.currentThread().getName()+" 格式化失败 "); } } }}
复制代码



使用 DateTimeFormatter 能保证线程安全,且效率也是挺高的。适合高并发场景使用

3.5 解决方案 5:使用 FastDateFormat 替换 SimpleDateFormat


使用 FastDateFormat 替换 SimpleDateFormat(FastDateFormat 是线程安全的,Apache Commons Lang 包支持,不受限于 java 版本)


public class FastDateFormatDemo6 {	private static FastDateFormat fastDateFormat = FastDateFormat.getInstance("yyyy-MM-dd HH:mm:ss");
public static void main(String[] args) { //1、创建线程池 ExecutorService pool = Executors.newFixedThreadPool(5); //2、为线程池分配任务 ThreadPoolTest threadPoolTest = new ThreadPoolTest(); for (int i = 0; i < 10; i++) { pool.submit(threadPoolTest); } //3、关闭线程池 pool.shutdown(); } static class ThreadPoolTest implements Runnable{
@Override public void run() { try { String dateString = fastDateFormat.format(new Date()); Date parseDate = fastDateFormat.parse(dateString); String dateString2 = fastDateFormat.format(parseDate); System.out.println(Thread.currentThread().getName()+" 线程是否安全: "+dateString.equals(dateString2)); } catch (Exception e) { e.printStackTrace(); System.out.println(Thread.currentThread().getName()+" 格式化失败 "); } } }}
复制代码


使用 FastDateFormat 能保证线程安全,且效率也是挺高的。适合高并发场景使用

3.5.1 FastDateFormat 源码分析


Apache Commons Lang 3.5//FastDateFormat@Overridepublic String format(final Date date) {   return printer.format(date);}
@Override public String format(final Date date) { final Calendar c = Calendar.getInstance(timeZone, locale); c.setTime(date); return applyRulesToString(c); }
复制代码


源码中 Calender 是在 format 方法里创建的,肯定不会出现 setTime 的线程安全问题。这样线程安全疑惑解决了。那还有性能问题要考虑?


我们来看下 FastDateFormat 是怎么获取的


FastDateFormat.getInstance();FastDateFormat.getInstance(CHINESE_DATE_TIME_PATTERN);
复制代码


看下对应的源码


/** * 获得 FastDateFormat实例,使用默认格式和地区 * * @return FastDateFormat */public static FastDateFormat getInstance() {   return CACHE.getInstance();}
/** * 获得 FastDateFormat 实例,使用默认地区<br> * 支持缓存 * * @param pattern 使用{@link java.text.SimpleDateFormat} 相同的日期格式 * @return FastDateFormat * @throws IllegalArgumentException 日期格式问题 */public static FastDateFormat getInstance(final String pattern) { return CACHE.getInstance(pattern, null, null);}
复制代码


这里有用到一个 CACHE,看来用了缓存,往下看


private static final FormatCache<FastDateFormat> CACHE = new FormatCache<FastDateFormat>(){   @Override   protected FastDateFormat createInstance(final String pattern, final TimeZone timeZone, final Locale locale) {      return new FastDateFormat(pattern, timeZone, locale);   }};
//abstract class FormatCache<F extends Format> { ... private final ConcurrentMap<Tuple, F> cInstanceCache = new ConcurrentHashMap<>(7);
private static final ConcurrentMap<Tuple, String> C_DATE_TIME_INSTANCE_CACHE = new ConcurrentHashMap<>(7); ...}
复制代码



在 getInstance 方法中加了 ConcurrentMap 做缓存,提高了性能。且我们知道 ConcurrentMap 也是线程安全的。

3.5.2 实践


/** * 年月格式 {@link FastDateFormat}:yyyy-MM */public static final FastDateFormat NORM_MONTH_FORMAT = FastDateFormat.getInstance(NORM_MONTH_PATTERN);
复制代码



//FastDateFormatpublic static FastDateFormat getInstance(final String pattern) {   return CACHE.getInstance(pattern, null, null);}
复制代码




如图可证,是使用了 ConcurrentMap 做缓存。且 key 值是格式,时区和 locale(语境)三者都相同为相同的 key。

4、结论


1、不要定义为 static 变量,使用局部变量

2、加锁:synchronized 锁和 Lock 锁

3、使用 ThreadLocal 方式

4、使用 DateTimeFormatter 代替 SimpleDateFormat(DateTimeFormatter 是线程安全的,java 8+支持)

5、使用 FastDateFormat 替换 SimpleDateFormat(FastDateFormat 是线程安全的,Apache Commons Lang 包支持,java8 之前推荐此用法)


点击关注,第一时间了解华为云新鲜技术~

发布于: 刚刚阅读数: 2
用户头像

提供全面深入的云计算技术干货 2020.07.14 加入

华为云开发者社区,提供全面深入的云计算前景分析、丰富的技术干货、程序样例,分享华为云前沿资讯动态,方便开发者快速成长与发展,欢迎提问、互动,多方位了解云计算! 传送门:https://bbs.huaweicloud.com/

评论

发布
暂无评论
SimpleDateFormat线程不安全了?这里有5种解决方案