@JsonFormat 和 @DateTimeFormat 时间格式化注解(场景示例代码)

更新时间：2023年05月25日 16:18:59 作者：zhuzicc

这篇文章主要介绍了@JsonFormat和@DateTimeFormat时间格式化注解,本文通过场景示例代码详解给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下

前后数据交互过程中，Date类型的数据经常会出现类型映射转换的错误，为了达到业务的目标时间格式，通常会使用@JsonFormat 和 @DateTimeFormat，但是这两者有什么区别呢？

本文的衍生篇已发布，感兴趣的伙伴们可以瞅瞅哈，针对 @DateTimeFormat 做了补充说明，有场景示例比较详情，需要的大佬可以看一下。传送门： Spring @DateTimeFormat日期格式化时注解浅析分享

一、示例代码

先准备一个简单POJO，拥有Date类型的成员变量：

@Data
public class DateEntity {
    private Date date;
}

lombok依赖（版本任意）：

 <dependency>
	  <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>1.18.12</version>
 </dependency>

再准备一个Controller，模拟一下前后交互：

@RestController
@RequestMapping("/date")
public class DateController {
    @RequestMapping("/test")
    public DateEntity getDate(DateEntity dateEntity){
        System.out.println("入参的date:"+dateEntity.getDate());
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        String date = sdf.format(dateEntity.getDate());
        System.out.println("SimpleDateFormat格式化后的date:"+date);
        DateEntity result = new DateEntity();
        result.setDate(new Date());
        return result;
     }
}

创建好POJO和Controller后，用Postman模拟一下请求发送：

结果报错：

大概意思就是说String类型转换成Date类型失败，所以报了IllegalArgumentException异常；

二、@JsonFormat注解

提供者：jackson
作用：可以约束时间的接收格式和响应格式 (接收和响应的都是JSON字符串)，将日期类型数据在JSON格式和java.util.Date对象之间转换。与传输方向没有关系（前端到后端or后端到前端都可以使用），注意因为我们是东八区（北京时间），使用时需要加上时区（ timezone = “GMT+8”），不然所得值会比实际时间晚8小时；
常用注解属性：

名称	作用
pattern	约定时间格式：pattern=“yyyy-MM-dd HH:mm:ss”
timezone	指定具体时区： timezone = “GMT+8” or timezone = “Asia/Shanghai”

经过测试使用单独使用@JsonFormat注解时需要先通过@RequestBody将入参参数映射到实体后，@JsonFormat注解才能去对时间格式进行约束；
改造controller，加上了@RequestBody注解：

    @RequestMapping("/test")
    public DateEntity getDate(@RequestBody DateEntity dateEntity){
        System.out.println("入参的date:"+dateEntity.getDate());
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        String date = sdf.format(dateEntity.getDate());
        System.out.println("SimpleDateFormat格式化后的date:"+date);
        DateEntity result = new DateEntity();
        result.setDate(new Date());
        return result;
    }

POJO类中也加上了@JsonFormat注解：

@Data
public class DateEntity {
    @JsonFormat(pattern = "yyyy-MM-dd hh", timezone = "GMT+8")
    private Date date;
}

测试：

结果可以看出，@JsonFormat对时间格式进行了约束，mm:ss并没有按传入的值显示：

再看return的返回值中也可以看出输出格式是完全按照@JsonFormat约定的时间格式（“yyyy-MM-dd hh”）进行了输出；

实际返回结果：

三、@DateTimeFormat注解

提供者：Spring
作用：可对java.util.Date、java.uitl.calendar、java.long.Long及Joda时间类型的属性进行标注，主要处理前端时间类型与后端pojo对象中的成员变量进行数据绑定，所约束的时间格式并不会影响后端返回前端的时间类型数据格式；
注意（注意！注意！注意！讲三遍）：前端入参数据的时间格式必须与注解中定义的时间格式相同，不然会报错，如：@DateTimeFormat(pattern = “yyyy-MM-dd HH:mm”) 则入参的格式必须为"2020-6-4 10:43"；
常用注解属性：

名称	作用
iso	类型为DateTimeFormat.ISO，常用值： DateTimeFormat.ISO.DATE：格式为yyyy-MM-dd DateTimeFormat.ISO.DATE_TIME：格式为yyyy-MM-dd hh:mm:ss.SSSZ DateTimeFormat.ISO.TIME：格式为hh:mm:ss.SSSZ DateTimeFormat.ISO.NONE：表示不使用ISO格式的时间（默认值）
pattern	类型为String，使用自定义时间格式化字符串，如"yyyy-MM-dd hh:mm:ss"
style	类型为String，通过样式指定日期时间的格式，由两位字符组成，第一位表示日期的样式，第二位表示时间的格式，以下是几个常用的可选值： S：短日期/时间的样式 M：中日期/时间的样式 L：短日期/时间的样式 F：完整日期/时间的样子 -：忽略日期或时间的样式默认值 style=“SS”

controller代码：

 @RequestMapping("/test")
    public DateEntity getDate(DateEntity dateEntity){
        System.out.println("入参的date:"+dateEntity.getDate());
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        String date = sdf.format(dateEntity.getDate());
        System.out.println("SimpleDateFormat格式化后的date:"+date);
        DateEntity result = new DateEntity();
        Date date1 = new Date();
        result.setDate(date1);
        return result;
    }

POJO代码：

@Data
public class DateEntity {
    @DateTimeFormat(pattern = "yyyy-MM-dd hh")
    private Date date;
}

测试：

结果：

五、总结@JsonFormat 和 @DateTimeFormat 区别

@JsonFormat 既可以约束前端传入的时间类型参数格式，也可以约束后端响应前端的时间类型格式；
@DateTimeFormat ：
- 只能约束前端入参时间类型的格式，并不会修改原有的日期对象的格式，如果想要获得期望的日期格式，是需要自己手动转换的；
- 如果单独使用@DateTimeFormat 时，响应给前端的时间会比实际时间晚8个小时（时区原因）。
- 针对 @DateTimeFormat 做了补充说明，有场景示例比较详情，需要的大佬可以看一下。传送门：Spring @DateTimeFormat日期格式化时注解浅析分享

到此这篇关于@JsonFormat 和 @DateTimeFormat 时间格式化注解的文章就介绍到这了,更多相关@JsonFormat 和 @DateTimeFormat 内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java基础之Comparable与Comparator概述
这篇文章主要介绍了Java基础之Comparable与Comparator详解,文中有非常详细的代码示例,对正在学习java基础的小伙伴们有非常好的帮助,需要的朋友可以参考下
2021-04-04
专属于程序员的浪漫-Java输出动态闪图iloveyou
这篇文章主要介绍了专属于程序员的浪漫-Java输出动态闪图iloveyou，具有一定参考价值，需要的朋友可以了解下。
2017-11-11
Java人机猜拳实现的思路及方法实例
这篇文章主要给大家介绍了关于Java人机猜拳实现的思路及方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-12-12
详细总结IDEA中打jar包的两种方式
发现有很多小伙伴都不会用IDEA打jar包,今天给大家详细总结了两种IDEA打jar包的方式,对正在学习IDEA使用的小伙伴很有帮助,需要的朋友可以参考下
2021-05-05
Spring @Autowired注解超详细示例
@Autowired注解可以用在类属性，构造函数，setter方法和函数参数上，该注解可以准确地控制bean在何处如何自动装配的过程。在默认情况下，该注解是类型驱动的注入
2022-08-08
Java实现全图背景水印的示例详解
这篇文章主要为大家详细介绍了如何利用Java实现全图背景水印的方法，文中的示例代码讲解详细，具有一定的借鉴价值，需要的可以参考一下
2023-02-02
java对同一个文件进行读写操作方法
在本篇文章里我们给大家详细讲述了java对同一个文件进行读写操作的方法和知识点，需要的朋友们可以参考学习下。
2018-10-10
SpringBoot启动后初始化的几种方式汇总
这篇文章主要介绍了SpringBoot启动后初始化的几种方式汇总,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2025-04-04
Spring复杂对象创建的方式小结
这篇文章主要介绍了Spring复杂对象创建的三种方式,现在使用Spring如何创建这种类型的对象？Spring中提供了三种方法来创建复杂对象，需要的朋友可以参考下
2022-01-01
JAVA IO API使用详解
本文通过理论、用法、实例详细说明了JAVA IO的使用，大家参考其中的实例代码实现自己的JAVA IO程序
2013-11-11