自定义SpringBoot对于LocalDate/LocalDateTime/LocalTime类型序列化和反序列化的几种方式

Posted 2022-01-26 donotshow

SpringBoot默认使用Jackson做json的序列化和反序列化

默认情况下，LocalDateTime会被序列化成这样，通常不是我们想要的结果。

1、通过Jackson提供的注解自定义序列化

这种方式是最自由的方式，可以在javabean里面定义各种格式，缺点就是每个时间类型都得指定序列化格式。

2、通过修改Spring容器中的ObjectMapper来注册新的JavaTimeModel来指定统一的序列化格式

一般系统内对于时间的序列化格式是固定的，所以推荐使用这种方式。

@Resource
    private lateinit var objectMapper: ObjectMapper

    @PostConstruct
    fun objectMapper() 
        val javaTimeModule = JavaTimeModule()
        javaTimeModule.addSerializer(
            LocalDateTime::class.java,
            LocalDateTimeSerializer(DateTimeFormatter.ofPattern(DateFormatSample.YYYY_MM_DD_HH_MM_SS))
        )
        javaTimeModule.addSerializer(
            LocalDate::class.java,
            LocalDateSerializer(DateTimeFormatter.ofPattern(DateFormatSample.YYYY_MM_DD))
        )
        javaTimeModule.addSerializer(
            LocalTime::class.java,
            LocalTimeSerializer(DateTimeFormatter.ofPattern(DateFormatSample.HH_MM_SS))
        )
        javaTimeModule.addDeserializer(
            LocalDateTime::class.java,
            LocalDateTimeDeserializer(DateTimeFormatter.ofPattern(DateFormatSample.YYYY_MM_DD_HH_MM_SS))
        )
        javaTimeModule.addDeserializer(
            LocalDate::class.java,
            LocalDateDeserializer(DateTimeFormatter.ofPattern(DateFormatSample.YYYY_MM_DD))
        )
        javaTimeModule.addDeserializer(
            LocalTime::class.java,
            LocalTimeDeserializer(DateTimeFormatter.ofPattern(DateFormatSample.HH_MM_SS))
        )
        //这边是比较重要的点，默认忽略了相同类型的javaTimeModel的注册，所以需要先disable这条规则
        objectMapper.disable(MapperFeature.IGNORE_DUPLICATE_MODULE_REGISTRATIONS)
        //完成自定义javaTimeModel注册
        objectMapper.registerModule(javaTimeModule)
        //重新开启忽略规则
        objectMapper.enable(MapperFeature.IGNORE_DUPLICATE_MODULE_REGISTRATIONS)
    

以上DateFormatSample为自定义对象，定义时间的格式化类型字符串，比如：yyyy-MM-dd HH:mm:ss