spring boot定时配置（3种Springboot全局时间格式化方式）

时间格式化在项目中使用频率是非常高的，当我们的 API 接口返回结果，需要对其中某一个 date 字段属性进行特殊的格式化处理，通常会用到 SimpleDateFormat 工具处理。

SimpleDateFormatdateFormat=newSimpleDateFormat("yyyy-MM-dd"); DatestationTime=dateFormat.parse(dateFormat.format(PayEndTime()));

可一旦处理的地方较多，不仅 CV 操作频繁，还产生很多重复臃肿的代码，而此时如果能将时间格式统一配置，就可以省下更多时间专注于业务开发了。

可能很多人觉得统一格式化时间很简单啊，像下边这样配置一下就行了，但事实上这种方式只对 date 类型生效。

spring.jackson.date-format=yyyy-MM-ddHH:mm:ss spring.jackson.time-zone=GMT 8

而很多项目中用到的时间和日期API 比较混乱， java.util.Date 、 java.util.Calendar 和 java.time LocalDateTime 都存在，所以全局时间格式化必须要同时兼容性新旧 API。

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

@Data publicclassOrderDTO{ privateLocalDateTimecreateTime; privateDateupdateTime; }

很明显不符合页面上的显示要求（有人抬杠为啥不让前端解析时间，我只能说睡服代码比说服人容易得多~）

未做任何配置的结果

@JsonFormat 注解方式严格意义上不能叫全局时间格式化，应该叫部分格式化，因为@JsonFormat 注解需要用在实体类的时间字段上，而只有使用相应的实体类，对应的字段才能进行格式化。

@Data publicclassOrderDTO{ @JsonFormat(locale="zh",timezone="GMT 8",pattern="yyyy-MM-dd") privateLocalDateTimecreateTime; @JsonFormat(locale="zh",timezone="GMT 8",pattern="yyyy-MM-ddHH:mm:ss") privateDateupdateTime; }

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

@JsonFormat 注解格式化

这是我个人比较推荐的一种方式，前边看到使用 @JsonFormat 注解并不能完全做到全局时间格式化，所以接下来我们使用 @JsonComponent 注解自定义一个全局格式化类，分别对 Date 和 LocalDate 类型做格式化处理。

@JsonComponent publicclassDateFormatConfig{ @Value("${spring.jackson.date-format:yyyy-MM-ddHH:mm:ss}") privateStringpattern; /** *@authorxiaofu *@descriptiondate类型全局时间格式化 *@date2020/8/3118:22 */ @Bean publicJackson2ObjectMapperBuilderCustomizerjackson2ObjectMapperBuilder(){ returnbuilder->{ TimeZonetz=TimeZone.getTimeZone("UTC"); DateFormatdf=newSimpleDateFormat(pattern); df.setTimeZone(tz); builder.failOnEmptyBeans(false) .failOnUnknownProperties(false) .featuresToDisable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS) .dateFormat(df); }; } /** *@authorxiaofu *@descriptionLocalDate类型全局时间格式化 *@date2020/8/3118:22 */ @Bean publicLocalDateTimeSerializerlocalDateTimeDeserializer(){ returnnewLocalDateTimeSerializer(DateTimeFormatter.ofPattern(pattern)); } @Bean publicJackson2ObjectMapperBuilderCustomizerjackson2ObjectMapperBuilderCustomizer(){ returnbuilder->builder.serializerByType(LocalDateTime.class,localDateTimeDeserializer()); } }

看到 Date 和 LocalDate 两种时间类型格式化成功，此种方式有效。

@JsonComponent 注解处理格式化

但还有个问题，实际开发中如果我有个字段不想用全局格式化设置的时间样式，想自定义格式怎么办？

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

@Data publicclassOrderDTO{ @JsonFormat(locale="zh",timezone="GMT 8",pattern="yyyy-MM-dd") privateLocalDateTimecreateTime; @JsonFormat(locale="zh",timezone="GMT 8",pattern="yyyy-MM-dd") privateDateupdateTime; }

从结果上我们看到 @JsonFormat 注解的优先级比较高，会以 @JsonFormat 注解的时间格式为主。

这种全局配置的实现方式与上边的效果是一样的。

“

注意：在使用此种配置后，字段手动配置@JsonFormat 注解将不再生效。

”

@Configuration publicclassDateFormatConfig2{ @Value("${spring.jackson.date-format:yyyy-MM-ddHH:mm:ss}") privateStringpattern; publicstaticDateFormatdateFormat=newSimpleDateFormat("yyyy-MM-ddHH:mm:ss"); @Bean @Primary publicObjectMapperserializingObjectMapper(){ ObjectMapperobjectMapper=newObjectMapper(); JavaTimeModulejavaTimeModule=newJavaTimeModule(); javaTimeModule.addSerializer(LocalDateTime.class,newLocalDateTimeSerializer()); javaTimeModule.addDeserializer(LocalDateTime.class,newLocalDateTimeDeserializer()); objectMapper.registerModule(javaTimeModule); returnobjectMapper; } /** *@authorxiaofu *@descriptionDate时间类型装换 *@date2020/9/117:25 */ @Component publicclassDateSerializerextendsJsonSerializer<Date>{ @Override publicvoidserialize(Datedate,JsonGeneratorgen,SerializerProviderprovider)throwsIOException{ StringformattedDate=dateFormat.format(date); gen.writeString(formattedDate); } } /** *@authorxiaofu *@descriptionDate时间类型装换 *@date2020/9/117:25 */ @Component publicclassDateDeserializerextendsJsonDeserializer<Date>{ @Override publicDatedeserialize(JsonParserjsonParser,DeserializationContextdeserializationContext)throwsIOException{ try{ returndateFormat.parse(jsonParser.getValueAsString()); }catch(ParseExceptione){ thrownewRuntimeException("Couldnotparsedate",e); } } } /** *@authorxiaofu *@descriptionLocalDate时间类型装换 *@date2020/9/117:25 */ publicclassLocalDateTimeSerializerextendsJsonSerializer<LocalDateTime>{ @Override publicvoidserialize(LocalDateTimevalue,JsonGeneratorgen,SerializerProviderserializers)throwsIOException{ gen.writeString(value.format(DateTimeFormatter.ofPattern(pattern))); } } /** *@authorxiaofu *@descriptionLocalDate时间类型装换 *@date2020/9/117:25 */ publicclassLocalDateTimeDeserializerextendsJsonDeserializer<LocalDateTime>{ @Override publicLocalDateTimedeserialize(JsonParserp,DeserializationContextdeserializationContext)throwsIOException{ returnLocalDateTime.parse(p.getValueAsString(),DateTimeFormatter.ofPattern(pattern)); } } }

总结

分享了一个简单却又很实用的 Springboot 开发技巧，其实所谓的开发效率，不过是一个又一个开发技巧堆砌而来，聪明的程序员总是能用最少的代码完成任务。

如果对你有用，欢迎 在看、点赞、转发 ，您的认可是我最大的动力。

全网搜：程序员内点事。

整理了几百本各类技术电子书相送 ，嘘~，「免费」 送给小伙伴们，私信或者评论【666】自行领取。和一些小伙伴们建了一个技术交流群，一起探讨技术、分享技术资料，旨在共同学习进步。

,