實體類中Date屬性格式化@JsonFormat @DateTimeFormat

mysql 數(shù)據(jù)庫中是datetime類型，java對象中用date接收，傳給前臺時，想要格式化一下

在實體類的屬性上使用注解： 

@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")

• shape: 表示序列化后的一種數(shù)據(jù)類型
• pattern: 表示最終日期的格式
• timezone: 默認是GMT，中國需要GMT+8

@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
private Date createDate;

注意：使用JsonFormat注解發(fā)現(xiàn)，格式化后的時間比實際少了8小時，就要加上中國時區(qū)GMT+8

返給前臺的json值：

"createDate": "2019-04-25 10:45:37"

實體類日期時間入?yún)DateTimeFormat 和出參@JsonFormat 格式化

準備

定義一個pojo，它有一個 java.util.Date 類型的屬性 date。

import java.util.Date;
public class DateVo {
? ? private Date date;
? ? public void setDate(Date date){
? ? ? ? this.date = date;
? ? }
? ? public Date getDate(){
? ? ? ? return date;
? ? }
}

定義一個Controller

@RestController
@RequestMapping("/date/")
public class DateController {
? ? @RequestMapping("test")
? ? public DateVo getDate(DateVo vo){
? ? ? ? System.out.println("date1:"+vo.getDate());
? ? ? ? SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
? ? ? ? String date = sdf.format(vo.getDate());
? ? ? ? System.out.println("date2:"+date);
? ? ? ? DateVo vo2 = new DateVo();
? ? ? ? vo2.setDate(new Date());
? ? ? ? return vo2;
? ? }
}

訪問 /date/test ，并傳入?yún)?shù)：2018-08-02 22:05:55

發(fā)現(xiàn)并不能訪問成功，會拋出異常：

因為傳入的參數(shù)是 String 類型的，而用來接收參數(shù)的 DateVo 的 date 屬性是 java.util.Date 類型的，類型無法轉(zhuǎn)換。

入?yún)⒏袷交?/h3>

這時，就可以使用 Spring 的 @DateTimeFormat 注解格式化參數(shù)，來解決上述問題。

改造 DateVo：

public class DateVo {
? ? @DateTimeFormat(pattern="yyyy-MM-dd HH:mm:ss")
? ? private Date date;
? ? public void setDate(Date date){
? ? ? ? this.date = date;
? ? }
? ? public Date getDate(){
? ? ? ? return date;
? ? }
}

再像上面一樣訪問 /date/test ，并傳入?yún)?shù)：2018-08-02 22:05:55，將在控制臺上打印：

date1: Thu Aug 02 22:05:55 CST 2018
date2: 2018-08-02 22:05:55

可以看到，加入 @DateTimeFormat 注解后參數(shù)可以被接收到了，但日期時間的格式還是需要自己再手動轉(zhuǎn)換一下。

因為 @DateTimeFormat 注解的 pattern 屬性值指定的日期時間格式并不是將要轉(zhuǎn)換成的日期格式，這個指定的格式是和傳入的參數(shù)對應的，假如注解為：

@DateTimeFormat(pattern="yyyy/MM/dd HH:mm:ss")
則傳入的參數(shù)應該是這樣的：
2018/08/02 22:05:55

否則會拋出異常。

出參格式化

在上述示例中，調(diào)用接口的返回結果為：

"date": "2018-08-01T14:25:31.296+0000"

這個格式并不是我們想要的，那么如何將其進行格式化？這時就需要用到 jackson  的 @JsonFormat 注解。

改造 DateVo：

public class DateVo {
? ? @DateTimeFormat(pattern="yyyy-MM-dd HH:mm:ss")
? ? @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
? ? private Date date;
? ? public void setDate(Date date){
? ? ? ? this.date = date;
? ? }
? ? public Date getDate(){
? ? ? ? return date;
? ? }
}

繼續(xù)訪問 /date/test ，并傳入?yún)?shù)：2018-08-02 22:05:55，可以看到接口返回的結果為：

"date": "2018-08-01 14:32:57"

雖然時間格式正確了，但實際上當前時間是 “2018-08-01 22:32:57” ，早了8個小時。

因為，jackson在序列化時間時是按照國際標準時間GMT進行格式化的，而在國內(nèi)默認時區(qū)使用的是CST時區(qū)，兩者相差8小時。

所以，@JsonFormat 注解還要再加一個屬性：

@JsonFormat(
? ? pattern = "yyyy-MM-dd HH:mm:ss"，
? ? timezone = "GMT+8"
)
private Date date;

這樣，結果就正確了。

因為 @JsonFormat 注解不是 Spring 自帶的注解，所以使用該注解前需要添加 jackson 相關的依賴包。

當然，如果是 SpringBoot 項目就不需要自己手動添加依賴了，因為在 spring-boot-start-web 下已經(jīng)包含了 jackson 相關依賴。

總結

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

最新評論