Springboot設定返回日期格式化五種方法詳解

2022-07-13 14:00:42

格式化全域性時間欄位

在yml中新增如下設定：

spring.jackson.date-format=yyyy-MM-dd HH:mm:ss

或者

spring:
    jackson:
        ## 格式為yyyy-MM-dd HH:mm:ss
        date-format: yyyy-MM-dd HH:mm:ss
        ## 定時區，解決8小時的時間差問題
        time-zone: GMT+8

OK了，你後端全統一了，應急的同志們就這樣就行了，不用學下面的擴充套件知識，想學習的可以先收藏（建議別收藏，收藏了也不看，要不一口氣看完點個贊，要不別收藏來欺騙自己了）

系統的知識

1.前端時間格式化（不做無情人）

前端工程時間格式化方法，實現程式碼如下。

// JS 版時間格式化
function dateFormat(fmt, date) {
    let ret;
    const opt = {
        "Y+": date.getFullYear().toString(),        // 年
        "m+": (date.getMonth() + 1).toString(),     // 月
        "d+": date.getDate().toString(),            // 日
        "H+": date.getHours().toString(),           // 時
        "M+": date.getMinutes().toString(),         // 分
        "S+": date.getSeconds().toString()          // 秒
        // 有其他格式化字元需求可以繼續新增，必須轉化成字串
    };
    for (let k in opt) {
        ret = new RegExp("(" + k + ")").exec(fmt);
        if (ret) {
            fmt = fmt.replace(ret[1], (ret[1].length == 1) ? (opt[k]) : (opt[k].padStart(ret[1].length, "0")))
        };
    };
    return fmt;
}

方法呼叫：

let date = new Date();
dateFormat("YYYY-mm-dd HH:MM:SS", date);

但是我們能對前端小姐姐這麼殘忍嗎？？？？？就像下面的前端小姐姐這麼可愛，你忍心？？？？？

不，我們不能，堅決在後端改！！！！！！

2.SimpleDateFormat格式化（不推薦）

使用 SimpleDateFormat 來進行時間格式化，它也是 JDK 8 之前重要的時間格式化方法，它的核心實現程式碼如下：

// 定義時間格式化物件和定義格式化樣式
SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
// 格式化時間物件
String date = dateFormat.format(new Date())

接下來我們使用 SimpleDateFormat 來實現一下本專案中的時間格式化，它的實現程式碼如下：

@RequestMapping("/list")
public List<User> getList() {
    // 定義時間格式化物件
    SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    List<User> list = userMapper.getList();
    // 迴圈執行時間格式化
    list.forEach(item -> {
        // 使用預留欄位 ctime 接收 createtime 格式化的時間(Date->String)
        item.setCtime(dateFormat.format(item.getCreatetime()));
        item.setUtime(dateFormat.format(item.getUpdatetime()));
    });
    return list;
}

但是這樣會產生新的問題，為什麼介面的返回欄位咋變了呢，之前的欄位是 createtime 現在卻是 ctime。

這是因為使用 SimpleDateFormat.format 方法之後，它返回的是一個 String 型別的結果，而我們之前的 createtime 和 updatetime 欄位都是 Date 型別的，因此它們是不能接收時間格式化得結果的。

3.DateTimeFormatter格式化（不推薦）

JDK 8 之後，我們可以使用 DateTimeFormatter 來替代 SimpleDateFormat，因為 SimpleDateFormat 是非執行緒安全的，而 DateTimeFormatter 是執行緒安全的，所以如果是 JDK 8 以上的專案，儘量使用 DateTimeFormatter 來進行時間格式化。

DateTimeFormatter 格式化的程式碼和 SimpleDateFormat 類似，具體實現如下：

@RequestMapping("/list")
public List<User> getList() {
    // 定義時間格式化物件
    DateTimeFormatter dateFormat = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
    List<User> list = userMapper.getList();
    // 迴圈執行時間格式化
    list.forEach(item -> {
        // 使用預留欄位 ctime 接收 createtime 格式化的時間(Date->String)
        item.setCtime(dateFormat.format(item.getCreatetime()));
        item.setUtime(dateFormat.format(item.getUpdatetime()));
    });
    return list;
}

DateTimeFormatter 和 SimpleDateFormat 在使用上的區別是 DateTimeFormatter 是用來格式化 JDK 8 提供的時間型別的，如 LocalDateTime，而 SimpleDateFormat 是用來格式化 Date 型別的，所以我們需要對 Userer 實體類做如下的修改：

import com.fasterxml.jackson.annotation.JsonIgnore;
import lombok.Data;

import java.time.LocalDateTime;

@Data
public class User {
    private int id;
    private String username;
    @JsonIgnore
    private LocalDateTime createtime;
    private String ctime;
    @JsonIgnore
    private LocalDateTime updatetime;
    private String utime;
}

我們可以使用 LocalDateTime 來接收 MySQL 中的 datetime 型別。

4.全域性時間格式化（推薦）

以上兩種後端格式化的實現都有一個致命的缺點，它們在進行時間格式化的時候，都需要對核心業務類做一定的修改，這就相當為了解決一個問題，又引入了一個新的問題，那有沒有簡單一點、優雅一點的解決方案呢？

答案是：有的。我們可以不改任何程式碼，只需要在組態檔中設定一下就可以實現時間格式化的功能了。

首先，我們找到 Spring Boot 的組態檔 application.properties（或 application.yml），只需要在 application.properties 組態檔中新增以下兩行設定：

格式化全域性時間欄位

在yml中新增如下設定：

spring.jackson.date-format=yyyy-MM-dd HH:mm:ss

指定時間區域型別
在yml中新增：

spring.jackson.time-zone=GMT+8

或者下面的格式

spring:
    jackson:
        ## 格式為yyyy-MM-dd HH:mm:ss
        date-format: yyyy-MM-dd HH:mm:ss
        ## 定時區，解決8小時的時間差問題
        time-zone: GMT+8

這樣設定之後，我們將原始的 User 和 UserController 進行還原。

User 實現程式碼如下：

import lombok.Data;
import java.util.Date;

@Data
public class User {
    private int id;
    private String username;
    private Date createtime;
    private Date updatetime;
}

UserController 實現程式碼：

@RequestMapping("/list")
public List<User> getList() {
    return userMapper.getList();
}

然後我們執行程式，看到的執行結果如下：

從以上結果和程式碼可以看出，我們只需要在程式中簡單設定一下，就可以實現所有時間欄位的格式化了。

實現原理分析

為什麼在組態檔中設定一下，就可以實現所有時間欄位的格式化了呢？

# 格式化全域性時間欄位
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
# 指定時間區域型別
spring.jackson.time-zone=GMT+8

這是因為 Controller 在返回資料時，會自動呼叫 Spring Boot 框架中內建的 JSON 框架 Jackson，對返回的資料進行統一的 JSON 格式化處理，在處理的過程中它會判斷組態檔中是否設定了“spring.jackson.date-format=yyyy-MM-dd HH:mm:ss”，如果設定了，那麼 Jackson 框架在對時間型別的欄位輸出時就會執行時間格式化的處理，這樣我們就通過設定來實現全域性時間欄位的格式化功能了。

為什麼要指定時間區域型別“spring.jackson.time-zone=GMT+8”呢？

最現實的原因是，如果我們不指定時間區域型別，那麼查詢出來的時間就會比預期的時間少 8 個小時，這因為我們（中國）所處的時間區域比世界時間少 8 個小時導致的，而當我們設定了時區之後，我們的時間查詢才會和預期時間保持一致。

GMT 是什麼？時間區域設定中的“GMT” 是什麼意思？

Greenwich Mean Time (GMT) 格林尼治時間，也叫做世界時間。

（下面是格林尼治時間的百度百科，想了解的可以看一下，不想了解的知道是世界時間就行，其他的就是的臀部——規定）

格林尼治時間：格林尼治是英國倫敦南郊原皇家格林尼治天文臺所在地，地球本初子午線的標界處，世界計算時間和經度的起點。以其海事歷史、作為本初子午線的標準點、以及格林尼治時間以其命名而聞名於世。這裡地勢險要，風景秀麗，兼具歷史和地方風情，也是倫敦在泰晤士河的東方門戶。

不光是天文學家使用格林尼治時間，就是在新聞報刊上也經常出現這個名詞。我們知道各地都有各地的地方時間。如果對國際上某一重大事情，用地方時間來記錄，就會感到複雜不便．而且將來日子一長容易搞錯。因此，天文學家就提出一個大家都能接受且又方便的記錄方法，那就是以格林尼治的地方時間為標準。

以本初子午線的平子夜起算的平太陽時。又稱格林尼治平時或格林尼治時間。各地的地方平時與世界時之差等於該地的地理經度。1960年以前曾作為基本時間計量系統被廣泛應用。由於地球自轉速率曾被認為是均勻的,因此在1960年以前,世界時被認為是一種均勻時。由於地球自轉速度變化的影響，它不是一種均勻的時間系統，它與原子時或力學時都沒有任何理論上的關係,只有通過觀測才能對它們進行比較。後來世界時先後被曆書時和原子時所取代，但在日常生活、天文導航、大地測量和宇宙飛行等方面仍屬必需；同時，世界時反映地球自轉速率的變化，是地球自轉引數之一，仍為天文學和地球物理學的基本資料。

5.部分時間格式化（推薦）

某些場景下，我們不需要對全域性的時間都進行統一的處理，這種情況我們可以使用註解的方式來實現部分時間欄位的格式化。

例如需要在實體類 User 中新增 @JsonFormat 註解，這樣就可以實現時間的格式化功能了，實現程式碼如下：

import com.fasterxml.jackson.annotation.JsonFormat;
import lombok.Data;

import java.util.Date;

@Data
public class User {
    private int id;
    private String username;
    // 對 createtime 欄位進行格式化處理
    @JsonFormat(pattern = "yyyy-MM-dd hh:mm:ss", timezone = "GMT+8")
    private Date createtime;
    private Date updatetime;
}

修改完程式碼之後，我們執行專案就可以顯示格式化後的時間了