Spring Boot 中的 @DateTimeFormat 和 @JsonFormat 的用法及作用详解

更新时间：2024年11月28日 11:41:24 作者：小林想被监督学习

本文介绍了SpringBoot中的@DateTimeFormat和@JsonFormat注解的用法,解释了它们在处理日期和时间数据时的作用,并通过实例代码展示了如何在REST控制器中使用这些注解,感兴趣的朋友跟随小编一起看看吧

在开发 Spring Boot 应用时，处理日期和时间数据是一个常见的需求。Spring Boot 提供了两个注解 @DateTimeFormat 和 @JsonFormat 来帮助我们处理这些问题。这两个注解分别用于将日期字符串解析为日期对象以及将日期对象格式化为字符串。本文将详细介绍这两个注解的用法及作用，并通过实例代码进行说明。

@DateTimeFormat 注解

@DateTimeFormat 是一个 Spring 框架提供的注解，用于格式化和解析日期时间字段。它主要用于将请求参数或表单数据中的日期字符串解析为 Java 的日期对象。

用法

@DateTimeFormat 可以应用于以下数据类型：

java.util.Date
java.util.Calendar
java.time.LocalDate
java.time.LocalDateTime
java.time.ZonedDateTime

该注解的常用属性包括：

pattern：指定日期格式的模式字符串，例如 "yyyy-MM-dd"。
iso：指定标准的 ISO 日期时间格式。可选值为 DateTimeFormat.ISO.DATE、DateTimeFormat.ISO.TIME 和 DateTimeFormat.ISO.DATE_TIME。

示例

假设我们有一个处理日期的 REST 控制器：

package com.example.demo.controller;
import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
@RestController
public class DateController {
    @GetMapping("/date")
    public String handleDate(@RequestParam("date") @DateTimeFormat(pattern = "yyyy-MM-dd") LocalDate date) {
        return "Parsed date: " + date.format(DateTimeFormatter.ISO_DATE);
    }
    @GetMapping("/datetime")
    public String handleDateTime(@RequestParam("datetime") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) LocalDateTime dateTime) {
        return "Parsed datetime: " + dateTime.format(DateTimeFormatter.ISO_DATE_TIME);
    }
}

在上述示例中：

/date 端点处理格式为 "yyyy-MM-dd" 的字符串，并将其解析为 LocalDate 对象。
/datetime 端点处理 ISO 标准格式的日期时间字符串，并将其解析为 LocalDateTime 对象。

你可以通过以下 URL 测试这些端点：

http://localhost:8080/date?date=2023-10-01
http://localhost:8080/datetime?datetime=2023-10-01T10:15:30

@JsonFormat 注解

@JsonFormat 是 Jackson 库提供的注解，用于序列化和反序列化 JSON 数据中的日期时间字段。它可以帮助我们将日期时间对象格式化为特定的字符串格式，或将特定格式的字符串解析为日期时间对象。

用法

@JsonFormat 可以应用于类的字段或方法上。其常用属性包括：

pattern：指定日期时间格式的模式字符串。
shape：指定日期时间的格式化类型。常用值为 JsonFormat.Shape.STRING。
timezone：指定时区。

示例

假设我们有一个包含日期时间字段的实体类，并使用 @JsonFormat 注解格式化日期时间：

package com.example.demo.model;
import com.fasterxml.jackson.annotation.JsonFormat;
import java.time.LocalDate;
import java.time.LocalDateTime;
public class Event {
    private String name;
    @JsonFormat(pattern = "yyyy-MM-dd")
    private LocalDate date;
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "UTC")
    private LocalDateTime dateTime;
    // getters and setters
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public LocalDate getDate() {
        return date;
    }
    public void setDate(LocalDate date) {
        this.date = date;
    }
    public LocalDateTime getDateTime() {
        return dateTime;
    }
    public void setDateTime(LocalDateTime dateTime) {
        this.dateTime = dateTime;
    }
}

接着，我们创建一个 REST 控制器来测试该实体类的序列化和反序列化：

package com.example.demo.controller;
import com.example.demo.model.Event;
import org.springframework.web.bind.annotation.*;
import java.time.LocalDate;
import java.time.LocalDateTime;
@RestController
public class EventController {
    @GetMapping("/event")
    public Event getEvent() {
        Event event = new Event();
        event.setName("Spring Boot Workshop");
        event.setDate(LocalDate.of(2023, 10, 1));
        event.setDateTime(LocalDateTime.of(2023, 10, 1, 10, 15, 30));
        return event;
    }
    @PostMapping("/event")
    public String createEvent(@RequestBody Event event) {
        // 持久化逻辑...
        return "Event created: " + event.getName();
    }
}

在上述示例中：

/event GET 端点返回一个 Event 对象，其中日期和日期时间字段将根据 @JsonFormat 注解指定的格式序列化为 JSON 字符串。
/event POST 端点接受一个 JSON 请求体，并将其反序列化为 Event 对象。

你可以通过以下方式测试这些端点：

GET 请求

curl -X GET http://localhost:8080/event

返回结果：

{
"name": "Spring Boot Workshop",
"date": "2023-10-01",
"dateTime": "2023-10-01 10:15:30"
}

POST 请求

curl -X POST http://localhost:8080/event -H "Content-Type: application/json" -d '{
    "name": "Spring Boot Workshop",
    "date": "2023-10-01",
    "dateTime": "2023-10-01 10:15:30"
}'

返回结果：

Event created: Spring Boot Workshop

小结

在本文中，我们详细介绍了 Spring Boot 中的 @DateTimeFormat 和 @JsonFormat 注解的用法及作用。@DateTimeFormat 主要用于将请求参数或表单数据中的日期字符串解析为日期对象，而 @JsonFormat 则用于序列化和反序列化 JSON 数据中的日期时间字段。

通过这些注解，我们可以更方便地处理日期和时间数据，确保数据在不同层次间传递时的格式一致性。这对于开发高质量的 Spring Boot 应用至关重要

到此这篇关于Spring Boot 中的 @DateTimeFormat 和 @JsonFormat 的用法及作用的文章就介绍到这了,更多相关Spring Boot @DateTimeFormat 和 @JsonFormat内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

springboot配置Jackson返回统一默认值的实现示例
在项目开发中，我们返回的数据或者对象没有的时候一般直接返回的null，那么如何返回统一默认值，感兴趣的可以了解一下
2021-07-07
Java中String类常用方法详细汇总
Java中String类在所有项目开发里面一定会用到,因此String类提供了一系列的功能操作方法,下面这篇文章主要给大家介绍了关于Java中String类常用方法的相关资料,需要的朋友可以参考下
2023-05-05
Java如何判断一个IP是否在给定的网段内
这篇文章主要介绍了Java如何判断一个IP是否在给定的网段内问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2025-04-04
SpringBoot如何集成Kafka低版本和高版本
这篇文章主要介绍了SpringBoot如何集成Kafka低版本和高版本问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2024-03-03
java反射机制最详解
这篇文章主要介绍了Java 反射机制原理与用法,结合实例形式详细分析了Java反射机制的相关概念、原理、基本使用方法及操作注意事项,需要的朋友可以参考下
2021-08-08
java生成XML的方法【附demo源码下载】
这篇文章主要介绍了java生成XML的方法,涉及java针对xml格式文件的简单操作技巧,并附带demo源码供读者下载参考,需要的朋友可以参考下
2016-12-12
MyBatis插件机制超详细讲解
MyBatis在四大对象的创建过程中，都会有插件进行介入。插件可以利用动态代理机制一层层的包装目标对象，而实现在目标对象执行目标方法之前进行拦截的效果
2022-11-11
springboot集成mybatis-plus遇到的问题及解决方法
这篇文章主要介绍了springboot集成mybatis-plus遇到的问题及解决方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-11-11
SpringMVC上传图片代码实例
这篇文章主要介绍了SpringMVC上传图片代码实例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-08-08
Seata AT模式TM处理流程图文示例详解
这篇文章主要为大家介绍了Seata AT模式TM处理流程图文示例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-09-09