@JsonFormat 和 @DateTimeFormat 时间格式化注解详解（不看血亏）

淡淡的烟草味﹌ 2023-10-10 11:12 1阅读 0赞

> 前后数据交互过程中，Date类型的数据经常会出现类型映射转换的错误，为了达到业务的目标时间格式，通常会使用@JsonFormat 和 @DateTimeFormat，但是这两者有什么区别呢？
> 
> **福利！福利！本文的衍生篇已发布，感兴趣的伙伴们可以瞅瞅哈，针对 `@DateTimeFormat` 做了补充说明，有场景示例比较详情，需要的大佬可以看一下。传送门：**[Spring @DateTimeFormat日期格式化时注解浅析分享][Spring _DateTimeFormat]

#### 目录 ####

*   *  一、示例代码
     *  二、@JsonFormat注解
     *  三、@DateTimeFormat注解
     *  五、总结 @JsonFormat 和 @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模拟一下请求发送：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3podXppY2M_size_16_color_FFFFFF_t_70]
 *  结果报错：  
    ![在这里插入图片描述][20200604103830856.png]
 *  大概意思就是说String类型转换成Date类型失败，所以报了IllegalArgumentException异常；

### 二、@JsonFormat注解 ###

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

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

*  经过测试使用**单独使用**@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;
    }

*  测试：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3podXppY2M_size_16_color_FFFFFF_t_70 1]
 *  结果可以看出，@JsonFormat对时间格式进行了约束 ，mm:ss并没有按传入的值显示：  
    ![在这里插入图片描述][20200604110017695.png]
 *  再看return的返回值中也可以看出输出格式是完全按照@JsonFormat约定的时间格式（“yyyy-MM-dd hh”）进行了输出；![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3podXppY2M_size_16_color_FFFFFF_t_70 2]
 *  实际返回结果：  
    ![在这里插入图片描述][20200604111244718.png]

### 三、@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"；
 *  常用注解属性：

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

*  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;
    }

*  测试：  
    ![\-][-]
 *  结果：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3podXppY2M_size_16_color_FFFFFF_t_70 3]

### 五、总结 @JsonFormat 和 @DateTimeFormat 区别 ###

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

--------------------

![a564d02ed5f5414ca28ba15bfeec1c67.png][] 原创 不易， 感 谢 各 位 大 佬 的 阅 读，随 手 点 赞，日 薪 过 万~！ ！！

[Spring _DateTimeFormat]: https://blog.csdn.net/zhuzicc/article/details/127956849
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3podXppY2M_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200604104255777.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3podXppY2M=,size_16,color_FFFFFF,t_70
[20200604103830856.png]: https://img-blog.csdnimg.cn/20200604103830856.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3podXppY2M_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200604110554335.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3podXppY2M=,size_16,color_FFFFFF,t_70
[20200604110017695.png]: https://img-blog.csdnimg.cn/20200604110017695.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3podXppY2M_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200604111212159.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3podXppY2M=,size_16,color_FFFFFF,t_70
[20200604111244718.png]: https://img-blog.csdnimg.cn/20200604111244718.png
[-]: https://img-blog.csdnimg.cn/20200604143721902.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3podXppY2M=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3podXppY2M_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20200604143649378.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3podXppY2M=,size_16,color_FFFFFF,t_70
[a564d02ed5f5414ca28ba15bfeec1c67.png]: https://img-blog.csdnimg.cn/a564d02ed5f5414ca28ba15bfeec1c67.png