Springboot 全局時間格式化操作
更新時間：2021年06月08日 10:14:54 作者：陳晨辰~
這篇文章主要介紹了Springboot 全局時間格式化操作，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
時間格式化在項目中使用頻率是非常高的，當我們的 API 接口返回結果，需要對其中某一個 date 字段屬性進行特殊的格式化處理，通常會用到 SimpleDateFormat 工具處理。
SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
Date stationTime = dateFormat.parse(dateFormat.format(PayEndTime()));
可一旦處理的地方較多，不僅 CV 操作頻繁，還產(chǎn)生很多重復臃腫的代碼，而此時如果能將時間格式統(tǒng)一配置，就可以省下更多時間專注于業(yè)務開發(fā)了。
可能很多人覺得統(tǒng)一格式化時間很簡單啊，像下邊這樣配置一下就行了，但事實上這種方式只對 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 時間格式化成功。
二、@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
*/
@Bean
public 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
*/
@Bean
public LocalDateTimeSerializer localDateTimeDeserializer() {
return new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(pattern));
}
@Bean
public Jackson2ObjectMapperBuilderCustomizer jackson2ObjectMapperBuilderCustomizer() {
return builder -> builder.serializerByType(LocalDateTime.class, localDateTimeDeserializer());
}
}
看到 Date 和 LocalDate 兩種時間類型格式化成功，此種方式有效。
@JsonComponent 注解處理格式化
但還有個問題，實際開發(fā)中如果我有個字段不想用全局格式化設置的時間樣式，想自定義格式怎么辦？
那就需要和 @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 注解的優(yōu)先級比較高，會以 @JsonFormat 注解的時間格式為主。
三、@Configuration 注解
這種全局配置的實現(xiàn)方式與上邊的效果是一樣的。
注意：在使用此種配置后，字段手動配置@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
@Primary
public 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
*/
@Component
public class DateSerializer extends JsonSerializer<Date> {
@Override
public 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
*/
@Component
public class DateDeserializer extends JsonDeserializer<Date> {
@Override
public 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> {
@Override
public 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> {
@Override
public LocalDateTime deserialize(JsonParser p, DeserializationContext deserializationContext) throws IOException {
return LocalDateTime.parse(p.getValueAsString(), DateTimeFormatter.ofPattern(pattern));
}
}
}
SpringBoot全局日期格式轉換失效問題記錄
今天新搭建了一個項目, 像以前一樣在一個配置類上做了個全局字符串轉換日期對象的轉換器!
@Bean
public Jackson2ObjectMapperBuilderCustomizer jackson2ObjectMapperBuilderCustomizer() {
return builder -> {
.............
};
}
}
//-----------------
//或者使用官網(wǎng)提供的 通過注解`@JsonComponent`來聲明其靜態(tài)內(nèi)部類,都沒生效!
但是發(fā)現(xiàn)失效了, 在debug模式下根本沒有進來,沒有任何反應! 后面發(fā)現(xiàn)原因在繼承了WebMvcConfigurationSupport配置類,導致自動配置失效！
在網(wǎng)上找到的原因, 如下圖所示：
自動配置在當WebMvcConfigurationSupport類不存在的時候才會生效WebMvc自動化配置，WebMvc自動配置類中不僅定義了classpath:/META-INF/resources/，classpath:/resources/，classpath:/static/，classpath:/public/等路徑的映射，還定義了配置文件spring.mvc開頭的配置信息等。
類路徑上的 HttpMessageConverter 失效
解決方案
是在自己繼承了WebMvcConfigurationSupport上配置轉換器：
@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {
/**
* 解決繼承WebMvcConfigurationSupport,靜態(tài)資源訪問不到
*
* @param registry
* @author: ZhiHao
* @date: 2020/6/11
*/
@Override
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");
super.addResourceHandlers(registry);
}
/**
* 解決繼承WebMvcConfigurationSupport, json方式全局日期反序列化失效
*
* @param converters
* @author: ZhiHao
* @date: 2020/6/11
*/
@Override
protected void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
ObjectMapper objectMapper = new ObjectMapper();
SimpleModule module = new SimpleModule();
module.addDeserializer(Date.class, new JsonDeserializer<Date>() {
@Override
public Date deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException {
return DateConverterConfig.parse(jsonParser.getText());
}
});
objectMapper.registerModule(module);
converter.setObjectMapper(objectMapper);
converters.add(converter);
super.configureMessageConverters(converters);
}
/**
* 解決繼承WebMvcConfigurationSupport, 普通請求,String轉換Date-轉換器
*
* @param registry
* @author: ZhiHao
* @date: 2020/6/11
*/
@Override
protected void addFormatters(FormatterRegistry registry) {
registry.addConverter(new DateConverterConfig());
}
}
以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關文章
這篇文章主要介紹了Springboot熱部署實現(xiàn)原理及實例詳解,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-05-05
在本篇內(nèi)容里小編給大家分享的是一篇關于Java控制臺輸入scanner的方法及實例代碼，有需要的朋友們可以參考下。2022-11-11
這篇文章主要介紹了Java-性能分析和監(jiān)控工具深入詳解，文章內(nèi)容詳細，簡單易懂，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2023-01-01
在實際開發(fā)中不僅僅是要展示數(shù)據(jù)，還要構成數(shù)據(jù)模型添加數(shù)據(jù)，這篇文章主要介紹了SpringBoot集成Mybatis操作數(shù)據(jù)庫，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2022-08-08
設計模式（Design pattern）代表了最佳的實踐，通常被有經(jīng)驗的面向對象的軟件開發(fā)人員所采用。設計模式是軟件開發(fā)人員在軟件開發(fā)過程中面臨的一般問題的解決方案。本篇介紹設計模式七大原則之一的依賴倒轉原則2022-02-02
這篇文章主要介紹了Java多線程之條件對象Condition，Condition中的await()方法相當于Object的wait()方法，Condition中的signal()方法相當于Object的notify()方法，Condition中的signalAll()相當于Object的notifyAll()方法，接下來和小編一起進入文章了解更具體的內(nèi)容2021-10-10
Java 在Excel單元格中應用一種/多種字體樣式(實例代碼)
這篇文章主要介紹了Java 在Excel單元格中應用一種/多種字體樣式,本文通過實例代碼給大家介紹的非常詳細，具有一定的參考借鑒價值，需要的朋友可以參考下2019-12-12
這篇文章主要介紹了Idea中Springboot熱部署無效問題解決,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2019-11-11
這篇文章主要介紹了Java編程中復合語句，結合相關的具體實例介紹了其用法,需要的朋友可以參考下2017-09-09
簡單講解Android開發(fā)中觸摸和點擊事件的相關編程方法
這篇文章主要介紹了Android開發(fā)中觸摸和點擊事件的相關編程方法,包括事件偵聽器等安卓開發(fā)中常用的接口的基本使用方法,需要的朋友可以參考下2015-12-12