在我們?nèi)粘９ぷ髦校瑫r(shí)間格式化是一件經(jīng)常遇到的事兒，所以本文我們就來(lái)盤點(diǎn)一下 Spring Boot 中時(shí)間格式化的幾種方法。

時(shí)間問(wèn)題演示

為了方便演示，我寫(xiě)了一個(gè)簡(jiǎn)單 Spring Boot 項(xiàng)目，其中數(shù)據(jù)庫(kù)中包含了一張 userinfo 表，它的組成結(jié)構(gòu)和數(shù)據(jù)信息如下：

項(xiàng)目目錄是這樣的：

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

@RestController
@RequestMApping("/user")
public class UserController {
    @Resource
    private UserMapper userMapper;

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

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

@Mapper
public interface UserMapper {
    public List<UserInfo> getList();
}

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

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

UserMapper.xml 實(shí)現(xiàn)代碼如下：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//MyBatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.example.demo.mapper.UserMapper">
    <select id="getList" resultType="com.example.demo.model.UserInfo">
        select * from userinfo
    </select>
</mapper>

經(jīng)過(guò)以上內(nèi)容的編寫(xiě)，我們就制作出了一個(gè)簡(jiǎn)單的 Spring Boot 項(xiàng)目了。接下來(lái)，我們使用 PostMan 來(lái)模擬調(diào)用 UserController 接口，執(zhí)行結(jié)果如下：

從上述結(jié)果可以看出，時(shí)間字段 createtime 和 updatetime 的顯示方式是很“凌亂”的，并不符合我們的閱讀習(xí)慣，也不能直接展示給前端的用戶使用，這時(shí)候，我們就需要對(duì)時(shí)間進(jìn)行格式化處理了。

時(shí)間格式化的方法總共包含以下 5 種。

1.前端時(shí)間格式化

如果后端在公司中擁有絕對(duì)的話語(yǔ)權(quán)，或者是后端比較強(qiáng)勢(shì)的情況下，我們可以將時(shí)間格式化的這個(gè)“鍋”強(qiáng)行甩給前端來(lái)處理。

為了讓這個(gè)“鍋”甩的更平順一些（磊哥不做廚師都可惜了），咱們可以給前端工程師提供切實(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);

>>> 2021-07-25 21:45:12

2.SimpleDateFormat格式化

大多數(shù)情況下，我們還是需要自力更生，各掃門前雪的，這個(gè)時(shí)候我們后端程序員就需要發(fā)揮自己的特長(zhǎng)了，我們提供的第 1 個(gè)時(shí)間格式化的方法是使用 SimpleDateFormat來(lái)進(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())

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

@RequestMapping("/list")
public List<UserInfo> getList() {
    // 定義時(shí)間格式化對(duì)象
    SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    List<UserInfo> 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;
}

程序執(zhí)行結(jié)果如下：

從上述結(jié)果可以看出，時(shí)間格式化沒(méi)有任何問(wèn)題，以及到底我們預(yù)想的目的了。但細(xì)心的讀者會(huì)發(fā)現(xiàn)，為什么接口的返回字段咋變了呢？（之前的字段是 createtime 現(xiàn)在卻是 ctime...）

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

所以此時(shí)我們就需要在實(shí)體類 UserInfo 新增兩個(gè)字符串類型的“時(shí)間”字段，再將之前Data 類型的時(shí)間字段進(jìn)行隱藏，最終實(shí)體類 UserInfo 的實(shí)現(xiàn)代碼如下：

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

import JAVA.util.Date;

@Data
public class UserInfo {
    private int id;
    private String username;
    @JsonIgnore // 輸出結(jié)果時(shí)隱藏此字段
    private Date createtime;
    // 時(shí)間格式化后的字段
    private String ctime;
    @JsonIgnore // 輸出結(jié)果時(shí)隱藏此字段
    private Date updatetime;
    // 時(shí)間格式化后的字段
    private String utime;
}

我們可以使用 @JsonIgnore 注解將字段進(jìn)行隱藏，隱藏之后的執(zhí)行結(jié)果如下：

3.DateTimeFormatter格式化

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

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

@RequestMapping("/list")
public List<UserInfo> getList() {
    // 定義時(shí)間格式化對(duì)象
    DateTimeFormatter dateFormat = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
    List<UserInfo> 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;
}

執(zhí)行結(jié)果如下所示：

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

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

import java.time.LocalDateTime;

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

我們可以使用 LocalDateTime 來(lái)接收 MySQL 中的 datetime 類型。

4.全局時(shí)間格式化

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

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

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

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

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

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

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

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

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

@RequestMapping("/list")
public List<UserInfo> 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 格式化處理，在處理的過(guò)程中它會(huì)判斷配置文件中是否設(shè)置了“spring.jackson.date-format=yyyy-MM-dd HH:mm:ss”，如果設(shè)置了，那么 Jackson 框架在對(duì)時(shí)間類型的字段輸出時(shí)就會(huì)執(zhí)行時(shí)間格式化的處理，這樣我們就通過(guò)配置來(lái)實(shí)現(xiàn)全局時(shí)間字段的格式化功能了。

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

最現(xiàn)實(shí)的原因是，如果我們不指定時(shí)間區(qū)域類型，那么查詢出來(lái)的時(shí)間就會(huì)比預(yù)期的時(shí)間少 8 個(gè)小時(shí)，這因?yàn)槲覀儯ㄖ袊?guó)）所處的時(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í)間

格林尼治是英國(guó)倫敦南郊原皇家格林尼治天文臺(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ì)國(guó)際上某一重大事情，用地方時(shí)間來(lái)記錄，就會(huì)感到復(fù)雜不便．而且將來(lái)日子一長(zhǎng)容易搞錯(cuò)。因此，天文學(xué)家就提出一個(gè)大家都能接受且又方便的記錄方法，那就是以格林尼治的地方時(shí)間為標(biāo)準(zhǔn)。

以本初子午線的平子夜起算的平太陽(yáng)時(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í)都沒(méi)有任何理論上的關(guān)系,只有通過(guò)觀測(cè)才能對(duì)它們進(jìn)行比較。后來(lái)世界時(shí)先后被歷書(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)一的處理，這種情況我們可以使用注解的方式來(lái)實(shí)現(xiàn)部分時(shí)間字段的格式化。

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

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

import java.util.Date;

@Data
public class UserInfo {
    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)目執(zhí)行結(jié)果如下：

從上述結(jié)果可以看出，使用注解的方式也可以實(shí)現(xiàn)時(shí)間的格式化。它的實(shí)現(xiàn)原理和第 4 種時(shí)間格式化的實(shí)現(xiàn)原理類似，都是在返回?cái)?shù)據(jù)之前，對(duì)相應(yīng)的字段進(jìn)行時(shí)間格式化的處理。

總結(jié)

本文我們介紹了 5 種時(shí)間格式化的實(shí)現(xiàn)方法，其中第 1 種為前端時(shí)間格式化的方法，后 4 種為后端格式化的方法，SimpleDateFormat 和 DateTimeFormatter 格式化的方法更適用普通的 Java 項(xiàng)目，其中 SimpleDateFormat 是非線程安全的，而 DateTimeFormatter 是線程安全的，但它們都不是 Spring Boot 項(xiàng)目中最優(yōu)的時(shí)間格式化方案。

如果是 Spring Boot 的項(xiàng)目，推薦使用第 4 種全局時(shí)間格式化或第 5 種局部時(shí)間格式化的方式，這兩種實(shí)現(xiàn)方式都無(wú)需修改核心業(yè)務(wù)代碼，只需要簡(jiǎn)單的配置一下，就可以完成時(shí)間的格式化功能了。