快捷導(dǎo)航

Springboot配置返回日期格式化五種方法詳解

更新時(shí)間：2022年07月13日 11:59:09 作者：流楚丶格念

本文主要介紹了Springboot配置返回日期格式化五種方法詳解，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

格式化全局時(shí)間字段

在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
        ## 定時(shí)區(qū)，解決8小時(shí)的時(shí)間差問題
        time-zone: GMT+8

OK了，你后端全統(tǒng)一了，應(yīng)急的同志們就這樣就行了，不用學(xué)下面的擴(kuò)展知識(shí)，想學(xué)習(xí)的可以先收藏（建議別收藏，收藏了也不看，要不一口氣看完點(diǎn)個(gè)贊，要不別收藏來欺騙自己了）

系統(tǒng)的知識(shí)

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

前端工程時(shí)間格式化方法，實(shí)現(xiàn)代碼如下。

// JS 版時(shí)間格式化
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(),           // 時(shí)
        "M+": date.getMinutes().toString(),         // 分
        "S+": date.getSeconds().toString()          // 秒
        // 有其他格式化字符需求可以繼續(xù)添加，必須轉(zhuǎn)化成字符串
    };
    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;
}

方法調(diào)用：

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

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

不，我們不能，堅(jiān)決在后端改！?。。。?！

2.SimpleDateFormat格式化（不推薦）

使用 SimpleDateFormat 來進(jìn)行時(shí)間格式化，它也是 JDK 8 之前重要的時(shí)間格式化方法，它的核心實(shí)現(xiàn)代碼如下：

// 定義時(shí)間格式化對(duì)象和定義格式化樣式
SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
// 格式化時(shí)間對(duì)象
String date = dateFormat.format(new Date())

接下來我們使用 SimpleDateFormat 來實(shí)現(xiàn)一下本項(xiàng)目中的時(shí)間格式化，它的實(shí)現(xiàn)代碼如下：

@RequestMapping("/list")
public List<User> getList() {
    // 定義時(shí)間格式化對(duì)象
    SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    List<User> list = userMapper.getList();
    // 循環(huán)執(zhí)行時(shí)間格式化
    list.forEach(item -> {
        // 使用預(yù)留字段 ctime 接收 createtime 格式化的時(shí)間(Date->String)
        item.setCtime(dateFormat.format(item.getCreatetime()));
        item.setUtime(dateFormat.format(item.getUpdatetime()));
    });
    return list;
}

但是這樣會(huì)產(chǎn)生新的問題，為什么接口的返回字段咋變了呢，之前的字段是 createtime 現(xiàn)在卻是 ctime。

這是因?yàn)槭褂?SimpleDateFormat.format 方法之后，它返回的是一個(gè) String 類型的結(jié)果，而我們之前的 createtime 和 updatetime 字段都是 Date 類型的，因此它們是不能接收時(shí)間格式化得結(jié)果的。

3.DateTimeFormatter格式化（不推薦）

JDK 8 之后，我們可以使用 DateTimeFormatter 來替代 SimpleDateFormat，因?yàn)?SimpleDateFormat 是非線程安全的，而 DateTimeFormatter 是線程安全的，所以如果是 JDK 8 以上的項(xiàng)目，盡量使用 DateTimeFormatter 來進(jìn)行時(shí)間格式化。

DateTimeFormatter 格式化的代碼和 SimpleDateFormat 類似，具體實(shí)現(xiàn)如下：

@RequestMapping("/list")
public List<User> getList() {
    // 定義時(shí)間格式化對(duì)象
    DateTimeFormatter dateFormat = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
    List<User> list = userMapper.getList();
    // 循環(huán)執(zhí)行時(shí)間格式化
    list.forEach(item -> {
        // 使用預(yù)留字段 ctime 接收 createtime 格式化的時(shí)間(Date->String)
        item.setCtime(dateFormat.format(item.getCreatetime()));
        item.setUtime(dateFormat.format(item.getUpdatetime()));
    });
    return list;
}

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

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.全局時(shí)間格式化（推薦）

以上兩種后端格式化的實(shí)現(xiàn)都有一個(gè)致命的缺點(diǎn)，它們?cè)谶M(jìn)行時(shí)間格式化的時(shí)候，都需要對(duì)核心業(yè)務(wù)類做一定的修改，這就相當(dāng)為了解決一個(gè)問題，又引入了一個(gè)新的問題，那有沒有簡(jiǎn)單一點(diǎn)、優(yōu)雅一點(diǎn)的解決方案呢？

答案是：有的。我們可以不改任何代碼，只需要在配置文件中設(shè)置一下就可以實(shí)現(xiàn)時(shí)間格式化的功能了。

首先，我們找到 Spring Boot 的配置文件 application.properties（或 application.yml），只需要在 application.properties 配置文件中添加以下兩行配置：

格式化全局時(shí)間字段

在yml中添加如下配置：

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

指定時(shí)間區(qū)域類型
在yml中添加：

spring.jackson.time-zone=GMT+8

或者下面的格式

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

這樣設(shè)置之后，我們將原始的 User 和 UserController 進(jìn)行還原。

User 實(shí)現(xiàn)代碼如下：

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

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

UserController 實(shí)現(xiàn)代碼：

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

然后我們運(yùn)行程序，看到的執(zhí)行結(jié)果如下：

從以上結(jié)果和代碼可以看出，我們只需要在程序中簡(jiǎn)單配置一下，就可以實(shí)現(xiàn)所有時(shí)間字段的格式化了。

實(shí)現(xiàn)原理分析

為什么在配置文件中設(shè)置一下，就可以實(shí)現(xiàn)所有時(shí)間字段的格式化了呢？

# 格式化全局時(shí)間字段
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
# 指定時(shí)間區(qū)域類型
spring.jackson.time-zone=GMT+8

這是因?yàn)?Controller 在返回?cái)?shù)據(jù)時(shí)，會(huì)自動(dòng)調(diào)用 Spring Boot 框架中內(nèi)置的 JSON 框架 Jackson，對(duì)返回的數(shù)據(jù)進(jìn)行統(tǒng)一的 JSON 格式化處理，在處理的過程中它會(huì)判斷配置文件中是否設(shè)置了“spring.jackson.date-format=yyyy-MM-dd HH:mm:ss”，如果設(shè)置了，那么 Jackson 框架在對(duì)時(shí)間類型的字段輸出時(shí)就會(huì)執(zhí)行時(shí)間格式化的處理，這樣我們就通過配置來實(shí)現(xiàn)全局時(shí)間字段的格式化功能了。

為什么要指定時(shí)間區(qū)域類型“spring.jackson.time-zone=GMT+8”呢？

最現(xiàn)實(shí)的原因是，如果我們不指定時(shí)間區(qū)域類型，那么查詢出來的時(shí)間就會(huì)比預(yù)期的時(shí)間少 8 個(gè)小時(shí)，這因?yàn)槲覀儯ㄖ袊┧幍臅r(shí)間區(qū)域比世界時(shí)間少 8 個(gè)小時(shí)導(dǎo)致的，而當(dāng)我們?cè)O(shè)置了時(shí)區(qū)之后，我們的時(shí)間查詢才會(huì)和預(yù)期時(shí)間保持一致。

GMT 是什么？時(shí)間區(qū)域設(shè)置中的“GMT” 是什么意思？

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

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

格林尼治時(shí)間：格林尼治是英國倫敦南郊原皇家格林尼治天文臺(tái)所在地，地球本初子午線的標(biāo)界處，世界計(jì)算時(shí)間和經(jīng)度的起點(diǎn)。以其海事歷史、作為本初子午線的標(biāo)準(zhǔn)點(diǎn)、以及格林尼治時(shí)間以其命名而聞名于世。這里地勢(shì)險(xiǎn)要，風(fēng)景秀麗，兼具歷史和地方風(fēng)情，也是倫敦在泰晤士河的東方門戶。

不光是天文學(xué)家使用格林尼治時(shí)間，就是在新聞報(bào)刊上也經(jīng)常出現(xiàn)這個(gè)名詞。我們知道各地都有各地的地方時(shí)間。如果對(duì)國際上某一重大事情，用地方時(shí)間來記錄，就會(huì)感到復(fù)雜不便．而且將來日子一長(zhǎng)容易搞錯(cuò)。因此，天文學(xué)家就提出一個(gè)大家都能接受且又方便的記錄方法，那就是以格林尼治的地方時(shí)間為標(biāo)準(zhǔn)。

以本初子午線的平子夜起算的平太陽時(shí)。又稱格林尼治平時(shí)或格林尼治時(shí)間。各地的地方平時(shí)與世界時(shí)之差等于該地的地理經(jīng)度。1960年以前曾作為基本時(shí)間計(jì)量系統(tǒng)被廣泛應(yīng)用。由于地球自轉(zhuǎn)速率曾被認(rèn)為是均勻的,因此在1960年以前,世界時(shí)被認(rèn)為是一種均勻時(shí)。由于地球自轉(zhuǎn)速度變化的影響，它不是一種均勻的時(shí)間系統(tǒng)，它與原子時(shí)或力學(xué)時(shí)都沒有任何理論上的關(guān)系,只有通過觀測(cè)才能對(duì)它們進(jìn)行比較。后來世界時(shí)先后被歷書時(shí)和原子時(shí)所取代，但在日常生活、天文導(dǎo)航、大地測(cè)量和宇宙飛行等方面仍屬必需；同時(shí)，世界時(shí)反映地球自轉(zhuǎn)速率的變化，是地球自轉(zhuǎn)參數(shù)之一，仍為天文學(xué)和地球物理學(xué)的基本資料。

5.部分時(shí)間格式化（推薦）

某些場(chǎng)景下，我們不需要對(duì)全局的時(shí)間都進(jìn)行統(tǒng)一的處理，這種情況我們可以使用注解的方式來實(shí)現(xiàn)部分時(shí)間字段的格式化。

例如需要在實(shí)體類 User 中添加 @JsonFormat 注解，這樣就可以實(shí)現(xiàn)時(shí)間的格式化功能了，實(shí)現(xiàn)代碼如下：

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

import java.util.Date;

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

修改完代碼之后，我們運(yùn)行項(xiàng)目就可以顯示格式化后的時(shí)間了