Springboot配置返回日期格式化五種方法詳解
應急就這樣
格式化全局時間字段
在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
## 定時區(qū),解決8小時的時間差問題
time-zone: GMT+8
OK了,你后端全統(tǒng)一了,應急的同志們就這樣就行了,不用學下面的擴展知識,想學習的可以先收藏(建議別收藏,收藏了也不看,要不一口氣看完點個贊,要不別收藏來欺騙自己了)
系統(tǒng)的知識
1.前端時間格式化(不做無情人)
前端工程時間格式化方法,實現(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ù)添加,必須轉化成字符串
};
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 之前重要的時間格式化方法,它的核心實現(xiàn)代碼如下:
// 定義時間格式化對象和定義格式化樣式
SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
// 格式化時間對象
String date = dateFormat.format(new Date())
接下來我們使用 SimpleDateFormat 來實現(xiàn)一下本項目中的時間格式化,它的實現(xiàn)代碼如下:
@RequestMapping("/list")
public List<User> getList() {
// 定義時間格式化對象
SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
List<User> list = userMapper.getList();
// 循環(huán)執(zhí)行時間格式化
list.forEach(item -> {
// 使用預留字段 ctime 接收 createtime 格式化的時間(Date->String)
item.setCtime(dateFormat.format(item.getCreatetime()));
item.setUtime(dateFormat.format(item.getUpdatetime()));
});
return list;
}
但是這樣會產(chǎn)生新的問題,為什么接口的返回字段咋變了呢,之前的字段是 createtime 現(xiàn)在卻是 ctime。
這是因為使用 SimpleDateFormat.format 方法之后,它返回的是一個 String 類型的結果,而我們之前的 createtime 和 updatetime 字段都是 Date 類型的,因此它們是不能接收時間格式化得結果的。
3.DateTimeFormatter格式化(不推薦)
JDK 8 之后,我們可以使用 DateTimeFormatter 來替代 SimpleDateFormat,因為 SimpleDateFormat 是非線程安全的,而 DateTimeFormatter 是線程安全的,所以如果是 JDK 8 以上的項目,盡量使用 DateTimeFormatter 來進行時間格式化。
DateTimeFormatter 格式化的代碼和 SimpleDateFormat 類似,具體實現(xiàn)如下:
@RequestMapping("/list")
public List<User> getList() {
// 定義時間格式化對象
DateTimeFormatter dateFormat = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
List<User> list = userMapper.getList();
// 循環(huán)執(zhí)行時間格式化
list.forEach(item -> {
// 使用預留字段 ctime 接收 createtime 格式化的時間(Date->String)
item.setCtime(dateFormat.format(item.getCreatetime()));
item.setUtime(dateFormat.format(item.getUpdatetime()));
});
return list;
}
DateTimeFormatter 和 SimpleDateFormat 在使用上的區(qū)別是 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.全局時間格式化(推薦)
以上兩種后端格式化的實現(xiàn)都有一個致命的缺點,它們在進行時間格式化的時候,都需要對核心業(yè)務類做一定的修改,這就相當為了解決一個問題,又引入了一個新的問題,那有沒有簡單一點、優(yōu)雅一點的解決方案呢?
答案是:有的。我們可以不改任何代碼,只需要在配置文件中設置一下就可以實現(xiàn)時間格式化的功能了。
首先,我們找到 Spring Boot 的配置文件 application.properties(或 application.yml),只需要在 application.properties 配置文件中添加以下兩行配置:
格式化全局時間字段
在yml中添加如下配置:
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
指定時間區(qū)域類型
在yml中添加:
spring.jackson.time-zone=GMT+8
或者下面的格式
spring:
jackson:
## 格式為yyyy-MM-dd HH:mm:ss
date-format: yyyy-MM-dd HH:mm:ss
## 定時區(qū),解決8小時的時間差問題
time-zone: GMT+8
這樣設置之后,我們將原始的 User 和 UserController 進行還原。
User 實現(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 實現(xiàn)代碼:
@RequestMapping("/list")
public List<User> getList() {
return userMapper.getList();
}
然后我們運行程序,看到的執(zhí)行結果如下:
從以上結果和代碼可以看出,我們只需要在程序中簡單配置一下,就可以實現(xiàn)所有時間字段的格式化了。
實現(xiàn)原理分析
為什么在配置文件中設置一下,就可以實現(xiàn)所有時間字段的格式化了呢?
# 格式化全局時間字段 spring.jackson.date-format=yyyy-MM-dd HH:mm:ss # 指定時間區(qū)域類型 spring.jackson.time-zone=GMT+8
這是因為 Controller 在返回數(shù)據(jù)時,會自動調用 Spring Boot 框架中內置的 JSON 框架 Jackson,對返回的數(shù)據(jù)進行統(tǒng)一的 JSON 格式化處理,在處理的過程中它會判斷配置文件中是否設置了“spring.jackson.date-format=yyyy-MM-dd HH:mm:ss”,如果設置了,那么 Jackson 框架在對時間類型的字段輸出時就會執(zhí)行時間格式化的處理,這樣我們就通過配置來實現(xiàn)全局時間字段的格式化功能了。
為什么要指定時間區(qū)域類型“spring.jackson.time-zone=GMT+8”呢?
最現(xiàn)實的原因是,如果我們不指定時間區(qū)域類型,那么查詢出來的時間就會比預期的時間少 8 個小時,這因為我們(中國)所處的時間區(qū)域比世界時間少 8 個小時導致的,而當我們設置了時區(qū)之后,我們的時間查詢才會和預期時間保持一致。
GMT 是什么?時間區(qū)域設置中的“GMT” 是什么意思?
Greenwich Mean Time (GMT) 格林尼治時間,也叫做世界時間。
(下面是格林尼治時間的百度百科,想了解的可以看一下,不想了解的知道是世界時間就行,其他的就是的臀部——規(guī)定)
格林尼治時間:格林尼治是英國倫敦南郊原皇家格林尼治天文臺所在地,地球本初子午線的標界處,世界計算時間和經(jīng)度的起點。以其海事歷史、作為本初子午線的標準點、以及格林尼治時間以其命名而聞名于世。這里地勢險要,風景秀麗,兼具歷史和地方風情,也是倫敦在泰晤士河的東方門戶。
不光是天文學家使用格林尼治時間,就是在新聞報刊上也經(jīng)常出現(xiàn)這個名詞。我們知道各地都有各地的地方時間。如果對國際上某一重大事情,用地方時間來記錄,就會感到復雜不便.而且將來日子一長容易搞錯。因此,天文學家就提出一個大家都能接受且又方便的記錄方法,那就是以格林尼治的地方時間為標準。
以本初子午線的平子夜起算的平太陽時。又稱格林尼治平時或格林尼治時間。各地的地方平時與世界時之差等于該地的地理經(jīng)度。1960年以前曾作為基本時間計量系統(tǒng)被廣泛應用。由于地球自轉速率曾被認為是均勻的,因此在1960年以前,世界時被認為是一種均勻時。由于地球自轉速度變化的影響,它不是一種均勻的時間系統(tǒng),它與原子時或力學時都沒有任何理論上的關系,只有通過觀測才能對它們進行比較。后來世界時先后被歷書時和原子時所取代,但在日常生活、天文導航、大地測量和宇宙飛行等方面仍屬必需;同時,世界時反映地球自轉速率的變化,是地球自轉參數(shù)之一,仍為天文學和地球物理學的基本資料。
5.部分時間格式化(推薦)
某些場景下,我們不需要對全局的時間都進行統(tǒng)一的處理,這種情況我們可以使用注解的方式來實現(xiàn)部分時間字段的格式化。
例如需要在實體類 User 中添加 @JsonFormat 注解,這樣就可以實現(xiàn)時間的格式化功能了,實現(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;
? ? // 對 createtime 字段進行格式化處理
? ? @JsonFormat(pattern = "yyyy-MM-dd hh:mm:ss", timezone = "GMT+8")
? ? private Date createtime;
? ? private Date updatetime;
}修改完代碼之后,我們運行項目就可以顯示格式化后的時間了
總結
Spring Boot 的項目,推薦使用第 4 種全局時間格式化或第 5 種局部時間格式化的方式,這兩種實現(xiàn)方式都無需修改核心業(yè)務代碼,只需要簡單的配置一下,就可以完成時間的格式化功能了。
到此這篇關于Springboot配置返回日期格式化五種方法詳解的文章就介紹到這了,更多相關Springboot 返回日期格式化內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
SpringBoot3?Web編程開發(fā)的工程搭建攔截器及測試工具示例
這篇文章主要介紹了SpringBoot3?Web編程開發(fā)的工程搭建攔截器及測試工具示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-08-08
SpringMVC獲取請求參數(shù)實現(xiàn)方法介紹
Spring MVC 是 Spring 提供的一個基于 MVC 設計模式的輕量級 Web 開發(fā)框架,本質上相當于 Servlet,Spring MVC 角色劃分清晰,分工明細,這篇文章主要介紹了SpringMVC實現(xiàn)獲取請求參數(shù)方法2022-11-11
@Bean注解和@Configuration、@Component注解組合使用的區(qū)別
這篇文章主要介紹了@Bean注解和@Configuration、@Component注解組合使用的區(qū)別,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-11-11

