Spring 家族之 @JsonFormat 与 @DateTimeFormat 注解进行日期时间格式及数据类型之间的转换 (SSM 、SSMP 、SpringBoot 、SpringCloud )

2023-09-17 00:52:34

Spring 家族中 @JsonFormat 和 @DateTimeFormat 注解：轻松驾驭日期时间格式转换

在现代软件开发中，处理日期和时间数据至关重要。Spring 框架为我们提供了两个强大的注解，@JsonFormat 和 @DateTimeFormat ，可以轻松解决日期时间格式化和数据类型转换问题。本文将深入探讨这两个注解的使用，帮助你高效地处理日期时间数据。

@JsonFormat：让 JSON 与 Java 携手并进

@JsonFormat 注解在 Java 对象和 JSON 字符串之间架起了一座桥梁。它允许你在 Java 对象中使用与 JSON 字符串中相同的日期和时间格式，从而简化了数据转换过程。

使用方法：

只需在 Java 对象的字段或方法上使用 @JsonFormat 注解即可。例如：

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

这表示将 date 字段中的日期和时间格式化为 "年-月-日时:分:秒"。

属性：

@JsonFormat 注解提供了多种属性来控制格式化行为：

pattern： 指定要使用的日期和时间格式。
shape： 指定返回值的类型（数字、字符串或对象）。
timezone： 指定要使用的时区。

@DateTimeFormat：连接 HTTP 请求与 Java 对象

@DateTimeFormat 注解在解析 HTTP 请求中的日期和时间参数方面发挥着至关重要的作用。它将这些参数转换为相应的 Java 对象日期和时间类型。

使用方法：

同样地，在 Java 对象的字段或方法上使用 @DateTimeFormat 注解即可。例如：

@DateTimeFormat(pattern = "yyyy-MM-dd")
private LocalDate localDate;

这表示从 HTTP 请求中解析一个 "年-月-日" 格式的日期参数，并将其存储在 localDate 字段中。

属性：

@DateTimeFormat 注解也提供了几个属性：

pattern： 指定要使用的日期和时间格式。
iso： 指定是否使用 ISO 8601 日期和时间格式。

示例：

以下是一个使用 @JsonFormat 和 @DateTimeFormat 注解的示例：

@RestController
public class DemoController {

    @PostMapping("/api/date")
    public String formatDate(@RequestBody @DateTimeFormat(pattern = "yyyy-MM-dd") Date date) {
        return new SimpleDateFormat("yyyy-MM-dd").format(date);
    }

    @GetMapping("/api/date")
    public String parseDate(@RequestParam @DateTimeFormat(pattern = "yyyy-MM-dd") Date date) {
        return new SimpleDateFormat("yyyy-MM-dd").format(date);
    }

}