Java 中SimpleDateFormat 错误用法及改正

开发 Java 项目时经常操作时间、日期与字符串的互相转换，最常见简单的方式是使用 SimpleDateFormat，想必大家对它不陌生。 虽然它简单易用，如果没有正确使用，在一般环境下使用通常不会出错，但在高并发（Highly Concurrent）的环境下就可能会出现异常。

我们都知道在程序中应尽量少使用 ，因为若频繁实例化，则需要花费较多的成本，因此我们尽可能共用同一个实例。 假设有一个转换日期时间的代码如下：

public class DateUtil {

    private static final SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd hh:mm:ss");
        
    public static String format(Date date) {
        return simpleDateFormat.format(date);
    }
}

不幸的是， 就是最典型的错误用法。 官方文件提到：共用 SimpleDateFormat

Date formats are not synchronized. It is recommended to create
separate format instances for each thread. If multiple threads access
a format concurrently, it must be synchronized externally.

从 SimpleDateFormat 的源代码中也可以看到它是有状态的，而且其中 calendar 被宣告为成员变量，因此呼叫， 等 method 时会多次访问此 calendar。 在高并发环境下，将会造成资源竞争，结果值就会不符预期，甚至抛出异常。

幸运的是，已有许多解决方案：

正确用法 1. 每次都 new

public class DateUtil {

    public static String format(Date date) {
        SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd hh:mm:ss");
        return simpleDateFormat.format(date);
    }
}

这是最简单的做法，只要每次都宣告区域变量就可以了，区域变量是 thread-safe。 若专案对于效能要求不高，也许可以考虑这个解法，或直到出现效能问题时再考虑其他方法。 毕竟至少这个做法能正确运作，而且简单的作法往往是较好的。

正确用法 2. 加锁

public class DateUtil {
    private static SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd hh:mm:ss");

    synchronized public static String format(Date date) {
        return simpleDateFormat.format(date);
    }
}

首先宣告 SimpleDateFormat field，避免重复 new 而造成性能问题。 再加上关键字 就能确保同一时刻只有一个 thread 能执行 （mutual exclusion）。 虽然这个方式不会出错，但可能降低并发度。synchronizedformat

正确用法 3. 使用 ThreadLocal 容器

ThreadLocal 容器是一种让程序达到 thread-safety 的手段，它相当于给每个 thread 都开了一个独立的存储空间，既然 thread 之间互相隔离，自然解决了 race condition 的问题，也让 thread 能重复使用 SimpleDateFormat 实例。 代码如下：

public class DateUtil {
    // 可以把 ThreadLocal 視為一個全域 Map，key 就是 current thread
    // 意義上相當於 currentThread 專屬、獨立的 cache。
    private static ThreadLocal<SimpleDateFormat> local = new ThreadLocal<>();

    private static SimpleDateFormat getDateFormat() {
        // currentThread 從自己的 ThreadLocalMap 取得 SimpleDateFormat。
        // 如果是 null，則建立 SimpleDateFormat 並放入自己的 ThreadLocalMap 中。
        SimpleDateFormat dateFormat = local.get();
        if (dateFormat == null) {
            dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
            local.set(dateFormat);
        }
        return dateFormat;
    }

    public static String format(Date date) {
        return getDateFormat().format(date);
    }
}

举例来说，如果thread pool有10个thread，程序就会建立10个SimpleDateFormat实例，这些thread们在每次的任务中重复使用各自的SimpleDateFormat。 但要注意一点，该 thread 能够重复被使用（例如 server 在处理完一次 request 后，thread 会再回到 thread pool 待命），否则效果会和方法1差不多。 这个方法的缺点是程序会变得较复杂。

正确用法4. 改用 DateTimeFormatter（推荐）

虽然有点文不对题，毕竟这个问题困扰很多人许久了，因此在 Java 8 版本后官方就提供了 对象用来代替 。 就像官方文件中说的：DateTimeFormatterSimpleDateFormat

DateTimeFormatter in Java 8 is immutable and thread-safe alternative to SimpleDateFormat.

简单的演示例如下：

将字符串转成 LocalDate

String dateStr = "2022/05/24";
DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy/MM/dd");
LocalDate date = LocalDate.parse(dateStr, formatter);

LocalDateTime 转成字符串

LocalDateTime now = LocalDateTime.now();
DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy年MM月dd日 hh:mm");
System.out.println(now.format(formatter));