實(shí)體類中Date屬性格式化@JsonFormat @DateTimeFormat

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

在實(shí)體類的屬性上使用注解： 

@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: 默認(rèn)是GMT，中國(guó)需要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)，格式化后的時(shí)間比實(shí)際少了8小時(shí)，就要加上中國(guó)時(shí)區(qū)GMT+8

返給前臺(tái)的json值：

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

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

準(zhǔn)備

定義一個(gè)pojo，它有一個(gè) 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;
? ? }
}

定義一個(gè)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)并不能訪問成功，會(huì)拋出異常：

因?yàn)閭魅氲膮?shù)是 String 類型的，而用來接收參數(shù)的 DateVo 的 date 屬性是 java.util.Date 類型的，類型無法轉(zhuǎn)換。

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

這時(shí)，就可以使用 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，將在控制臺(tái)上打?。?/p>

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

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

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

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

否則會(huì)拋出異常。

出參格式化

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

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

這個(gè)格式并不是我們想要的，那么如何將其進(jìn)行格式化？這時(shí)就需要用到 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，可以看到接口返回的結(jié)果為：

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

雖然時(shí)間格式正確了，但實(shí)際上當(dāng)前時(shí)間是 “2018-08-01 22:32:57” ，早了8個(gè)小時(shí)。

因?yàn)?，jackson在序列化時(shí)間時(shí)是按照國(guó)際標(biāo)準(zhǔn)時(shí)間GMT進(jìn)行格式化的，而在國(guó)內(nèi)默認(rèn)時(shí)區(qū)使用的是CST時(shí)區(qū)，兩者相差8小時(shí)。

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

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

這樣，結(jié)果就正確了。

因?yàn)?@JsonFormat 注解不是 Spring 自帶的注解，所以使用該注解前需要添加 jackson 相關(guān)的依賴包。

當(dāng)然，如果是 SpringBoot 項(xiàng)目就不需要自己手動(dòng)添加依賴了，因?yàn)樵?spring-boot-start-web 下已經(jīng)包含了 jackson 相關(guān)依賴。

總結(jié)

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

最新評(píng)論