3种 Springboot 全局时间格式化方式,别再写重复代码了
2020-09-02 11:36
2481 查看
本文收录在个人博客:www.chengxy-nds.top,技术资料共享,同进步
时间格式化在项目中使用频率是非常高的,当我们的
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时间格式化成功。
二、@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两种时间类型格式化成功,此种方式有效。
但还有个问题,实际开发中如果我有个字段不想用全局格式化设置的时间样式,想自定义格式怎么办?
那就需要和
@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 @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开发技巧,其实所谓的开发效率,不过是一个又一个开发技巧堆砌而来,聪明的程序员总是能用最少的代码完成任务。
如果对你有用,欢迎
在看、
点赞、
转发,您的认可是我最大的动力。
原创不易,燃烧秀发输出内容,如果有一丢丢收获,点个赞鼓励一下吧!
整理了几百本各类技术电子书,送给小伙伴们。关注公号回复【666】自行领取。和一些小伙伴们建了一个技术交流群,一起探讨技术、分享技术资料,旨在共同学习进步,如果感兴趣就加入我们吧!
相关文章推荐
- 关于Springboot日期时间格式化处理方式总结
- springboot - 集成mysql实现方式之一,DruidDataSource 完整代码实现
- 真没想到,Springboot能这样做全局日期格式化,有点香!
- ASP.NET 中后台代码中全局变量在提交多少后一直保存起来的3种方式
- springboot+redis(注解方式)使用(java代码部分)
- 一张图帮你记忆,Spring Boot 应用在启动阶段执行代码的几种方式
- spring boot(一) 各种数据绑定 及时间格式化和时区问题 及XML格式与Bean,Map的互转
- Spring boot通过AOP防止API重复请求代码实例
- springboot+mybaties plus 统一结果返回|设置全局json的时间格式|查询表中所有的数据|逻辑删除操作
- springboot 关于实体类时间问题时间格式化不起作用原因一定要导入import.java.sql.date
- 真没想到,Springboot能这样做全局日期格式化,有点香!
- springboot全局异常处理代码实例
- Springboot 注册web三大组件(代码方式)(十二)
- 【HAVENT原创】使用 Spring Boot 的 AOP 全局记录执行时间日志
- springboot json时间格式化处理的方法
- Spring Boot项目维护全局json数据代码实例
- spring boot aop 记录方法执行时间代码示例
- 时间格式化springBoot
- spring boot学习教程(4):全局异常处理代码demo
- 三种方式格式化时间(JS函数、HTML中EL表达式、Java代码中)