時間格式化在項目中使用頻率是非常高的，當我們的 API 接口返回結果，需要對其中某一個 date 字段屬性進行特殊的格式化處理，通常會用到 SimpleDateFormat 工具處理。

SimpleDateFormat?dateFormat?=?new?SimpleDateFormat("yyyy-MM-dd"); Date?stationTime?=?dateFormat.parse(dateFormat.format(PayEndTime()));

可一旦處理的地方較多，不僅 CV 操作頻繁，還產生很多重復臃腫的代碼，而此時如果能將時間格式統一配置，就可以省下更多時間專注于業務開發了。

可能很多人覺得統一格式化時間很簡單啊，像下邊這樣配置一下就行了，但事實上這種方式只對 date 類型生效。

spring.jackson.date-format=yyyy-MM-dd?HH:mm:ss spring.jackson.time-zone=GMT+8

而很多項目中用到的時間和日期API 比較混亂， java.util.Date 、 java.util.Calendar 和 java.time LocalDateTime 都存在，所以全局時間格式化必須要同時兼容性新舊 API。

---

看看配置全局時間格式化前，接口返回時間字段的格式。

@Data public?class?OrderDTO?{private?LocalDateTime?createTime;private?Date?updateTime; }

很明顯不符合頁面上的顯示要求（有人抬杠為啥不讓前端解析時間，我只能說睡服代碼比說服人容易得多~）

未做任何配置的結果

一、@JsonFormat 注解

@JsonFormat 注解方式嚴格意義上不能叫全局時間格式化，應該叫部分格式化，因為@JsonFormat 注解需要用在實體類的時間字段上，而只有使用相應的實體類，對應的字段才能進行格式化。

@Data public?class?OrderDTO?{@JsonFormat(locale?=?"zh",?timezone?=?"GMT+8",?pattern?=?"yyyy-MM-dd")private?LocalDateTime?createTime;@JsonFormat(locale?=?"zh",?timezone?=?"GMT+8",?pattern?=?"yyyy-MM-dd?HH:mm:ss")private?Date?updateTime; }

字段加上 @JsonFormat 注解后，LocalDateTime 和 Date 時間格式化成功。

@JsonFormat 注解格式化

二、@JsonComponent 注解（推薦）

這是我個人比較推薦的一種方式，前邊看到使用 @JsonFormat 注解并不能完全做到全局時間格式化，所以接下來我們使用 @JsonComponent 注解自定義一個全局格式化類，分別對 Date 和 LocalDate 類型做格式化處理。

@JsonComponent public?class?DateFormatConfig?{@Value("${spring.jackson.date-format:yyyy-MM-dd?HH:mm:ss}")private?String?pattern;/***?@author?xiaofu*?@description?date?類型全局時間格式化*?@date?2020/8/31?18:22*/@Beanpublic?Jackson2ObjectMapperBuilderCustomizer?jackson2ObjectMapperBuilder()?{return?builder?->?{TimeZone?tz?=?TimeZone.getTimeZone("UTC");DateFormat?df?=?new?SimpleDateFormat(pattern);df.setTimeZone(tz);builder.failOnEmptyBeans(false).failOnUnknownProperties(false).featuresToDisable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS).dateFormat(df);};}/***?@author?xiaofu*?@description?LocalDate?類型全局時間格式化*?@date?2020/8/31?18:22*/@Beanpublic?LocalDateTimeSerializer?localDateTimeDeserializer()?{return?new?LocalDateTimeSerializer(DateTimeFormatter.ofPattern(pattern));}@Beanpublic?Jackson2ObjectMapperBuilderCustomizer?jackson2ObjectMapperBuilderCustomizer()?{return?builder?->?builder.serializerByType(LocalDateTime.class,?localDateTimeDeserializer());} }

看到 Date 和 LocalDate 兩種時間類型格式化成功，此種方式有效。

@JsonComponent 注解處理格式化

但還有個問題，實際開發中如果我有個字段不想用全局格式化設置的時間樣式，想自定義格式怎么辦？

那就需要和 @JsonFormat 注解配合使用了。

@Data public?class?OrderDTO?{@JsonFormat(locale?=?"zh",?timezone?=?"GMT+8",?pattern?=?"yyyy-MM-dd")private?LocalDateTime?createTime;@JsonFormat(locale?=?"zh",?timezone?=?"GMT+8",?pattern?=?"yyyy-MM-dd")private?Date?updateTime; }

從結果上我們看到 @JsonFormat 注解的優先級比較高，會以 @JsonFormat 注解的時間格式為主。

三、@Configuration 注解

這種全局配置的實現方式與上邊的效果是一樣的。

“

注意：在使用此種配置后，字段手動配置@JsonFormat 注解將不再生效。

” @Configuration public?class?DateFormatConfig2?{@Value("${spring.jackson.date-format:yyyy-MM-dd?HH:mm:ss}")private?String?pattern;public?static?DateFormat?dateFormat?=?new?SimpleDateFormat("yyyy-MM-dd?HH:mm:ss");@Bean@Primarypublic?ObjectMapper?serializingObjectMapper()?{ObjectMapper?objectMapper?=?new?ObjectMapper();JavaTimeModule?javaTimeModule?=?new?JavaTimeModule();javaTimeModule.addSerializer(LocalDateTime.class,?new?LocalDateTimeSerializer());javaTimeModule.addDeserializer(LocalDateTime.class,?new?LocalDateTimeDeserializer());objectMapper.registerModule(javaTimeModule);return?objectMapper;}/***?@author?xiaofu*?@description?Date?時間類型裝換*?@date?2020/9/1?17:25*/@Componentpublic?class?DateSerializer?extends?JsonSerializer<Date>?{@Overridepublic?void?serialize(Date?date,?JsonGenerator?gen,?SerializerProvider?provider)?throws?IOException?{String?formattedDate?=?dateFormat.format(date);gen.writeString(formattedDate);}}/***?@author?xiaofu*?@description?Date?時間類型裝換*?@date?2020/9/1?17:25*/@Componentpublic?class?DateDeserializer?extends?JsonDeserializer<Date>?{@Overridepublic?Date?deserialize(JsonParser?jsonParser,?DeserializationContext?deserializationContext)?throws?IOException?{try?{return?dateFormat.parse(jsonParser.getValueAsString());}?catch?(ParseException?e)?{throw?new?RuntimeException("Could?not?parse?date",?e);}}}/***?@author?xiaofu*?@description?LocalDate?時間類型裝換*?@date?2020/9/1?17:25*/public?class?LocalDateTimeSerializer?extends?JsonSerializer<LocalDateTime>?{@Overridepublic?void?serialize(LocalDateTime?value,?JsonGenerator?gen,?SerializerProvider?serializers)?throws?IOException?{gen.writeString(value.format(DateTimeFormatter.ofPattern(pattern)));}}/***?@author?xiaofu*?@description?LocalDate?時間類型裝換*?@date?2020/9/1?17:25*/public?class?LocalDateTimeDeserializer?extends?JsonDeserializer<LocalDateTime>?{@Overridepublic?LocalDateTime?deserialize(JsonParser?p,?DeserializationContext?deserializationContext)?throws?IOException?{return?LocalDateTime.parse(p.getValueAsString(),?DateTimeFormatter.ofPattern(pattern));}} }

總結

分享了一個簡單卻又很實用的 Springboot 開發技巧，其實所謂的開發效率，不過是一個又一個開發技巧堆砌而來，聰明的程序員總是能用最少的代碼完成任務。

往期推薦

定時任務最簡單的3種實現方法（超好用）

2020-08-18

List 集合去重的 3 種方法

2020-08-17

4種分布式Session的實現方式！老大直呼666...

2020-07-23

總結

以上是生活随笔為你收集整理的3种时间格式化的方法，SpringBoot篇！的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。