springboot日期格式化全局LocalDateTime详解

黎绿蝶

目录

• 分析
• ObjectMapper与JsonSerializer
• 结论
• 自定义日期格式（全局）
• 扩展
• 利用配置文件指定java.util.Date类型的格式化
• 利用注解指定时间格式化（局部）
• 总结

springboot 默认使用

1. ObjectMapper

复制代码

(jackson)操作对象的序列化和反序列化

分析

从springboot:3.2.1 web 项目序列化响应体的过程中分析日期格式化问题（左侧是请求处理流程，右侧是在流程中使用的一些对象的来源）

ObjectMapper与JsonSerializer

根据上述流程可知，序列化响应结果时使用的

1. ObjectMapper

复制代码

对象是由自动配置类

1. JacksonAutoConfiguratioin.JacksonObjectMapperConfiguration

复制代码

使用

1. Jackson2ObjectMapperBuilder

复制代码

创建，并注册到

1. beanfactory

复制代码

中。

创建ObjectMapper对象

设置ObjectMapper对象的属性

在

1. Jackson2ObjectMapperBuilder#build

复制代码

方法中创建了

1. ObjectMapper

复制代码

对象，然后在

1. Jackson2ObjectMapperBuilder#configure

复制代码

方法中对

1. ObjectMapper

复制代码

对象设置了一些属性。

例如创建

1. JavaTimeModule

复制代码

对象并将其注册给

1. ObjectMapper

复制代码

, 正是在

1. JavaTimeModule

复制代码

的构造方法中指定了

1. LocalDateTime

复制代码

的序列化器使用

1. com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer

复制代码

，并将这种关系使用

1. ObjectMapper#registerModules

复制代码

注册给

1. ObjectMapper

复制代码

对象

在以下方法中创建了

1. com.fasterxml.jackson.datatype.jsr310.JavaTimeModule

复制代码

对象

1. private void registerWellKnownModulesIfAvailable(MultiValueMap<Object, Module> modulesToRegister) {
2. // ...
3. try {
4. Class<? extends Module> javaTimeModuleClass = (Class<? extends Module>)
5. ClassUtils.forName("com.fasterxml.jackson.datatype.jsr310.JavaTimeModule", this.moduleClassLoader);
6. Module javaTimeModule = BeanUtils.instantiateClass(javaTimeModuleClass);
7. modulesToRegister.set(javaTimeModule.getTypeId(), javaTimeModule);
8. }
9. catch (ClassNotFoundException ex) {
10. // jackson-datatype-jsr310 not available
11. }
12. // ...
13. }

复制代码

在JavaTimeModule类的构造函数中设置了

1. LocalDateTime

复制代码

类型和该类型使用的序列化器

1. LocalDateTimeSerializer

复制代码

和反序列化器

1. LocalDateTimeDeserializer

复制代码

的对应关系

结论

springboot项目中，使用从beanfactory中获取的

1. ObjectMapper

复制代码

序列化对象时，若对象的字段类型是

1. LocalDateTime

复制代码

，则使用

1. com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer

复制代码

对字段进行序列化，但是其默认的日期格式并不是我们想要的。

因此需要干涉上述流程，使用自定义的日期时间格式

自定义日期格式（全局）

1.直接操作spring容器中的

1. ObjectMapper

复制代码

bean

利用

1. ObjectMapper#registerModule

复制代码

2.自定义容器中的

1. Jackson2ObjectMapperBuilder

复制代码

bean，达到间接操作ObjectMapper的目的

从流程图中可知，容器中的

1. ObjectMapper

复制代码

对象由

1. Jackson2ObjectMapperBuilder

复制代码

创建（创建者模式），因此自定义

1. Jackson2ObjectMapperBuilder

复制代码

的属性，会间接作用到

1. ObjectMapper

复制代码

的属性

根据

1. JacksonAutoConfiguration.JacksonObjectMapperBuilderConfiguration

复制代码

源码可知，创建一个

1. Jackson2ObjectMapperBuilderCustomizer

复制代码

实现类，并将其注入到容器中，可对容器中的

1. Jackson2ObjectMapperBuilder

复制代码

bean进行自定义配置

按照上述思路实现如下（真实工作中需考虑多个customizer的顺序）

也可以使用modulesToInstall方法

3.向容器中注入

1. com.fasterxml.jackson.databind.Module

复制代码

的实现类

这是因为springboot自动配置包中已经提供了一个

1. Jackson2ObjectMapperBuilderCustomizer

复制代码

实现类，在创建该实现类对象时，它将从容器中获取的

1. com.fasterxml.jackson.databind.Module

复制代码

bean用于自定义配置

1. Jackson2ObjectMapperBuilder

复制代码

同时，可以看到

1. StandardJackson2ObjectMapperBuilderCustomizer

复制代码

类使用了

1. JacksonProperties

复制代码

的配置，也就说可以在配置文件中做些定义的配置

扩展

利用配置文件指定java.util.Date类型的格式化

1. spring:
2. jackson:
3. date-format: yyyy-MM-dd HH:mm:ss
4. time-zone: GMT+8

复制代码

这种方式对

1. java.time.LocalDateTime

复制代码

类型无效

利用注解指定时间格式化（局部）

1. @JsonFormat

复制代码

，对

1. java.util.Date

复制代码

和

1. java.time.LocalDateTime

复制代码

都有效

• 1. @JsonSerialize

  复制代码
  、
  1. @JsonDeserialize

  复制代码
  ，指定使用的序列化器
• 1. @DateTimeFormat

  复制代码
• 1. @JsonComponent

  复制代码

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持晓枫资讯。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

韶罗绮

感谢楼主，顶。

庾乐蕊

路过，支持一下