springboot日期格式化全局LocalDateTime詳解
springboot 默認(rèn)使用ObjectMapper
(jackson)操作對(duì)象的序列化和反序列化
分析
從springboot:3.2.1 web 項(xiàng)目序列化響應(yīng)體的過程中分析日期格式化問題(左側(cè)是請(qǐng)求處理流程,右側(cè)是在流程中使用的一些對(duì)象的來源)
ObjectMapper與JsonSerializer
根據(jù)上述流程可知,序列化響應(yīng)結(jié)果時(shí)使用的ObjectMapper
對(duì)象是由自動(dòng)配置類JacksonAutoConfiguratioin.JacksonObjectMapperConfiguration
使用Jackson2ObjectMapperBuilder
創(chuàng)建,并注冊(cè)到beanfactory
中。
創(chuàng)建ObjectMapper對(duì)象
設(shè)置ObjectMapper對(duì)象的屬性
在Jackson2ObjectMapperBuilder#build
方法中創(chuàng)建了ObjectMapper
對(duì)象,然后在Jackson2ObjectMapperBuilder#configure
方法中對(duì)ObjectMapper
對(duì)象設(shè)置了一些屬性。
例如創(chuàng)建JavaTimeModule
對(duì)象并將其注冊(cè)給ObjectMapper
, 正是在JavaTimeModule
的構(gòu)造方法中指定了LocalDateTime
的序列化器使用com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer
,并將這種關(guān)系使用ObjectMapper#registerModules
注冊(cè)給ObjectMapper
對(duì)象
在以下方法中創(chuàng)建了com.fasterxml.jackson.datatype.jsr310.JavaTimeModule
對(duì)象
private void registerWellKnownModulesIfAvailable(MultiValueMap<Object, Module> modulesToRegister) { // ... try { Class<? extends Module> javaTimeModuleClass = (Class<? extends Module>) ClassUtils.forName("com.fasterxml.jackson.datatype.jsr310.JavaTimeModule", this.moduleClassLoader); Module javaTimeModule = BeanUtils.instantiateClass(javaTimeModuleClass); modulesToRegister.set(javaTimeModule.getTypeId(), javaTimeModule); } catch (ClassNotFoundException ex) { // jackson-datatype-jsr310 not available } // ... }
在JavaTimeModule類的構(gòu)造函數(shù)中設(shè)置了LocalDateTime
類型和該類型使用的序列化器LocalDateTimeSerializer
和反序列化器LocalDateTimeDeserializer
的對(duì)應(yīng)關(guān)系
結(jié)論
springboot項(xiàng)目中,使用從beanfactory中獲取的ObjectMapper
序列化對(duì)象時(shí),若對(duì)象的字段類型是LocalDateTime
,則使用com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer
對(duì)字段進(jìn)行序列化,但是其默認(rèn)的日期格式并不是我們想要的。
因此需要干涉上述流程,使用自定義的日期時(shí)間格式
自定義日期格式(全局)
1.直接操作spring容器中的ObjectMapper
bean
利用ObjectMapper#registerModule
2.自定義容器中的Jackson2ObjectMapperBuilder
bean,達(dá)到間接操作ObjectMapper的目的
從流程圖中可知,容器中的ObjectMapper
對(duì)象由Jackson2ObjectMapperBuilder
創(chuàng)建(創(chuàng)建者模式),因此自定義Jackson2ObjectMapperBuilder
的屬性,會(huì)間接作用到ObjectMapper
的屬性
根據(jù)JacksonAutoConfiguration.JacksonObjectMapperBuilderConfiguration
源碼可知,創(chuàng)建一個(gè)Jackson2ObjectMapperBuilderCustomizer
實(shí)現(xiàn)類,并將其注入到容器中,可對(duì)容器中的Jackson2ObjectMapperBuilder
bean進(jìn)行自定義配置
按照上述思路實(shí)現(xiàn)如下(真實(shí)工作中需考慮多個(gè)customizer的順序)
也可以使用modulesToInstall方法
3.向容器中注入com.fasterxml.jackson.databind.Module
的實(shí)現(xiàn)類
這是因?yàn)閟pringboot自動(dòng)配置包中已經(jīng)提供了一個(gè)Jackson2ObjectMapperBuilderCustomizer
實(shí)現(xiàn)類,在創(chuàng)建該實(shí)現(xiàn)類對(duì)象時(shí),它將從容器中獲取的com.fasterxml.jackson.databind.Module
bean用于自定義配置Jackson2ObjectMapperBuilder
同時(shí),可以看到StandardJackson2ObjectMapperBuilderCustomizer
類使用了JacksonProperties
的配置,也就說可以在配置文件中做些定義的配置
擴(kuò)展
利用配置文件指定java.util.Date類型的格式化
spring: jackson: date-format: yyyy-MM-dd HH:mm:ss time-zone: GMT+8
這種方式對(duì)java.time.LocalDateTime
類型無效
利用注解指定時(shí)間格式化(局部)
@JsonFormat
,對(duì)java.util.Date
和java.time.LocalDateTime
都有效
@JsonSerialize
、@JsonDeserialize
,指定使用的序列化器@DateTimeFormat
@JsonComponent
總結(jié)
以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
相關(guān)文章
mybatis?like模糊查詢特殊字符報(bào)錯(cuò)轉(zhuǎn)義處理方式
這篇文章主要介紹了mybatis?like模糊查詢特殊字符報(bào)錯(cuò)轉(zhuǎn)義處理方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-01-01Spring Boot2.0整合ES5實(shí)現(xiàn)文章內(nèi)容搜索實(shí)戰(zhàn)
這篇文章主要介紹了Spring Boot2.0整合ES5實(shí)現(xiàn)文章內(nèi)容搜索實(shí)戰(zhàn),小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2018-01-01一文詳解SpringMVC中的@RequestMapping注解
@RequestMapping是一個(gè)用于映射HTTP請(qǐng)求到處理方法的注解,在Spring框架中使用,它可以用于控制器類和處理方法上,用來指定處理不同URL路徑的請(qǐng)求,并定義請(qǐng)求的方法等,本文小編將給大家詳細(xì)的介紹一下SpringMVC中的@RequestMapping注解,需要的朋友可以參考下2023-08-08Java開發(fā)或調(diào)用WebService的幾種方式總結(jié)
java開發(fā)過程中,很多地方都會(huì)遇到數(shù)據(jù)傳遞,遠(yuǎn)程獲取數(shù)據(jù)問題,這篇文章主要介紹了Java開發(fā)或調(diào)用WebService的幾種方式的相關(guān)資料,文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下2024-06-06詳解SpringBoot?調(diào)用外部接口的三種方式
SpringBoot不僅繼承了Spring框架原有的優(yōu)秀特性,而且還通過簡化配置來進(jìn)一步簡化了Spring應(yīng)用的整個(gè)搭建和開發(fā)過程,這篇文章主要介紹了SpringBoot?調(diào)用外部接口的三種方式,需要的朋友可以參考下2023-04-04SpringBoot文件上傳同時(shí)接收復(fù)雜參數(shù)的過程詳解
這篇文章主要介紹了SpringBoot文件上傳同時(shí),接收復(fù)雜參數(shù),本文通過示例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-12-12SpringBoot如何進(jìn)行業(yè)務(wù)校驗(yàn)實(shí)例詳解
這篇文章主要給大家介紹了關(guān)于SpringBoot如何進(jìn)行業(yè)務(wù)校驗(yàn)的相關(guān)資料,文中通過實(shí)例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2022-01-01詳解如何實(shí)現(xiàn)OpenAPI開發(fā)動(dòng)態(tài)處理接口的返回?cái)?shù)據(jù)
這篇文章主要為大家介紹了OpenAPI開發(fā)動(dòng)態(tài)處理接口的返回?cái)?shù)據(jù)如何實(shí)現(xiàn)詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-04-04Java中main函數(shù)的String[]?args用法舉例詳解
這篇文章主要給大家介紹了關(guān)于Java中main函數(shù)的String[]?args用法的相關(guān)資料,JAVA類中main函數(shù)的參數(shù)String[]?args指的是運(yùn)行時(shí)給main函數(shù)傳遞的參數(shù),文中通過圖文以及代碼介紹的非常詳細(xì),需要的朋友可以參考下2023-12-12