註解篇:@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」)**