关于 @DateTimeFormat 和 @JsonFormat 的区别以及springboot接口传Date的时候如何传参

Posted 2021-12-28 石头StoneWang

背景

你真的用对了 @DateTimeFormat 和 @JsonFormat 吗？ 相信90%的人都搞不清楚它们的区别以及本文提到的细节

本文基于 springboot 2.3.7.RELEASE 版本

结论

可以花两分钟看看结论，其他有时间选看。

• 传非 JSON (比如键值对 x-www-form-urlencoded 或 form-data)

  得使用 @DateTimeFormat(pattern="yyyy-MM-dd HH:mm:ss")，否则无法转换，具体的格式可以自行修改

  传非JSON包括：

  1、Date 字段直接作为rest接口参数

  2、Date字段放在一个类里头作为rest接口的入参

• 传 JSON，不能用 @DateTimeFormat(pattern="yyyy-MM-dd HH:mm:ss") ！！！ 得用 @JsonFormat(pattern="yyyy-MM-dd HH:mm:ss") 一般不要写上 timezone="GMT+8"

  • 也就是说 @JsonFormat 既将出参Date转为String，也将入参String转为Date，是双向的、两用的，以前我只知道 “出参的时候才用@JsonFormat”

  • 关于要不要设置 @JsonFormat 的时区：@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")

    我个人建议应该不要。
    
    作为入参的时候，你将字串格式化成+8时区了，万一你的应用程序不在+8时区部署的呢，就有问题了。
    
    作为出参，面临同样的问题，将 Date 转为固定的某个时区的字串，明显感觉不太妥当。你的应用如果是全球性的，展示时间时，字串展示为带时区的会比较好，比如：2021-10-15 11:30[ (UTC+08:00)Beijing ]  吐槽：当前，跟多的应用在展示的时间字串看不出时区，比如2021-10-15 11:30。
    

PS：DateTimeFormat 是没有时区的设置的，而 JsonFormat 有！

详细研究过程

1、传 Date 方式一

直接让 Date 作为 rest 接口的参数 (传键值对 x-www-form-urlencoded)

@RequestMapping("/date1")
public ResponseDTO date1(@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss") Date date) // 必须使用 @DateTimeFormat 才能实现转换
    return ResponseDTO.succ(date);

• 必须加 @DateTimeFormat 才能实现转换

• 格式要严格遵守 pattern

  例如 yyyy-MM-dd HH:mm:ss 则不能只有日期部分，也不能去掉秒，也不能将 - 换成 /
  

• 改成用 @JsonFormat 不行！！

2、传 Date 方式二

rest 接口使用一个类，类里面含 Date 字段，传的还是键值对 (x-www-form-urlencoded)

@RequestMapping("/date2")
public ResponseDTO date2(DateKvDTO dateDTO) // 里面的 Date 字段必须用 @DateTimeFormat
    return ResponseDTO.succ(dateDTO);


@Data
public class DateKvDTO 
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date date;

• 必须在入参类的 Date 字段加 @DateTimeFormat 才能实现转换

• 格式要严格遵守 pattern

• 改成用 @JsonFormat 不行！！

3、传 Date 方式三

rest 接口使用传 JSON 方式 (application/json)

@PostMapping("/date3")
public ResponseDTO date3(@RequestBody DateJsonDTO jsonDTO) 
    return ResponseDTO.succ(jsonDTO);


@Data
public class DateJsonDTO 
    private Date date;

• date 可以不设置 @DateTimeFormat 也能顺利转换，但要符合一定的格式

  springboot 旧版可以使用 `yyyy-MM-dd HH:mm:ss`，新版的格式稍微不同，要用 `yyyy-MM-ddTHH:mm:ss` (中间有个T隔开日期和时间)
  

• **对于传 JSON 的情况，使用 @DateTimeFormat 是没有用的，这个注解不起作用！！！**得用 @JsonFormat 才能生效！！！

• 最佳实践是 Date 类型也加上 @JsonFormat 以便控制前端给我们的格式