注解篇:@DateTimeFormat和@JsonFormat

@JsonFormat和@DateTimeFormat注解的使用

---

>背景:

从数据库获取时间传到前端进行展现的时候，咱们有时候可能没法获得一个满意的时间格式的时间日期，在数据库中显示的是正确的时 间格式，获取出来却变成了很丑的时间戳，@JsonFormat注解很好的解决了这个 问题，咱们经过使用@JsonFormat能够很好的解决：后台到前台时间格式保持一致的问题。

其次，另外一个问题是，咱们在使用Web服务的时，可能会须要用到，传入时间给后台，好比注册新用户须要填入出生日期等，这个时候前台传递给后台的时间格式一样是不一致的，而咱们的与之对应的便有了另外一个注解，@DataTimeFormat便很好的解决了这个问题。

接下来记录一下具体的@JsonFormat与DateTimeFormat的使用过程。

---

1.注解@JsonFormat

---

1.1.使用maven引入@JsonFormat所须要的jar包，我贴一下我这里的pom文件的依赖。

<!--JsonFormat-->

 <dependency>
 <groupId>com.fasterxml.jackson.core</groupId>
 <artifactId>jackson-annotations</artifactId>
 <version>2.8.8</version>
 </dependency>

 <dependency>
 <groupId>com.fasterxml.jackson.core</groupId>
 <artifactId>jackson-databind</artifactId>
 <version>2.8.8</version>
 </dependency>

 <dependency>
 <groupId>org.codehaus.jackson</groupId>
 <artifactId>jackson-mapper-asl</artifactId>
 <version>1.9.13</version>
 </dependency>

---

1.2.在你须要查询出来的时间的数据库字段对应的实体类的属性上添加@JsonFormat

---

import java.util.Date;

import com.fasterxml.jackson.annotation.JsonFormat;

public  class  TestClass {

//设置时区为上海时区，时间格式本身据需求定。

@JsonFormat(pattern="yyyy-MM-dd",timezone = "GMT+8")

    private Date testTime;

public Date gettestTime() {

    return testTime;
 }
 
public void settestTime(Date testTimee) {

     this.testTime= testTime;

 }

}

---

这里解释一下：@JsonFormat(pattern="yyyy-MM-dd",timezone = "GMT+8")

   pattern:是你须要转换的时间日期的格式

   timezone：是时间设置为东八区，避免时间在转换中有偏差

提示：@JsonFormat注解能够在属性的上方，一样能够在属性对应的get方法上，两种方式没有区别。

---

1.3.完成上面两步以后，咱们用对应的实体类来接收数据库查询出来的结果时就完成了时间格式的转换，再返回给前端时就是一个符合咱们设置的时间格式了

---

2.注解@DateTimeFormat

---

介绍：

2.1 java.util.Date、java.util.Calendar、java.long.Long 时间类型进行标注：

---

**– pattern 属性：类型为字符串。指定解析/格式化字段数据的模式，
如：**

yyyy-MM-dd hh:mm:ss

– iso 属性：类型为 DateTimeFormat.ISO。指定解析/格式化字段数据的ISO模式.

包括四种：

• ISO.NONE（不使用)

指示不该应用基于ISO的格式模式

• 默认ISO.DATE(yyyy-MM-dd)

最多见的ISO日期格式yyyy-MM-dd，例如 " 2020-9-17 " 。

• ISO.TIME(hh:mm:ss.SSSZ)

最多见的ISO时间格式HH:mm:ss.SSSXXX，例如“ 01：30：00.000-05：00”。

• ISO.DATE_TIME(yyyy-MM-dd hh:mm:ss.SSSZ)

最多见的ISO日期时间格式yyyy-MM-dd'T'HH:mm:ss.SSSXXX，例如“ 2000-10-31T01：30：00.000-05：00”。

**– style 属性：字符串类型。
经过样式指定日期时间的格式，由两位字符组成**

• 第一位表示日期的格式
• 第二位表示时间的格式
• S：短日期/时间格式
• M：中日期/时间格式
• L：长日期/时间格式
• F：完整日期/时间格式
• -：忽略日期或时间格式
• • *

3.注解@DateTimeFormat的使用

---

3.1 @DateTimeFormat的使用和@jsonFormat差很少，首先须要引入是spring还有jodatime,spring我就不贴了.

<!-- joda-time -->

 <dependency>
    <groupId>joda-time</groupId>
     <artifactId>joda-time</artifactId>
     <version>2.3</version>
 </dependency>

---

3.2 在controller层咱们使用spring mvc 表单自动封装映射对象时，咱们在对应的接收前台数据的对象的属性上加@DateTimeFormat

@DateTimeFormat(pattern = "yyyy-MM-dd")
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss",timezone="GMT+8")
private Date startTime;
     
@DateTimeFormat(pattern = "yyyy-MM-dd")
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss",timezone="GMT+8")
private Date endTime;

我这里就只贴这两个属性了，这里我两个注解都同时使用了，由于我既须要取数据到前台，也须要前台数据传到后台，都须要进行时间格式的转换，能够同时使用.

---

3.3 经过上面两个步骤以后，咱们就能够获取一个符合自定义格式的时间格式存储到数据库了.

---

总结：

## 注解@JsonForma：

主要是后台到前台的时间格式的转换

**JsonFormat ：出参
@JsonFormat(pattern=”yyyy-MM-dd”) 将Date转换成String 通常后台传值给前台时
如：@JsonFormat(timezone = “GMT+8”, pattern = “yyyy-MM-dd HH:mm”)**

注解@DataFormat：

主要是先后到后台的时间格式的转换

**DateTimeFormate ：入参@DatetimeFormat是将String转换成Date，通常前台给后台传值时用如：@DateTimeFormat(pattern = “yyyy-MM-dd HH:mm”)**