Spring应用中，如何使用spring.jackson.date-format统一JSON日期格式？

Question

在Spring应用中，如何全局统一JSON日期格式是一个常见需求。使用`spring.jackson.date-format`可以轻松实现这一目标，但开发者常遇到配置无效的问题。例如，即使已在`application.properties`中设置`spring.jackson.date-format=yyyy-MM-dd HH:mm:ss`，部分日期字段仍以时间戳形式返回。这是因为某些实体类可能手动添加了`@JsonFormat`注解，覆盖了全局配置。此外，若使用的是`Java 8`的`LocalDateTime`类型，需同时配置`spring.jackson.serialization.write-dates-as-timestamps=false`，并确保依赖中包含`jackson-datatype-jsr310`模块。最后，检查是否正确引入了`Jackson`相关依赖，避免因版本冲突导致配置失效。这些问题解决后，即可实现JSON日期格式的全局统一。

Answer 1

1. 常见问题概述

在Spring应用中，JSON日期格式的统一是一个常见的需求。开发者通常希望通过简单的配置实现全局日期格式化，例如在`application.properties`中设置`spring.jackson.date-format=yyyy-MM-dd HH:mm:ss`。然而，很多开发者会发现即使设置了该属性，部分日期字段仍然以时间戳形式返回。

这一问题可能由以下几个原因引起：

• 某些实体类中手动添加了`@JsonFormat`注解，覆盖了全局配置。
• 使用`Java 8`的`LocalDateTime`类型时，未正确配置`spring.jackson.serialization.write-dates-as-timestamps=false`。
• 缺少`jackson-datatype-jsr310`模块的支持。
• Jackson相关依赖版本冲突导致配置失效。

2. 配置与分析

首先，确保在`application.properties`中正确设置了以下属性：

spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
spring.jackson.serialization.write-dates-as-timestamps=false
    

如果项目中使用了`LocalDateTime`等`Java 8`时间类型，还需要在`pom.xml`或`build.gradle`中引入`jackson-datatype-jsr310`模块：

<dependency>
    <groupId>com.fasterxml.jackson.datatype</groupId>
    <artifactId>jackson-datatype-jsr310</artifactId>
    <version>2.15.2</version>
</dependency>

// Gradle
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.15.2'
    

此外，检查是否正确引入了Jackson核心依赖，并确保版本一致，避免因版本冲突导致配置失效。

3. 解决方案与验证

为了解决上述问题，可以按照以下步骤进行排查和修复：

1. 确认所有实体类中没有手动添加`@JsonFormat`注解。如果有，请移除或调整其优先级。
2. 确保`spring.jackson.serialization.write-dates-as-timestamps=false`已正确配置。
3. 检查`pom.xml`或`build.gradle`中是否包含`jackson-datatype-jsr310`模块。
4. 验证Jackson相关依赖的版本一致性。

以下是通过代码示例验证配置是否生效的方式：

@RestController
public class DateController {

    @GetMapping("/date")
    public Map getDate() {
        Map result = new HashMap<>();
        result.put("currentDate", new Date());
        result.put("localDateTime", LocalDateTime.now());
        return result;
    }
}
    

4. 配置流程图

以下是实现JSON日期格式全局统一的配置流程图：

graph TD;
            A[开始] --> B[检查`application.properties`];
            B --> C{是否设置`spring.jackson.date-format`};
            C --否--> D[手动添加];
            C --是--> E{是否使用`LocalDateTime`};
            E --是--> F[引入`jackson-datatype-jsr310`];
            E --否--> G[完成配置];
            F --> H[验证依赖版本];
            H --> G;