Jackson多态列表自定义设置教程

知识点掌握了，还需要不断练习才能熟练运用。下面golang学习网给大家带来一个文章开发实战，手把手教大家学习《Jackson多态列表标签自定义设置》，在实现功能的过程中也带大家重新温习相关知识点，温故而知新，回头看看说不定又有不一样的感悟！

Jackson在将包含多态元素的列表序列化为XML时，默认行为可能无法为每个子类型生成独立的标签。本文探讨了如何通过实现自定义JsonSerializer来解决此问题，使得序列化后的XML中，列表内的每个多态元素都能以其具体的类名作为标签。虽然这种方法能实现预期效果，但需注意它会放弃Jackson内置的多态类型处理（如JsonTypeInfo）带来的便利，且需要手动处理反序列化逻辑。

Jackson XML多态列表序列化的挑战

在使用Jackson库将Java对象序列化为XML时，如果对象中包含一个泛型列表，且列表的元素是多态类型（即基类的子类对象），Jackson的默认行为可能不会为每个子类对象生成其具体的类名作为XML标签。

考虑以下Java类结构，其中Zoo包含一个List，而Animal有Dog和Cat两个子类：

abstract class Animal {}

@JacksonXmlRootElement(localName = "Dog")
class Dog extends Animal {}

@JacksonXmlRootElement(localName = "Cat")
class Cat extends Animal {}

@JacksonXmlRootElement(localName = "Zoo")
public class Zoo {
  @JacksonXmlProperty
  @JacksonXmlElementWrapper(useWrapping = false)
  List<Animal> animals = new ArrayList<>();
}

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

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.dataformat.xml.XmlMapper;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement;

import java.util.ArrayList;
import java.util.List;

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());
    String xml = new XmlMapper().writerWithDefaultPrettyPrinter()
        .writeValueAsString(zoo);
    System.out.println(xml);
  }
}

我们预期的XML输出是：

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

然而，实际的默认输出可能如下：

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

这是因为Jackson在处理List时，可能将列表中的每个元素视为其声明类型Animal，或者由于@JacksonXmlElementWrapper(useWrapping = false)导致元素直接以默认方式（例如，基于字段名或无名）进行序列化，而没有自动识别并使用子类的@JacksonXmlRootElement注解来生成特定的标签。

解决方案：实现自定义JsonSerializer

为了实现预期的多态元素标签，我们需要绕过Jackson的默认多态处理机制，通过自定义JsonSerializer来精确控制XML输出结构。

首先，修改Zoo类，通过@JsonSerialize注解指定一个自定义的序列化器：

import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement;

import java.util.ArrayList;
import java.util.List;

// Animal, Dog, Cat 类保持不变
abstract class Animal {}
class Dog extends Animal {}
class Cat extends Animal {}

@JsonSerialize(using = ZooSerializer.class) // 指定自定义序列化器
@JacksonXmlRootElement(localName = "Zoo")
public class Zoo {
  // @JacksonXmlProperty 和 @JacksonXmlElementWrapper 不再需要，因为由自定义序列化器处理
  List<Animal> animals = new ArrayList<>();
}

接下来，实现ZooSerializer：

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 {
        jg.writeStartObject(); // 对应 <Zoo> 的开始标签
        // 对于XML序列化，如果希望生成 <Dog/> 或 <Cat/> 这样的空标签，
        // 可以利用 writeNullField 方法，其参数会被用作标签名
        for (Animal animal : zoo.animals) {
            // 获取动物的简单类名作为XML标签名，例如 "Dog" 或 "Cat"
            jg.writeNullField(animal.getClass().getSimpleName());
        }
        jg.writeEndObject(); // 对应 </Zoo> 的结束标签
    }
}

在这个自定义序列化器中：

• serialize 方法接收Zoo对象、JsonGenerator和SerializerProvider。
• jg.writeStartObject()和jg.writeEndObject()用于包裹整个Zoo对象的XML内容，对应Zoo的根标签。
• 关键在于循环遍历zoo.animals列表。对于每个Animal对象，我们调用animal.getClass().getSimpleName()获取其具体的类名（如"Dog"或"Cat"），然后使用jg.writeNullField()方法。writeNullField通常用于写入一个字段名和null值，但在XML序列化上下文中，当与XmlMapper结合使用时，它会生成一个以该字段名作为标签的空元素，例如。

通过这种方式，当我们再次运行序列化代码时：

// 假设 Zoo, Animal, Dog, Cat, ZooSerializer 类已定义
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(); // 确保使用XmlMapper
  String xml = mapper.writerWithDefaultPrettyPrinter()
      .writeValueAsString(zoo);
  System.out.println(xml);
}

将得到预期的XML输出：

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

注意事项与权衡

虽然自定义JsonSerializer能够精确控制XML输出，但这种方法也带来了一些重要的权衡：

1. 失去Jackson内置的多态类型处理优势：

   • Jackson提供了@JsonTypeInfo和@JsonSubTypes等注解，用于在序列化时嵌入类型信息（例如，作为XML属性或子元素），并在反序列化时根据这些信息自动识别并实例化正确的子类。
   • 使用自定义序列化器意味着你放弃了这些自动化能力。Jackson将不再自动识别列表元素的具体类型并为其生成相应的根元素或类型属性。

2. 需要手动处理反序列化：

   • 由于序列化过程是完全自定义的，Jackson无法根据这种自定义的XML结构自动反序列化回原始的Java对象。
   • 如果需要将上述XML反序列化回Zoo对象，你将需要实现一个相应的自定义JsonDeserializer来解析和标签并正确地实例化Dog和Cat对象。这会增加额外的开发工作量和维护成本。

3. 适用场景：

   • 这种方法最适合于对XML输出格式有严格要求，且Jackson的默认多态处理无法满足的场景。
   • 如果应用中反序列化需求不复杂或可以接受手动解析，或者对性能要求极高，自定义序列化器可以提供更细粒度的控制。

总结

通过实现自定义JsonSerializer，我们可以精确控制Jackson XML序列化过程中多态列表元素的标签名称，使其与具体的子类名一致。这种方法虽然有效，但其代价是放弃了Jackson提供的自动化多态类型处理能力，并且在需要反序列化时，也必须手动实现自定义反序列化器。在选择此方案时，务必权衡其带来的灵活性与额外开发及维护成本。

以上就是《Jackson多态列表自定义设置教程》的详细内容，更多关于的资料请关注golang学习网公众号！