@DateTimeFormat 和 @JsonFormat 註解

1. 準備
定義一個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 ，並傳入參數：2018-08-02 22:05:55

發現並不能訪問成功，會拋出異常：

因爲傳入的參數是 String 類型的，而用來接收參數的 DateVo 的 date 屬性是 java.util.Date 類型的，類型無法轉換。

2. 入參格式化
這時，就可以使用 Spring 的 @DateTimeFormat 註解格式化參數，來解決上述問題。

改造 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 ，並傳入參數：2018-08-02 22:05:55，將在控制檯上打印：

date1:Thu Aug 02 22:05:55 CST 2018

date2:2018-08-02 22:05:55

可以看到，加入 @DateTimeFormat 註解後參數可以被接收到了，但日期時間的格式還是需要自己再手動轉換一下。

因爲 @DateTimeFormat 註解的 pattern 屬性值指定的日期時間格式並不是將要轉換成的日期格式，這個指定的格式是和傳入的參數對應的，假如註解爲：

@DateTimeFormat(pattern="yyyy/MM/dd HH:mm:ss")

則傳入的參數應該是這樣的：

2018/08/02 22:05:55

否則會拋出異常。

3. 出參格式化
在上述示例中，調用接口的返回結果爲：

"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;
    }
}
繼續訪問 /date/test ，並傳入參數：2018-08-02 22:05:55，可以看到接口返回的結果爲：

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

雖然時間格式正確了，但實際上當前時間是 “2018-08-01 22:32:57” ，早了8個小時。因爲，jackson在序列化時間時是按照國際標準時間GMT進行格式化的，而在國內默認時區使用的是CST時區，兩者相差8小時。

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

@JsonFormat(
    pattern = "yyyy-MM-dd HH:mm:ss"，
    timezone = "GMT+8"
)
private Date date;
這樣，結果就正確了。

因爲 @JsonFormat 註解不是 Spring 自帶的註解，所以使用該註解前需要添加 jackson 相關的依賴包。當然，如果是 SpringBoot 項目就不需要自己手動添加依賴了，因爲在 spring-boot-start-web 下已經包含了 jackson 相關依賴。