Jackson多态列表自定义序列化方案解析

从现在开始，努力学习吧！本文《Jackson多态列表自定义标签序列化方案》主要讲解了等等相关知识点，我会在golang学习网中持续更新相关的系列文章，欢迎大家关注并积极留言建议。下面就先一起来看一下本篇正文内容吧，希望能帮到你！

本文探讨了在使用Jackson将包含多态元素的列表序列化为XML时，如何确保每个元素根据其实际类型生成对应的XML标签名。针对Jackson默认行为导致标签泛化的问题，文章提出并详细演示了通过实现自定义JsonSerializer来精确控制XML输出结构的解决方案。同时，也指出了此方法在便利性上相较于使用JsonTypeInfo等注解的局限性，并强调了可能需要配套自定义反序列化器。

理解问题：Jackson默认行为的挑战

在使用Jackson进行XML序列化时，当一个Java类中包含一个泛型列表（例如List），且该列表的元素是其基类Animal的各种子类（如Dog、Cat）实例时，我们通常期望序列化后的XML能够反映出每个元素的具体类型，即以子类名作为XML标签。然而，Jackson的默认行为往往无法满足这一需求。

考虑以下Java类定义：

// 抽象基类
public abstract class Animal {}

// 动物子类
public class Dog extends Animal {}
public class Cat extends Animal {}

// 包含动物列表的Zoo类
// @JacksonXmlRootElement(localName = "Zoo") // 在自定义序列化方案中，此注解可能被@JsonSerialize取代
public class Zoo {
  // @JacksonXmlProperty // 在自定义序列化方案中，此注解可能被@JsonSerialize取代
  // @JacksonXmlElementWrapper(useWrapping = false) // 尝试去除包装器，但对标签名无直接作用
  List<Animal> animals = new ArrayList<>();
}

当我们尝试序列化一个Zoo实例，其中包含Dog和Cat对象：

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.dataformat.xml.XmlMapper;

public class SerializationDemo {
    public static void main(String[] args) throws JsonProcessingException {
        Zoo zoo = new Zoo();
        zoo.animals.add(new Dog());
        zoo.animals.add(new Cat());
        zoo.animals.add(new Dog());

        // 使用XmlMapper进行序列化
        XmlMapper mapper = new XmlMapper();
        String xml = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(zoo);
        System.out.println(xml);
    }
}

我们期望得到的XML输出是这样的：

<Zoo>
  <Dog/>
  <Cat/>
  <Dog/>
</Zoo>

然而，Jackson默认的序列化结果却可能是：

<Zoo>
  <animals/>
  <animals/>
  <animals/>
</Zoo>

或者带有包装器的形式（取决于@JacksonXmlElementWrapper的配置），但核心问题是，列表中的每个元素都被序列化成了泛型标签（如），而不是其具体类型（或）。这是因为Jackson在处理列表元素时，默认会根据字段名或集合类型来生成标签，而不是深入到每个元素的实际运行时类型。

解决方案：自定义Jackson XML序列化器

要实现将多态列表元素序列化为各自类型对应的XML标签，最直接且有效的方法是编写一个自定义的Jackson序列化器。通过自定义序列化器，我们可以完全控制Zoo对象及其animals列表的XML输出结构。

1. 定义自定义序列化器

我们需要创建一个继承自com.fasterxml.jackson.databind.ser.std.StdSerializer的类，并重写其serialize方法。在这个方法中，我们将遍历Zoo对象中的animals列表，并手动为每个Animal子类写入一个以其简单类名作为标签的空元素。

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.ser.std.StdSerializer;
import java.io.IOException;

public class ZooSerializer extends StdSerializer<Zoo> {

    public ZooSerializer() {
        this(null);
    }

    public ZooSerializer(Class<Zoo> t) {
        super(t);
    }

    @Override
    public void serialize(Zoo zoo, JsonGenerator jg, SerializerProvider sp) throws IOException {
        // 开始写入Zoo对象的XML标签
        // 由于Zoo类本身被@JsonSerialize注解，这里实际上是处理Zoo内部的内容
        // jg.writeStartObject(); // 这一行如果Zoo是根元素，Jackson会自行处理其开始标签

        for (Animal animal : zoo.animals) {
            // 为每个Animal子类写入一个XML空标签，标签名为其类名
            // 例如，如果是Dog对象，则写入<Dog/>
            // 如果是Cat对象，则写入<Cat/>
            jg.writeNullField(animal.getClass().getSimpleName());
        }

        // jg.writeEndObject(); // 这一行如果Zoo是根元素，Jackson会自行处理其结束标签
    }
}

代码解释：

• StdSerializer：表示这个序列化器是为Zoo类服务的。
• serialize(Zoo zoo, JsonGenerator jg, SerializerProvider sp)：这是核心方法。
  • JsonGenerator jg：用于向输出流写入JSON/XML事件。
  • zoo.animals：遍历Zoo对象中的动物列表。
  • animal.getClass().getSimpleName()：获取当前动物对象的实际类名（如"Dog"或"Cat"）。
  • jg.writeNullField(...)：这是关键。在XML模式下，writeNullField("TagName")会生成一个的空标签。这正是我们所期望的输出格式。

2. 应用自定义序列化器

在Zoo类上使用@JsonSerialize注解，指定使用我们自定义的ZooSerializer。

import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import java.util.ArrayList;
import java.util.List;

// 抽象基类和子类保持不变
public abstract class Animal {}
public class Dog extends Animal {}
public class Cat extends Animal {}

// Zoo类现在使用自定义序列化器
@JsonSerialize(using = ZooSerializer.class)
public class Zoo {
  List<Animal> animals = new ArrayList<>();
}

3. 运行示例

现在，再次运行之前的序列化示例代码：

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.dataformat.xml.XmlMapper;

public class SerializationDemo {
    public static void main(String[] args) throws JsonProcessingException {
        Zoo zoo = new Zoo();
        zoo.animals.add(new Dog());
        zoo.animals.add(new Cat());
        zoo.animals.add(new Dog());

        XmlMapper mapper = new XmlMapper();
        String xml = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(zoo);
        System.out.println(xml);
    }
}

输出结果将是：

<Zoo>
  <Dog/>
  <Cat/>
  <Dog/>
</Zoo>

这正是我们期望的XML结构，每个多态列表元素都以其具体的类名作为XML标签。

注意事项与权衡

虽然自定义序列化器能够精确控制XML输出，但这种方法并非没有代价。

1. 失去Jackson内置的多态支持： Jackson提供了@JsonTypeInfo和@JsonSubTypes等注解，用于在JSON/XML中嵌入类型信息，从而实现自动的多态序列化和反序列化。使用自定义序列化器意味着放弃了这些内置的便利性。
2. 需要配套自定义反序列化器： 如果你需要将上述生成的XML反序列化回Java对象，Jackson将无法自动识别和标签并创建对应的Dog和Cat实例。你必须编写一个自定义的JsonDeserializer来手动解析这些标签并构建正确的对象图。这会显著增加开发和维护的复杂性。
3. 代码侵入性： 自定义序列化器通常需要直接操作JsonGenerator，这使得序列化逻辑与数据结构耦合更紧密，可能降低代码的灵活性。
4. 适用场景： 这种方法最适合于对XML输出结构有非常严格且固定要求，且不经常需要反序列化的特定场景。对于更通用的多态序列化需求，强烈建议优先考虑Jackson的@JsonTypeInfo和@JsonSubTypes注解，它们提供了更灵活、更自动化的解决方案。

总结

当Jackson的默认XML序列化行为无法满足多态列表中元素需要以其具体类型作为XML标签的需求时，实现自定义JsonSerializer是一个有效的解决方案。通过手动控制JsonGenerator的输出，可以精确地生成期望的XML结构。然而，采用此方案意味着放弃了Jackson内置的多态序列化便利性，并且在需要反序列化时，必须额外开发对应的自定义反序列化器。因此，在选择此方法之前，务必充分评估其对项目整体复杂性和可维护性的影响。

好了，本文到此结束，带大家了解了《Jackson多态列表自定义序列化方案解析》，希望本文对你有所帮助！关注golang学习网公众号，给大家分享更多文章知识！