SpringBoot中@JsonFormat注解的使用方法及好处

2022-12-28 11:57:05

@JsonFormat 注解：在 SpringBoot 中轻松格式化日期、时间和数字

什么是 @JsonFormat 注解？

@JsonFormat 注解是一个强大的工具，可让您轻松自定义如何处理和显示 Java 对象中的日期、时间和数字。通过指定特定的格式模式，您可以使数据更具可读性、可理解性和一致性。

使用方法

@JsonFormat 注解可应用于字段、方法和类，以下是如何使用它：

字段： 在字段上应用注解，以格式化数据并控制 JSON 序列化/反序列化的行为。例如：

@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
private Date birthDate;

方法： 在 getter 方法上应用注解，以格式化返回值并在 JSON 序列化期间使用它。例如：

@JsonFormat(pattern = "yyyy-MM-dd")
public String getFormattedBirthDate() {
    return birthDate.toString();
}

类：在类上应用注解，以将格式应用于所有包含的字段。例如：

@JsonFormat(pattern = "yyyy-MM-dd")
public class Person {
    private Date birthDate;
    // 省略其他代码...
}

好处

使用 @JsonFormat 注解的好处包括：

可读性： 自定义日期和时间的格式，使其更易于人类阅读和理解。
可理解性： 通过使用一致的格式模式，消除数据表示中的歧义。
一致性： 在整个应用程序中强制执行格式标准，确保数据始终以相同的方式显示。
便捷性： 无需手动格式化数据，减少代码复杂性和错误风险。

示例

以下示例演示了如何使用 @JsonFormat 注解格式化日期：

// 原始日期字符串
String dateStr = "2023-05-25T10:15:30Z";

// 创建日期对象
ZonedDateTime date = ZonedDateTime.parse(dateStr);

// 使用 @JsonFormat 注解自定义格式
@JsonFormat(pattern = "dd/MM/yyyy")
String formattedDate = date.toString();

// 打印格式化后的日期
System.out.println(formattedDate); // 输出：25/05/2023