Java 日期格式化与解析是一项日常(痛苦的)任务,每天都让我们头痛不已。

通常使用 SimpleDateFormat,下面是一个常见的日期工具类。

import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
public final class DateUtils {
    public static final SimpleDateFormat SIMPLE_DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd");
    private DateUtils() {}
    public static Date parse(String target) {
        try {
            return SIMPLE_DATE_FORMAT.parse(target);
        } catch (ParseException e) {
            e.printStackTrace();
        }
        return null;
    }
    public static String format(Date target) {
        return SIMPLE_DATE_FORMAT.format(target);
    }
}

感觉可以按预期运行并输出结果吗?让我们试一下。

private static void testSimpleDateFormatInSingleThread() {
    final String source = "2019-01-11";
    System.out.println(DateUtils.parse(source));
}
// Fri Jan 11 00:00:00 IST 2019

运行成功,让我们加上多线程。

private static void testSimpleDateFormatWithThreads() {
    ExecutorService executorService = Executors.newFixedThreadPool(10);
    final String source = "2019-01-11";
    System.out.println(":: parsing date string ::");
    IntStream.rangeClosed(0, 20)
            .forEach((i) -> executorService.submit(() -> System.out.println(DateUtils.parse(source))));
    executorService.shutdown();
}

下面是我得到的运行结果。

:: parsing date string ::
... omitted
Fri Jan 11 00:00:00 IST 2019
Sat Jul 11 00:00:00 IST 2111
Fri Jan 11 00:00:00 IST 2019
... omitted

结果看上去很奇怪,对吧?这是大多数人用 Java 格式化日期时常犯的一个错误。为什么会有这种奇怪的结果?因为没有考虑到到线程安全。以下是 Java 文档有关 SimpleDateFormat 的描述:

日期格式是非同步的。 建议为每个线程创建单独的日期格式化实例。
如果多个线程并发访问某个格式化实例,则必须保证外部调用同步性。

提示:使用实例变量时,应该每次检查这个类是不是线程安全。

正如文档中提到的那样,可以为每个线程设置不同实例来解决这个问题。如果要共享实例,该如何实现?

  1. ThreadLocal

可以使用 ThreadLocal 解决。Threadlocal 的 get() 方法会给当前线程提供正确的值。

import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
public final class DateUtilsThreadLocal {
    public static final ThreadLocal SIMPLE_DATE_FORMAT = ThreadLocal
            .withInitial(() -> new SimpleDateFormat("yyyy-MM-dd"));
    private DateUtilsThreadLocal() {}
    public static Date parse(String target) {
        try {
            return ((DateFormat) SIMPLE_DATE_FORMAT.get()).parse(target);
        } catch (ParseException e) {
            e.printStackTrace();
        }
        return null;
    }
    public static String format(Date target) {
        return ((DateFormat) SIMPLE_DATE_FORMAT.get()).format(target);
    }
}

译注:实际运行时需要加上强制类型转换,否则报告编译错误。

  1. Java 8 线程安全的时间日期 API

Java8 引入了新的日期时间 API,SimpleDateFormat 有了更好的替代者。如果继续坚持使用 SimpleDateFormat 可以配合 ThreadLocal 一起使用。但既然已经有了更好的选择,还是考虑用新的 API。

Java 8 提供了几个线程安全的日期类,Java 文档中这么描述:

“这个类是具有不可变和线程安全的特点。”

非常值得学习这些类的用法,包括 DateTimeFormatter、OffsetDateTime、ZonedDateTime、LocalDateTime、LocalDate 和 LocalTime。

使用新 API 后的代码:

import java.time.LocalDate;
import java.time.format.DateTimeFormatter;
public class DateUtilsJava8 {
    public static final DateTimeFormatter DATE_TIME_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd");
    private DateUtilsJava8() {}
    public static LocalDate parse(String target) {
        return LocalDate.parse(target, DATE_TIME_FORMATTER);
    }
    public static String format(LocalDate target) {
        return target.format(DATE_TIME_FORMATTER);
    }
}

总结

Java 8 提供的不可变时间是一种解决多日期类线程问题的最佳实践。不可变类本质上是线程安全的,应当尽可能使用。