SpringBoot中時間格式化的五種方法匯總
前言
在我們?nèi)粘9ぷ髦?,時間格式化是一件經(jīng)常遇到的事兒,所以本文我們就來盤點(diǎn)一下 Spring Boot 中時間格式化的幾種方法。
時間問題演示
為了方便演示,我寫了一個簡單 Spring Boot 項(xiàng)目,其中數(shù)據(jù)庫中包含了一張 userinfo 表,它的組成結(jié)構(gòu)和數(shù)據(jù)信息如下:
項(xiàng)目目錄是這樣的:
UserController 實(shí)現(xiàn)代碼如下:
@RestController @RequestMapping("/user") publicclass UserController { @Resource private UserMapper userMapper; @RequestMapping("/list") public List<UserInfo> getList() { return userMapper.getList(); } }
UserMapper 實(shí)現(xiàn)代碼如下:
@Mapper publicinterface UserMapper { public List<UserInfo> getList(); }
UserInfo 實(shí)現(xiàn)代碼如下:
@Data publicclass UserInfo { privateint 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)過以上內(nèi)容的編寫,我們就制作出了一個簡單的 Spring Boot 項(xiàng)目了。接下來,我們使用 PostMan 來模擬調(diào)用 UserController 接口,執(zhí)行結(jié)果如下:
從上述結(jié)果可以看出,時間字段 createtime 和 updatetime 的顯示方式是很“凌亂”的,并不符合我們的閱讀習(xí)慣,也不能直接展示給前端的用戶使用,這時候,我們就需要對時間進(jìn)行格式化處理了。
時間格式化的方法總共包含以下 5 種。
1.前端時間格式化
如果后端在公司中擁有絕對的話語權(quán),或者是后端比較強(qiáng)勢的情況下,我們可以將時間格式化的這個“鍋”強(qiáng)行甩給前端來處理。
為了讓這個“鍋”甩的更平順一些(磊哥不做廚師都可惜了),咱們可以給前端工程師提供切實(shí)可行的時間格式化方法,實(shí)現(xiàn)代碼如下。
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() // 秒 // 有其他格式化字符需求可以繼續(xù)添加,必須轉(zhuǎn)化成字符串 }; for (let k in opt) { ret = newRegExp("(" + 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 = newDate(); dateFormat("YYYY-mm-dd HH:MM:SS", date); >>> 2021-07-2521:45:12
2.SimpleDateFormat格式化
大多數(shù)情況下,我們還是需要自力更生,各掃門前雪的,這個時候我們后端程序員就需要發(fā)揮自己的特長了,我們提供的第 1 個時間格式化的方法是使用 SimpleDateFormat 來進(jìn)行時間格式化,它也是 JDK 8 之前重要的時間格式化方法,它的核心實(shí)現(xiàn)代碼如下:
// 定義時間格式化對象和定義格式化樣式 SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"); // 格式化時間對象 String date = dateFormat.format(new Date())
接下來我們使用 SimpleDateFormat 來實(shí)現(xiàn)一下本項(xiàng)目中的時間格式化,它的實(shí)現(xiàn)代碼如下:
@RequestMapping("/list") public List<UserInfo> getList() { // 定義時間格式化對象 SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"); List<UserInfo> list = userMapper.getList(); // 循環(huán)執(zhí)行時間格式化 list.forEach(item -> { // 使用預(yù)留字段 ctime 接收 createtime 格式化的時間(Date->String) item.setCtime(dateFormat.format(item.getCreatetime())); item.setUtime(dateFormat.format(item.getUpdatetime())); }); return list; }
程序執(zhí)行結(jié)果如下:
從上述結(jié)果可以看出,時間格式化沒有任何問題,以及到底我們預(yù)想的目的了。但細(xì)心的讀者會發(fā)現(xiàn),為什么接口的返回字段咋變了呢?(之前的字段是 createtime 現(xiàn)在卻是 ctime...)
這是因?yàn)槭褂?#SimpleDateFormat.format 方法之后,它返回的是一個 String 類型的結(jié)果,而我們之前的 createtime 和 updatetime 字段都是 Date 類型的,因此它們是不能接收時間格式化得結(jié)果的。
所以此時我們就需要在實(shí)體類 UserInfo 新增兩個字符串類型的“時間”字段,再將之前 Data 類型的時間字段進(jìn)行隱藏,最終實(shí)體類 UserInfo 的實(shí)現(xiàn)代碼如下:
import com.fasterxml.jackson.annotation.JsonIgnore; import lombok.Data; import java.util.Date; @Data publicclass UserInfo { privateint id; private String username; @JsonIgnore// 輸出結(jié)果時隱藏此字段 private Date createtime; // 時間格式化后的字段 private String ctime; @JsonIgnore// 輸出結(jié)果時隱藏此字段 private Date updatetime; // 時間格式化后的字段 private String utime; }
我們可以使用 @JsonIgnore 注解將字段進(jìn)行隱藏,隱藏之后的執(zhí)行結(jié)果如下:
3.DateTimeFormatter格式化
JDK 8 之后,我們可以使用 DateTimeFormatter 來替代 SimpleDateFormat,因?yàn)?SimpleDateFormat 是非線程安全的,而 DateTimeFormatter 是線程安全的,所以如果是 JDK 8 以上的項(xiàng)目,盡量使用 DateTimeFormatter 來進(jìn)行時間格式化。
DateTimeFormatter 格式化的代碼和 SimpleDateFormat 類似,具體實(shí)現(xiàn)如下:
@RequestMapping("/list") public List<UserInfo> getList() { // 定義時間格式化對象 DateTimeFormatter dateFormat = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"); List<UserInfo> list = userMapper.getList(); // 循環(huán)執(zhí)行時間格式化 list.forEach(item -> { // 使用預(yù)留字段 ctime 接收 createtime 格式化的時間(Date->String) item.setCtime(dateFormat.format(item.getCreatetime())); item.setUtime(dateFormat.format(item.getUpdatetime())); }); return list; }
執(zhí)行結(jié)果如下所示:
DateTimeFormatter 和 SimpleDateFormat 在使用上的區(qū)別是 DateTimeFormatter 是用來格式化 JDK 8 提供的時間類型的,如 LocalDateTime,而 SimpleDateFormat 是用來格式化 Date 類型的,所以我們需要對 UserInfoer 實(shí)體類做如下的修改:
import com.fasterxml.jackson.annotation.JsonIgnore; import lombok.Data; import java.time.LocalDateTime; @Data publicclass UserInfo { privateint id; private String username; @JsonIgnore private LocalDateTime createtime; private String ctime; @JsonIgnore private LocalDateTime updatetime; private String utime; }
我們可以使用 LocalDateTime 來接收 MySQL 中的 datetime 類型。
4.全局時間格式化
以上兩種后端格式化的實(shí)現(xiàn)都有一個致命的缺點(diǎn),它們在進(jìn)行時間格式化的時候,都需要對核心業(yè)務(wù)類做一定的修改,這就相當(dāng)為了解決一個問題,又引入了一個新的問題,那有沒有簡單一點(diǎn)、優(yōu)雅一點(diǎn)的解決方案呢?
答案是:有的。我們可以不改任何代碼,只需要在配置文件中設(shè)置一下就可以實(shí)現(xiàn)時間格式化的功能了。
首先,我們找到 Spring Boot 的配置文件 application.properties(或 application.yml),只需要在 application.properties 配置文件中添加以下兩行配置:
# 格式化全局時間字段
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
# 指定時間區(qū)域類型
spring.jackson.time-zone=GMT+8
這樣設(shè)置之后,我們將原始的 UserInfo 和 UserController 進(jìn)行還原。
UserInfo 實(shí)現(xiàn)代碼如下:
import lombok.Data; import java.util.Date; @Data publicclass UserInfo { privateint 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é)果和代碼可以看出,我們只需要在程序中簡單配置一下,就可以實(shí)現(xiàn)所有時間字段的格式化了。
實(shí)現(xiàn)原理分析
為什么在配置文件中設(shè)置一下,就可以實(shí)現(xiàn)所有時間字段的格式化了呢?
# 格式化全局時間字段
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
# 指定時間區(qū)域類型
spring.jackson.time-zone=GMT+8
這是因?yàn)?Controller 在返回數(shù)據(jù)時,會自動調(diào)用 Spring Boot 框架中內(nèi)置的 JSON 框架 Jackson,對返回的數(shù)據(jù)進(jìn)行統(tǒng)一的 JSON 格式化處理,在處理的過程中它會判斷配置文件中是否設(shè)置了“spring.jackson.date-format=yyyy-MM-dd HH:mm:ss”,如果設(shè)置了,那么 Jackson 框架在對時間類型的字段輸出時就會執(zhí)行時間格式化的處理,這樣我們就通過配置來實(shí)現(xiàn)全局時間字段的格式化功能了。
為什么要指定時間區(qū)域類型“spring.jackson.time-zone=GMT+8”呢?
最現(xiàn)實(shí)的原因是,如果我們不指定時間區(qū)域類型,那么查詢出來的時間就會比預(yù)期的時間少 8 個小時,這因?yàn)槲覀儯ㄖ袊┧幍臅r間區(qū)域比世界時間少 8 個小時導(dǎo)致的,而當(dāng)我們設(shè)置了時區(qū)之后,我們的時間查詢才會和預(yù)期時間保持一致。
GMT 是什么?
時間區(qū)域設(shè)置中的“GMT” 是什么意思?
Greenwich Mean Time (GMT) 格林尼治時間,也叫做世界時間。
格林尼治時間
格林尼治是英國倫敦南郊原皇家格林尼治天文臺所在地,地球本初子午線的標(biāo)界處,世界計算時間和經(jīng)度的起點(diǎn)。以其海事歷史、作為本初子午線的標(biāo)準(zhǔn)點(diǎn)、以及格林尼治時間以其命名而聞名于世。這里地勢險要,風(fēng)景秀麗,兼具歷史和地方風(fēng)情,也是倫敦在泰晤士河的東方門戶。
不光是天文學(xué)家使用格林尼治時間,就是在新聞報刊上也經(jīng)常出現(xiàn)這個名詞。我們知道各地都有各地的地方時間。如果對國際上某一重大事情,用地方時間來記錄,就會感到復(fù)雜不便.而且將來日子一長容易搞錯。因此,天文學(xué)家就提出一個大家都能接受且又方便的記錄方法,那就是以格林尼治的地方時間為標(biāo)準(zhǔn)。
以本初子午線的平子夜起算的平太陽時。又稱格林尼治平時或格林尼治時間。各地的地方平時與世界時之差等于該地的地理經(jīng)度。1960年以前曾作為基本時間計量系統(tǒng)被廣泛應(yīng)用。由于地球自轉(zhuǎn)速率曾被認(rèn)為是均勻的,因此在1960年以前,世界時被認(rèn)為是一種均勻時。由于地球自轉(zhuǎn)速度變化的影響,它不是一種均勻的時間系統(tǒng),它與原子時或力學(xué)時都沒有任何理論上的關(guān)系,只有通過觀測才能對它們進(jìn)行比較。后來世界時先后被歷書時和原子時所取代,但在日常生活、天文導(dǎo)航、大地測量和宇宙飛行等方面仍屬必需;同時,世界時反映地球自轉(zhuǎn)速率的變化,是地球自轉(zhuǎn)參數(shù)之一,仍為天文學(xué)和地球物理學(xué)的基本資料。
5.部分時間格式化
某些場景下,我們不需要對全局的時間都進(jìn)行統(tǒng)一的處理,這種情況我們可以使用注解的方式來實(shí)現(xiàn)部分時間字段的格式化。
我們需要在實(shí)體類 UserInfo 中添加 @JsonFormat 注解,這樣就可以實(shí)現(xiàn)時間的格式化功能了,實(shí)現(xiàn)代碼如下:
import com.fasterxml.jackson.annotation.JsonFormat; import lombok.Data; import java.util.Date; @Data publicclass UserInfo { privateint id; private String username; // 對 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í)現(xiàn)原理和第 4 種時間格式化的實(shí)現(xiàn)原理類似,都是在返回數(shù)據(jù)之前,對相應(yīng)的字段進(jìn)行時間格式化的處理。
總結(jié)
本文我們介紹了 5 種時間格式化的實(shí)現(xiàn)方法,其中第 1 種為前端時間格式化的方法,后 4 種為后端格式化的方法,SimpleDateFormat 和 DateTimeFormatter 格式化的方法更適用普通的 Java 項(xiàng)目,其中 SimpleDateFormat 是非線程安全的,而 DateTimeFormatter 是線程安全的,但它們都不是 Spring Boot 項(xiàng)目中最優(yōu)的時間格式化方案。
如果是 Spring Boot 的項(xiàng)目,推薦使用第 4 種全局時間格式化或第 5 種局部時間格式化的方式,這兩種實(shí)現(xiàn)方式都無需修改核心業(yè)務(wù)代碼,只需要簡單的配置一下,就可以完成時間的格式化功能了。
到此這篇關(guān)于SpringBoot中時間格式化的五種方法的文章就介紹到這了,更多相關(guān)SpringBoot時間格式化內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
參考 & 鳴謝
http://www.dbjr.com.cn/article/218191.htm
baike.baidu.com/item/世界時/692237
相關(guān)文章
Java內(nèi)存模型之happens-before概念詳解
happens-before原則非常重要,它是判斷數(shù)據(jù)是否存在競爭、線程是否安全的主要依據(jù),依靠這個原則,我們解決在并發(fā)環(huán)境下兩操作之間是否可能存在沖突的所有問題。下面我們就一個簡單的例子稍微了解下happens-before知識,感興趣的朋友一起看看吧2021-06-06SpringBoot實(shí)現(xiàn)接口等冪次校驗(yàn)的示例代碼
本文主要介紹了SpringBoot實(shí)現(xiàn)接口等冪次校驗(yàn)的示例代碼,文中通過示例代碼介紹的非常詳細(xì),具有一定的參考價值,感興趣的小伙伴們可以參考一下2022-01-01Java數(shù)據(jù)結(jié)構(gòu)之簡單鏈表的定義與實(shí)現(xiàn)方法示例
這篇文章主要介紹了Java數(shù)據(jù)結(jié)構(gòu)之簡單鏈表的定義與實(shí)現(xiàn)方法,簡單描述了鏈接的概念、原理,并結(jié)合實(shí)例形式分析了java定義與使用鏈表的相關(guān)步驟與操作技巧,需要的朋友可以參考下2017-10-10springmvc+mybatis 做分頁sql 語句實(shí)例代碼
本文通過一段實(shí)例代碼給大家介紹了springmvc+mybatis 做分頁sql 語句的方法,代碼簡單易懂,非常不錯,具有參考借鑒價值,需要的朋友參考下吧2017-07-07Java中增強(qiáng)for循環(huán)在一維數(shù)組和二維數(shù)組中的使用方法
下面小編就為大家?guī)硪黄狫ava中增強(qiáng)for循環(huán)在一維數(shù)組和二維數(shù)組中的使用方法。小編覺得挺不錯的,現(xiàn)在就分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2016-10-10