spring boot 4.* 自定义序列化器的实现

 更新时间:2026年01月15日 08:33:19   作者:jjscx  
本文介绍了Spring Boot 4.*版本中Jackson自定义序列化器的适配方案,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

一、背景说明

在Spring Boot 4.*版本升级过程中,我们团队及不少开发者发现原有基于Jackson的自定义序列化器/反序列化器全部失效。经排查,核心原因是Spring Boot 4.0对Jackson的集成方式做了重大调整,尤其是自定义序列化组件的注册机制、基类继承体系发生了变化,导致旧版本中基于StdSerializer/StdDeserializer的实现方式不再适用。

为解决这一问题,我们封装了适配Spring Boot 4.*的Jackson自定义序列化配置类,本文将详细讲解该配置的实现原理、使用方式,并结合官方文档说明版本变更的核心点。

二、核心变更(官方文档参考)

Spring Boot 4.0对JSON处理的Jackson集成做了关键调整,官方文档链接:https://www.spring-doc.cn/spring-boot/4.0.0/reference_features_json.html

核心变更点:

  1. 序列化/反序列化基类调整:不再推荐直接继承StdSerializer/StdDeserializer,而是新增ValueSerializer/ValueDeserializer作为核心基类;
  2. 组件注册方式优化:新增@JacksonComponent注解,替代旧版本的手动注册方式,实现序列化组件的自动扫描和注册;
  3. 类型适配性增强:对Java 8时间类型(LocalDate/LocalTime/LocalDateTime)的序列化支持做了重构,旧版自定义序列化逻辑需适配新基类。

三、适配Spring Boot 4.*的自定义序列化实现

以下是完整的Jackson配置类,实现了Java 8时间类型的自定义序列化/反序列化,适配Spring Boot 4.*版本的核心规范。

3.1 完整代码实现

package com.auy.conf;

import org.springframework.boot.jackson.JacksonComponent;
import tools.jackson.core.JacksonException;
import tools.jackson.core.JsonGenerator;
import tools.jackson.core.JsonParser;
import tools.jackson.databind.*;

import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.time.format.DateTimeFormatter;

/**
 * Spring Boot 4 兼容的 Jackson 配置
 * 核心适配点:
 * 1. 继承新版ValueSerializer/ValueDeserializer基类
 * 2. 使用@JacksonComponent注解实现组件自动注册
 * 3. 适配Java 8时间类型的序列化/反序列化逻辑
 */
@JacksonComponent//:标记为Jackson组件,Spring Boot 4会自动扫描并注册
public class JacksonConfig {

    // 全局时间格式配置(从AuyConfig读取自定义格式,可根据业务调整为固定格式)
    public static final DateTimeFormatter DATE_FORMATTER = DateTimeFormatter.ofPattern(AuyConfig.get().getDateTimeFormat().getDatePattern());
    public static final DateTimeFormatter TIME_FORMATTER = DateTimeFormatter.ofPattern(AuyConfig.get().getDateTimeFormat().getTimePattern());
    public static final DateTimeFormatter DATE_TIME_FORMATTER = DateTimeFormatter.ofPattern(AuyConfig.get().getDateTimeFormat().getDateTimePattern());

    /**
     * LocalDate 自定义序列化器
     */
    public static class CustomLocalDateSerializer extends ValueSerializer<LocalDate> {
        @Override
        public void serialize(LocalDate v, JsonGenerator g, SerializationContext c) throws JacksonException {
            // 序列化逻辑:LocalDate转指定格式的字符串,null值返回null
            g.writeString(v != null ? DATE_FORMATTER.format(v) : null);
        }
    }

    /**
     * LocalDate 自定义反序列化器
     */
    public static class CustomLocalDateDeserializer extends ValueDeserializer<LocalDate> {
        @Override
        public LocalDate deserialize(JsonParser p, DeserializationContext c) throws JacksonException {
            // 反序列化逻辑:字符串转LocalDate,空值返回null
            String s = p.getValueAsString();
            return s == null || s.isEmpty() ? null : LocalDate.parse(s, DATE_FORMATTER);
        }
    }

    /**
     * LocalTime 自定义序列化器
     */
    public static class CustomLocalTimeSerializer extends ValueSerializer<LocalTime> {
        @Override
        public void serialize(LocalTime v, JsonGenerator g, SerializationContext c) throws JacksonException {
            g.writeString(v != null ? TIME_FORMATTER.format(v) : null);
        }
    }

    /**
     * LocalTime 自定义反序列化器
     */
    public static class CustomLocalTimeDeserializer extends ValueDeserializer<LocalTime> {
        @Override
        public LocalTime deserialize(JsonParser p, DeserializationContext c) throws JacksonException {
            String s = p.getValueAsString();
            return s == null || s.isEmpty() ? null : LocalTime.parse(s, TIME_FORMATTER);
        }
    }

    /**
     * LocalDateTime 自定义序列化器
     */
    public static class CustomLocalDateTimeSerializer extends ValueSerializer<LocalDateTime> {
        @Override
        public void serialize(LocalDateTime v, JsonGenerator g, SerializationContext c) throws JacksonException {
            g.writeString(v != null ? DATE_TIME_FORMATTER.format(v) : null);
        }
    }

    /**
     * LocalDateTime 自定义反序列化器
     */
    public static class CustomLocalDateTimeDeserializer extends ValueDeserializer<LocalDateTime> {
        @Override
        public LocalDateTime deserialize(JsonParser p, DeserializationContext c) throws JacksonException {
            String s = p.getValueAsString();
            return s == null || s.isEmpty() ? null : LocalDateTime.parse(s, DATE_TIME_FORMATTER);
        }
    }
}

3.2 代码关键说明

  1. 基类适配

    • 序列化器继承ValueSerializer<T>,反序列化器继承ValueDeserializer<T>(Spring Boot 4.*推荐的新版基类);
    • 重写核心方法:序列化器重写serialize,反序列化器重写deserialize,方法参数与旧版兼容,但基类体系不同。
  2. 组件注册

    • 使用@JacksonComponent注解标记基类(会将内部类全部注册)或者内部静态类(只注册标记的类),Spring Boot 4会自动扫描该注解并将序列化/反序列化器注册到Jackson容器中,无需手动配置ObjectMapper
    • 该注解替代了旧版本中@Bean注册SimpleModule的方式,简化了配置流程。
  3. 时间格式配置

    • AuyConfig读取自定义的时间格式(日期、时间、日期时间),也可直接替换为固定格式(如yyyy-MM-dd);
    • 处理null值和空字符串:反序列化时对空值做兼容,避免解析异常;序列化时null值返回null,符合JSON规范。
  4. 包路径注意

    • Jackson核心类的包路径为tools.jackson.*(Spring Boot 4.*调整后的路径,旧版为com.fasterxml.jackson.*),需确保依赖包版本匹配。

四、使用说明

4.1 依赖要求

确保Spring Boot版本为4.*,且Jackson相关依赖由Spring Boot父工程管理,无需手动指定版本:

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>4.0.0</version>
    <relativePath/>
</parent>

<dependencies>
    <!-- JSON核心依赖(包含Jackson,一般不需要引入,web依赖会自动包含它) -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-jackson</artifactId>
    </dependency>
</dependencies>

4.2 配置生效条件

  1. JacksonConfig类需放在Spring Boot的扫描路径下(如com.auy.conf包被@SpringBootApplication扫描);
  2. @JacksonComponent注解会自动触发组件注册,无需额外配置;
  3. AuyConfig需确保能正常获取时间格式配置,若无需动态配置,可直接替换为固定格式:
    // 示例:固定格式配置
    public static final DateTimeFormatter DATE_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd");
    public static final DateTimeFormatter TIME_FORMATTER = DateTimeFormatter.ofPattern("HH:mm:ss");
    public static final DateTimeFormatter DATE_TIME_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
    

4.3 验证方式

编写测试类,验证时间类型的序列化/反序列化是否符合预期:

import com.auy.conf.JacksonConfig;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import com.fasterxml.jackson.databind.ObjectMapper;

import java.time.LocalDateTime;

@SpringBootTest
public class JacksonSerializerTest {

    @Autowired
    private ObjectMapper objectMapper;

    @Test
    public void testLocalDateTimeSerializer() throws Exception {
        LocalDateTime now = LocalDateTime.now();
        // 序列化
        String json = objectMapper.writeValueAsString(now);
        System.out.println("序列化结果:" + json);
        // 反序列化
        LocalDateTime parsed = objectMapper.readValue(json, LocalDateTime.class);
        System.out.println("反序列化结果:" + parsed);
    }
}

五、扩展适配其他类型

若需适配其他自定义类型(如枚举、自定义VO),可参考以下模板:

@JacksonComponent
public static class CustomEnumSerializer extends ValueSerializer<YourEnum> {
    @Override
    public void serialize(YourEnum v, JsonGenerator g, SerializationContext c) throws JacksonException {
        // 自定义枚举序列化逻辑,如返回枚举的描述值
        g.writeString(v != null ? v.getDesc() : null);
    }
}

@JacksonComponent
public static class CustomEnumDeserializer extends ValueDeserializer<YourEnum> {
    @Override
    public YourEnum deserialize(JsonParser p, DeserializationContext c) throws JacksonException {
        String s = p.getValueAsString();
        // 自定义枚举反序列化逻辑
        return s == null ? null : YourEnum.getByDesc(s);
    }
}

六、常见问题解决

  1. 序列化器不生效

    • 检查@JacksonComponent注解是否添加;
    • 确认JacksonConfig在Spring扫描路径下;
    • 检查Jackson包路径是否为tools.jackson.*(Spring Boot 4.*调整后的路径)。
  2. 时间格式解析异常

    • 确认DATE_FORMATTER/TIME_FORMATTER/DATE_TIME_FORMATTER的格式与输入字符串匹配;
    • 反序列化时增加异常捕获(可选),适配多格式场景。
  3. 依赖冲突

    • 排除旧版Jackson依赖(com.fasterxml.jackson.*);
    • 确保Spring Boot父工程版本为4.*。

七、总结

Spring Boot 4.*对Jackson的集成调整核心在于基类和注册方式的优化,通过继承ValueSerializer/ValueDeserializer并使用@JacksonComponent注解,可快速适配新版序列化逻辑。本文提供的JacksonConfig类已实现Java 8时间类型的完整适配,可直接复用或扩展至其他自定义类型,解决升级后序列化器失效的问题。

到此这篇关于spring boot 4.* 自定义序列化器的实现的文章就介绍到这了,更多相关springboot 自定义序列化器内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java volatile的几种使用场景分析

    Java volatile的几种使用场景分析

    volatile 是一种轻量级的同步机制,它能保证共享变量的可见性,同时禁止重排序保证了操作的有序性,但是它无法保证原子性,本文给大家总结了Java olatile的使用场景有哪些,并通过代码示例讲解的非常详细,需要的朋友可以参考下
    2024-03-03
  • Spring中事务管理的四种方法(银行转账为例)

    Spring中事务管理的四种方法(银行转账为例)

    这篇文章主要给大家介绍了关于Spring中事务管理的四种方法,文中是以银行转账为例,通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2018-05-05
  • MyBatis中TypeHandler基本用法与示例

    MyBatis中TypeHandler基本用法与示例

    本文主要介绍了MyBatis中TypeHandler基本用法与示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2025-11-11
  • 宁可用Lombok也不把成员设置为public原理解析

    宁可用Lombok也不把成员设置为public原理解析

    这篇文章主要为大家介绍了宁可用Lombok也不把成员设置为public原理解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-03-03
  • spring 自定义让@Value被解析到

    spring 自定义让@Value被解析到

    这篇文章主要介绍了spring 自定义让@Value被解析到,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • 一文带你搞懂Maven的继承与聚合

    一文带你搞懂Maven的继承与聚合

    这篇文章主要为大家详细介绍了Maven的继承和聚合以及二者的区别,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-07-07
  • 详解Java匿名内部类

    详解Java匿名内部类

    这篇文章介绍了Java匿名内部类的实现,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-12-12
  • mybatis plus generator 根据数据库自动生成实体类的实现示例

    mybatis plus generator 根据数据库自动生成实体类的实现示例

    本文主要介绍了mybatis plus generator 根据数据库自动生成实体类的实现示例,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-09-09
  • 控制台显示java冒泡排序流程示例

    控制台显示java冒泡排序流程示例

    这篇文章主要介绍了控制台显示java冒泡排序流程示例,需要的朋友可以参考下
    2014-03-03
  • Java中的日期和时间类以及Calendar类用法详解

    Java中的日期和时间类以及Calendar类用法详解

    这篇文章主要介绍了Java中的日期和时间类以及Calendar类用法详解,是Java入门学习中的基础知识,需要的朋友可以参考下
    2015-09-09

最新评论