AssertJ日期断言时区陷阱：当isEqualTo遇上动态时区切换

在Java单元测试中，AssertJ是一个非常流行的断言库，它提供了丰富的API来简化测试代码。然而，在使用其日期断言功能时，有一个容易被忽视的陷阱——当测试中动态切换时区时，isEqualTo对java.util.Date的断言可能会产生意外的失败。

问题现象

考虑以下测试场景：我们需要验证一个日期对象是否等于"2024-03-01"这个字符串表示。当测试代码在WET(西欧时间，UTC+0)时区下运行时，断言正常工作。但当测试中动态切换时区到CET(中欧时间，UTC+1)后，同样的断言却会失败。

@Test
void testWithIsEqualTo() {
    TimeZone.setDefault(TimeZone.getTimeZone("WET"));
    assertThat(Date.from(Instant.parse("2024-03-01T00:00:00.000+00:00")))
        .isEqualTo("2024-03-01"); // 通过
    
    TimeZone.setDefault(TimeZone.getTimeZone("CET"));
    assertThat(Date.from(Instant.parse("2024-03-01T00:00:00.000+01:00")))
        .isEqualTo("2024-03-01"); // 失败
}

根本原因

这个问题的根源在于AssertJ内部对SimpleDateFormat的使用方式。AssertJ为了提高性能，会将常用的日期格式(如"yyyy-MM-dd")缓存在静态变量中。这些SimpleDateFormat实例在第一次使用时初始化，并保持对创建时默认时区的引用。

当测试代码中动态改变默认时区时，这些缓存的格式化实例并不会感知到时区的变化，仍然使用初始化时的时区来解析日期字符串。这就导致了断言行为与预期不符。

技术细节

1. 日期解析过程：当使用isEqualTo(String)断言日期时，AssertJ需要将字符串转换为Date对象进行比较。由于字符串"2024-03-01"没有时区信息，解析时必须依赖默认时区。

2. 格式化缓存：AssertJ内部维护了一个静态的Map<String, DateFormat>缓存，用于存储常用的日期格式。这些格式化实例在第一次使用时创建并缓存。

3. 时区状态：SimpleDateFormat内部使用Calendar对象，该对象在创建时固定了时区设置。即使后续修改了JVM的默认时区，已创建的格式化实例也不会更新其内部时区。

解决方案

对于需要动态切换时区的测试场景，建议采用以下替代方案：

1. 使用明确的日期时间断言：避免直接比较日期字符串，转而使用AssertJ提供的日期组件断言方法：

assertThat(date)
    .hasYear(2024)
    .hasMonth(3)
    .hasDayOfMonth(1);

2. 使用Instant或ZonedDateTime：如果可能，尽量使用Java 8的新日期时间API，它们对时区的处理更加明确和一致。

3. 重置AssertJ缓存：在极端情况下，可以通过反射清除AssertJ内部的日期格式化缓存，但这会带来性能开销，不推荐作为常规解决方案。

最佳实践

1. 在测试中尽量避免动态修改默认时区，这可能导致难以追踪的问题。
2. 如果必须修改时区，确保在测试完成后恢复原始时区设置。
3. 考虑使用测试框架的时区注解(如JUnit Pioneer的@DefaultTimeZone)来管理测试时区。
4. 对于日期敏感的测试，明确指定时区而不是依赖默认设置。