springboot 日期格式化全局LocalDateTime

avatar
作者
筋斗云
阅读量:0

springboot 默认使用ObjectMapper(jackson)操作对象的序列化和反序列化

分析

从springboot:3.2.1 web 项目序列化响应体的过程中分析日期格式化问题(左侧是请求处理流程,右侧是在流程中使用的一些对象的来源)
在这里插入图片描述

ObjectMapper与JsonSerializer

根据上述流程可知,序列化响应结果时使用的ObjectMapper对象是由自动配置类JacksonAutoConfiguratioin.JacksonObjectMapperConfiguration使用Jackson2ObjectMapperBuilder创建,并注册到beanfactory中。
在这里插入图片描述

  • 创建ObjectMapper对象
    在这里插入图片描述

  • 设置ObjectMapper对象的属性
    Jackson2ObjectMapperBuilder#build方法中创建了ObjectMapper对象,然后在Jackson2ObjectMapperBuilder#configure方法中对ObjectMapper对象设置了一些属性。例如创建JavaTimeModule对象并将其注册给ObjectMapper, 正是在JavaTimeModule的构造方法中指定了LocalDateTime的序列化器使用com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer,并将这种关系使用ObjectMapper#registerModules注册给ObjectMapper对象
    在这里插入图片描述
    在以下方法中创建了com.fasterxml.jackson.datatype.jsr310.JavaTimeModule对象

    private void registerWellKnownModulesIfAvailable(MultiValueMap<Object, Module> modulesToRegister) {         // ... 		try { 			Class<? extends Module> javaTimeModuleClass = (Class<? extends Module>) 					ClassUtils.forName("com.fasterxml.jackson.datatype.jsr310.JavaTimeModule", this.moduleClassLoader); 			Module javaTimeModule = BeanUtils.instantiateClass(javaTimeModuleClass); 			modulesToRegister.set(javaTimeModule.getTypeId(), javaTimeModule); 		} 		catch (ClassNotFoundException ex) { 			// jackson-datatype-jsr310 not available 		} 		// ... 	} 

    在JavaTimeModule类的构造函数中设置了LocalDateTime类型和该类型使用的序列化器LocalDateTimeSerializer和反序列化器LocalDateTimeDeserializer的对应关系
    在这里插入图片描述

结论

springboot项目中,使用从beanfactory中获取的ObjectMapper序列化对象时,若对象的字段类型是LocalDateTime,则使用com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer对字段进行序列化,但是其默认的日期格式并不是我们想要的。
在这里插入图片描述
因此需要干涉上述流程,使用自定义的日期时间格式
在这里插入图片描述

自定义日期格式(全局)

  1. 直接操作spring容器中的ObjectMapperbean
    利用ObjectMapper#registerModule

  2. 自定义容器中的Jackson2ObjectMapperBuilderbean,达到间接操作ObjectMapper的目的

    从流程图中可知,容器中的ObjectMapper对象由Jackson2ObjectMapperBuilder创建(创建者模式),因此自定义Jackson2ObjectMapperBuilder的属性,会间接作用到ObjectMapper的属性

    根据JacksonAutoConfiguration.JacksonObjectMapperBuilderConfiguration源码可知,创建一个Jackson2ObjectMapperBuilderCustomizer实现类,并将其注入到容器中,可对容器中的Jackson2ObjectMapperBuilder bean进行自定义配置
    在这里插入图片描述
    按照上述思路实现如下(真实工作中需考虑多个customizer的顺序)
    在这里插入图片描述
    也可以使用modulesToInstall方法
    在这里插入图片描述

  3. 向容器中注入com.fasterxml.jackson.databind.Module的实现类
    这是因为springboot自动配置包中已经提供了一个Jackson2ObjectMapperBuilderCustomizer实现类,在创建该实现类对象时,它将从容器中获取的com.fasterxml.jackson.databind.Modulebean用于自定义配置Jackson2ObjectMapperBuilder
    在这里插入图片描述
    同时,可以看到StandardJackson2ObjectMapperBuilderCustomizer类使用了JacksonProperties的配置,也就说可以在配置文件中做些定义的配置
    在这里插入图片描述

扩展

利用配置文件指定java.util.Date类型的格式化
spring:   jackson:     date-format: yyyy-MM-dd HH:mm:ss     time-zone: GMT+8 

这种方式对java.time.LocalDateTime类型无效

利用注解指定时间格式化(局部)
  • @JsonFormat,对java.util.Datejava.time.LocalDateTime都有效
    在这里插入图片描述

  • @JsonSerialize@JsonDeserialize,指定使用的序列化器

  • @DateTimeFormat

广告一刻

为您即时展示最新活动产品广告消息,让您随时掌握产品活动新动态!