@DateTimeFormat与@JsonFormat详解

前后端进行时间类型的传值经常会遇到各种问题，并且对于java中的Date类也有util包与sql包的区别，在本文中我将会围绕实际业务进行展开解释。

一、时间传值

前端时间控件，一般情况下直接会传一个yyyy-MM-dd的日期字符串到后台。这个时候如果我们直接用java.util.Date类型就无法正确接收到。或者我们从数据库里查到DateTime类型并且用java的Date类型接收并返回给前台的时候，前台也无法用yyyy-MM-dd的形式进行呈现。
这个时候，前面两种情况分别对应了@DateTimeFormat和@JsonFormat注解的使用。

二、@DateTimeFormat

该注解主要解决前端时间控件传值到后台接收准确的Date类属性的问题，我们可以在需要接收的类中对应的时间类型属性上加上@DateTimeFormat注解，并在注解中加上pattern属性，例如：

public class Person{

	// 名字
	private String name;
	
	// 出生年月日
	@DateTimeFormat(pattern = "yyyy-MM-dd")
	private Date birthday;
}

随后在前端对应birthday传入的yyyy-MM-dd日期类型就能够按照该种格式进行转义赋值给Person类中的birthday的Date类型。
若想按照yyyy/MM/dd的日期格式，则直接修改@DateTimeFormat的pattern属性为对应的日期格式即可，即@DateTimeFormat(pattern = “yyyy/MM/dd”)。或者还想要接收到对应的HH-mm-ss时分秒，同样在pattern中加上即可，如@DateTimeFormat(pattern = “yyyy-MM-dd HH-mm-ss”)

三、@JsonFormat

该注解主要解决后台从数据库中取出时间类型赋予java对象的Date属性值无法在前端以一定的日期格式来呈现，默认返回的是一个带时区的格式串，不符合我们日常要呈现的yyyy-MM-dd格式的日期。
同样，我们在对应的接收对象时间类型上加上@JsonFormat注解，并在注解中加上pattern属性以及timezone属性，例如：

public class Person{

	// 名字
	private String name;
	
	// 出生年月日
	@JsonFormat(locale="zh", timezone="GMT+8", pattern="yyyy-MM-dd HH:mm:ss")
	@DateTimeFormat(pattern = "yyyy-MM-dd")
	private Date birthday;
}

表示我们从后台数据库查询结果赋予对应的Date java类型为yyyy-MM-dd格式，且注意后面的timezone属性，最好加上GMT+8表示我们以东八区时区为准，若读者想用其他时区就可以通过更改timezone属性来改变，从而解决时区不同造成的时间差问题。

四、扩展

以上使用方法需要在各个类的属性上加对应注解，适合日期格式个性化的操作。如果在项目中是统一的日期格式，例如yyyy-MM-dd HH:mm:ss，那么我们可以在配置文件中进行配置项目全局生效：

spring
	jackson:
    	date-format: yyyy-MM-dd HH:mm:ss

五、总结

对于时间类型的前后台传值，实际业务过程中总是频繁遇到。最开始我遇到的时间问题特别多，所以觉得有必要分享一下关于这两个注解能解决绝大部分的前后端时间传值问题，值得记录和分享。
其中对于java.sql包中的Date是能够不用注解就能接收到前端的准确时间格式，但是一般情况下我们最好不要用sql包中的Date来接收，还是要用util包下的Date类来接收，所以读者应该熟练掌握以上两个注解的用法。

参考资料：

• java时间格式Date中util和sql的区别
• @JsonFormat与@DateTimeFormat注解的使用