這期內(nèi)容當(dāng)中小編將會(huì)給大家?guī)?lái)有關(guān)Springboot 中怎么格式化全局時(shí)間,文章內(nèi)容豐富且以專業(yè)的角度為大家分析和敘述,閱讀完這篇文章希望大家可以有所收獲。
10余年的墊江網(wǎng)站建設(shè)經(jīng)驗(yàn),針對(duì)設(shè)計(jì)、前端、開發(fā)、售后、文案、推廣等六對(duì)一服務(wù),響應(yīng)快,48小時(shí)及時(shí)工作處理。營(yíng)銷型網(wǎng)站建設(shè)的優(yōu)勢(shì)是能夠根據(jù)用戶設(shè)備顯示端的尺寸不同,自動(dòng)調(diào)整墊江建站的顯示方式,使網(wǎng)站能夠適用不同顯示終端,在瀏覽器中調(diào)整網(wǎng)站的寬度,無(wú)論在任何一種瀏覽器上瀏覽網(wǎng)站,都能展現(xiàn)優(yōu)雅布局與設(shè)計(jì),從而大程度地提升瀏覽體驗(yàn)。成都創(chuàng)新互聯(lián)從事“墊江網(wǎng)站設(shè)計(jì)”,“墊江網(wǎng)站推廣”以來(lái),每個(gè)客戶項(xiàng)目都認(rèn)真落實(shí)執(zhí)行。
時(shí)間格式化在項(xiàng)目中使用頻率是非常高的,當(dāng)我們的 API 接口返回結(jié)果,需要對(duì)其中某一個(gè) date 字段屬性進(jìn)行特殊的格式化處理,通常會(huì)用到 SimpleDateFormat 工具處理。
SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd"); Date stationTime = dateFormat.parse(dateFormat.format(PayEndTime()));
可一旦處理的地方較多,不僅 CV 操作頻繁,還產(chǎn)生很多重復(fù)臃腫的代碼,而此時(shí)如果能將時(shí)間格式統(tǒng)一配置,就可以省下更多時(shí)間專注于業(yè)務(wù)開發(fā)了。
可能很多人覺(jué)得統(tǒng)一格式化時(shí)間很簡(jiǎn)單啊,像下邊這樣配置一下就行了,但事實(shí)上這種方式只對(duì) date 類型生效。
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss spring.jackson.time-zone=GMT+8
而很多項(xiàng)目中用到的時(shí)間和日期API 比較混亂, java.util.Date 、 java.util.Calendar 和 java.time LocalDateTime 都存在,所以全局時(shí)間格式化必須要同時(shí)兼容性新舊 API。
看看配置全局時(shí)間格式化前,接口返回時(shí)間字段的格式。
@Data public class OrderDTO { private LocalDateTime createTime; private Date updateTime; }
很明顯不符合頁(yè)面上的顯示要求(有人抬杠為啥不讓前端解析時(shí)間,我只能說(shuō)睡服代碼比說(shuō)服人容易得多~)
未做任何配置的結(jié)果
一、@JsonFormat 注解
@JsonFormat 注解方式嚴(yán)格意義上不能叫全局時(shí)間格式化,應(yīng)該叫部分格式化,因?yàn)锧JsonFormat 注解需要用在實(shí)體類的時(shí)間字段上,而只有使用相應(yīng)的實(shí)體類,對(duì)應(yīng)的字段才能進(jìn)行格式化。
@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 時(shí)間格式化成功。
@JsonFormat 注解格式化
二、@JsonComponent 注解(推薦)
這是我個(gè)人比較推薦的一種方式,前邊看到使用 @JsonFormat 注解并不能完全做到全局時(shí)間格式化,所以接下來(lái)我們使用 @JsonComponent 注解自定義一個(gè)全局格式化類,分別對(duì) Date 和 LocalDate 類型做格式化處理。
@JsonComponent public class DateFormatConfig { @Value("${spring.jackson.date-format:yyyy-MM-dd HH:mm:ss}") private String pattern; /** * @author xiaofu * @description date 類型全局時(shí)間格式化 * @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 類型全局時(shí)間格式化 * @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 兩種時(shí)間類型格式化成功,此種方式有效。
@JsonComponent 注解處理格式化
但還有個(gè)問(wèn)題,實(shí)際開發(fā)中如果我有個(gè)字段不想用全局格式化設(shè)置的時(shí)間樣式,想自定義格式怎么辦?
那就需要和 @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; }
從結(jié)果上我們看到 @JsonFormat 注解的優(yōu)先級(jí)比較高,會(huì)以 @JsonFormat 注解的時(shí)間格式為主。
三、@Configuration 注解
這種全局配置的實(shí)現(xiàn)方式與上邊的效果是一樣的。
“注意:在使用此種配置后,字段手動(dòng)配置@JsonFormat 注解將不再生效?!?/p>
@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 時(shí)間類型裝換
* @date 2020/9/1 17:25
*/
@Component
public class DateSerializer extends JsonSerializer
{ @Override
public void serialize(Date date, JsonGenerator gen, SerializerProvider provider) throws IOException {
String formattedDate = dateFormat.format(date);
gen.writeString(formattedDate);
}
}
/**
* @author xiaofu
* @description Date 時(shí)間類型裝換
* @date 2020/9/1 17:25
*/
@Component
public class DateDeserializer extends JsonDeserializer
{
@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 時(shí)間類型裝換
* @date 2020/9/1 17:25
*/
public class LocalDateTimeSerializer extends JsonSerializer
{ @Override
public void serialize(LocalDateTime value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
gen.writeString(value.format(DateTimeFormatter.ofPattern(pattern)));
}
}
/**
* @author xiaofu
* @description LocalDate 時(shí)間類型裝換
* @date 2020/9/1 17:25
*/
public class LocalDateTimeDeserializer extends JsonDeserializer
{ @Override
public LocalDateTime deserialize(JsonParser p, DeserializationContext deserializationContext) throws IOException {
return LocalDateTime.parse(p.getValueAsString(), DateTimeFormatter.ofPattern(pattern));
}
}
}
上述就是小編為大家分享的Springboot 中怎么格式化全局時(shí)間了,如果剛好有類似的疑惑,不妨參照上述分析進(jìn)行理解。如果想知道更多相關(guān)知識(shí),歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道。