0

0

Jackson 自定义序列化器中正确嵌套序列化子类字段的完整指南

碧海醫心

碧海醫心

发布时间:2026-01-22 09:03:55

|

199人浏览过

|

来源于php中文网

原创

Jackson 自定义序列化器中正确嵌套序列化子类字段的完整指南

本文详解如何在 jackson 自定义 `stdserializer` 中正确序列化多态集合中的子类实例,解决因误用 `writenullfield` 导致子类字段丢失的问题,并提供可运行的 xml 序列化示例与反序列化注意事项。

在使用 Jackson(尤其是 XmlMapper)处理多态对象(如 List)时,若为容器类(如 Zoo)编写自定义序列化器,必须确保子类实例被完整委托给 Jackson 默认序列化机制,而非仅写入空标签或 null 字段。原始代码中调用 jg.writeNullField(animal.getClass().getSimpleName()) 仅生成 空标签,完全跳过了 Dog 对象本身的字段序列化逻辑。

正确的做法是:在自定义 serialize() 方法中,对每个 Animal 实例调用 JsonGenerator#writeObjectField(String fieldName, Object value)。该方法会自动触发 Jackson 对 value(即 Dog 实例)的标准序列化流程——包括其 public 字段(breed, age)、注解感知(如 @JsonProperty)、以及类型信息(若已配置 @JsonTypeInfo)。

以下是修复后的 ZooSerializer 完整实现:

public class ZooSerializer extends StdSerializer {
    public ZooSerializer() {
        this(null);
    }

    public ZooSerializer(Class t) {
        super(t);
    }

    @Override
    public void serialize(Zoo zoo, JsonGenerator jg, SerializerProvider sp) throws IOException {
        jg.writeStartObject();
        for (Animal animal : zoo.animals) {
            String typeName = animal.getClass().getSimpleName();
            jg.writeObjectField(typeName, animal); // ✅ 关键:委托 Jackson 序列化子类实例
        }
        jg.writeEndObject();
    }
}

配合以下测试代码:

CoCo
CoCo

智谱AI推出的首个有记忆的企业自主Agent智能体

下载
@Test
public void testZooSerialization() throws JsonProcessingException {
    XmlMapper xmlMapper = new XmlMapper();
    // 启用默认 getter/setter 支持(若字段非 public,需额外配置)
    xmlMapper.setVisibility(PropertyAccessor.FIELD, JsonAutoDetect.Visibility.ANY);

    Zoo zoo = new Zoo();
    zoo.animals.add(new Dog("Collie", "6"));
    zoo.animals.add(new Cat("Siamese", "3")); // 假设 Cat 类结构类似

    String xml = xmlMapper.writerWithDefaultPrettyPrinter().writeValueAsString(zoo);
    System.out.println(xml);
}

输出将正确包含子类字段:


  
    Collie
    6
  
  
    Siamese
    3
  

⚠️ 重要注意事项

  • 反序列化需配套自定义反序列化器:当前 ZooSerializer 仅处理序列化;若需从 XML 反序列化回 Zoo,必须实现 JsonDeserializer 并结合 @JsonTypeInfo(如 use = Id.NAME)与 @JsonSubTypes 显式声明子类映射,否则 Jackson 无法推断 Dog/Cat 的具体类型。
  • 字段可见性:确保 Dog 等子类字段为 public,或通过 XmlMapper 配置 setVisibility() 启用字段访问(如上例所示),否则字段将被忽略。
  • 避免重复序列化逻辑:切勿在 serialize() 中手动遍历子类字段并调用 writeStringField() 等——这会绕过 Jackson 的类型处理、注解解析和空值策略,丧失框架优势。

综上,writeObjectField() 是连接自定义容器序列化与标准子类序列化的关键桥梁。它既保留了对容器结构(如按类名生成字段)的完全控制,又复用了 Jackson 成熟的 POJO 序列化能力,是处理多态 XML 序列化的推荐实践。

相关专题

更多
string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

338

2023.08.02

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

232

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

437

2024.03.01

java多态详细介绍
java多态详细介绍

本专题整合了java多态相关内容,阅读专题下面的文章了解更多详细内容。

15

2025.11.27

java多态详细介绍
java多态详细介绍

本专题整合了java多态相关内容,阅读专题下面的文章了解更多详细内容。

15

2025.11.27

pdf怎么转换成xml格式
pdf怎么转换成xml格式

将 pdf 转换为 xml 的方法:1. 使用在线转换器;2. 使用桌面软件(如 adobe acrobat、itext);3. 使用命令行工具(如 pdftoxml)。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1894

2024.04.01

xml怎么变成word
xml怎么变成word

步骤:1. 导入 xml 文件;2. 选择 xml 结构;3. 映射 xml 元素到 word 元素;4. 生成 word 文档。提示:确保 xml 文件结构良好,并预览 word 文档以验证转换是否成功。想了解更多xml的相关内容,可以阅读本专题下面的文章。

2087

2024.08.01

xml是什么格式的文件
xml是什么格式的文件

xml是一种纯文本格式的文件。xml指的是可扩展标记语言,标准通用标记语言的子集,是一种用于标记电子文件使其具有结构性的标记语言。想了解更多相关的内容,可阅读本专题下面的相关文章。

1030

2024.11.28

Golang 性能分析与pprof调优实战
Golang 性能分析与pprof调优实战

本专题系统讲解 Golang 应用的性能分析与调优方法,重点覆盖 pprof 的使用方式,包括 CPU、内存、阻塞与 goroutine 分析,火焰图解读,常见性能瓶颈定位思路,以及在真实项目中进行针对性优化的实践技巧。通过案例讲解,帮助开发者掌握 用数据驱动的方式持续提升 Go 程序性能与稳定性。

1

2026.01.22

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.4万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号