在使用jackson库进行多态对象的yaml序列化时，可能会遇到输出中包含不必要的原生类型id标签（如`!
Jackson多态序列化中的类型标签问题
Jackson是一个功能强大的Java库，用于处理JSON、YAML等数据格式的序列化和反序列化。在处理多态（Polymorphism）类结构时，Jackson提供了@JsonTypeInfo和@JsonSubTypes等注解，允许开发者在序列化时嵌入类型信息，以便在反序列化时能够正确地实例化对应的子类。
通常，当我们将类型信息配置为作为对象的一个现有属性（include = JsonTypeInfo.As.EXISTING_PROPERTY）时，例如，在JSON输出中，类型信息会以一个普通的键值对形式存在，而不会引入额外的元数据标签。然而，在使用jackson-dataformat-yaml进行YAML序列化时，即使已经通过属性嵌入了类型信息，YAML输出中仍可能出现原生类型ID标签（如!
以下是一个示例代码，展示了在JSON和YAML序列化中这种差异：
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator;
import com.fasterxml.jackson.dataformat.yaml.YAMLMapper;
import com.google.common.collect.ImmutableList; // 假设引入了Guava
import lombok.Value; // 假设引入了Lombok
import java.util.List;
import static java.util.Objects.requireNonNull;
// 定义多态接口及其子类
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.EXISTING_PROPERTY, property = "type")
@JsonSubTypes({
@JsonSubTypes.Type(value = Car.class, name = "car"),
@JsonSubTypes.Type(value = Truck.class, name = "truck")
})
public interface Vehicle {
String getName();
}
@Value
public static class Car implements Vehicle {
String name;
String type = "car"; // 类型属性
@JsonCreator
public Car(@JsonProperty("name") final String name) {
this.name = requireNonNull(name);
}
}
@Value
public static class Truck implements Vehicle {
String name;
String type = "truck"; // 类型属性
@JsonCreator
public Truck(@JsonProperty("name") final String name) {
this.name = requireNonNull(name);
}
}
@Value
public static class Vehicles {
List vehicles;
@JsonCreator
public Vehicles(@JsonProperty("vehicles") final List vehicles) {
this.vehicles = requireNonNull(vehicles);
}
}
public class SerializationExample {
public static void main(String[] args) throws JsonProcessingException {
ObjectMapper jsonMapper = new ObjectMapper();
// 初始YAML Mapper配置，未禁用原生类型ID
ObjectMapper yamlMapper = YAMLMapper.builder()
.disable(YAMLGenerator.Feature.WRITE_DOC_START_MARKER)
.build();
final Vehicles vehicles = new Vehicles(ImmutableList.of(new Car("Dodge"), new Truck("Scania")));
System.out.println("--- JSON Output ---");
final String json = jsonMapper.writerWithDefaultPrettyPrinter().writeValueAsString(vehicles);
System.out.println(json);
System.out.println("\n--- YAML Output (Before Fix) ---");
final String yaml = yamlMapper.writerWithDefaultPrettyPrinter().writeValueAsString(vehicles);
System.out.println(yaml);
}
} 运行上述代码，您将观察到如下输出：
--- JSON Output ---
{
"vehicles" : [ {
"name" : "Dodge",
"type" : "car"
}, {
"name" : "Scania",
"type" : "truck"
} ]
}
--- YAML Output (Before Fix) ---
vehicles:
- !
name: "Dodge"
type: "car"
- !
name: "Scania"
type: "truck" 可以看到，JSON输出非常简洁，类型信息作为"type"属性存在。然而，YAML输出中却额外出现了!
解决方案：禁用YAML原生类型ID功能
要解决YAML输出中多余的原生类型ID标签问题，我们需要显式地禁用YAMLGenerator.Feature.USE_NATIVE_TYPE_ID这一Jackson特性。
YAMLGenerator.Feature.USE_NATIVE_TYPE_ID是jackson-dataformat-yaml的一个配置项，它控制是否在YAML输出中生成原生类型标签来表示Java对象的类型。默认情况下，这个特性是开启的，导致了!
核心的修改在于YAMLMapper的构建过程：
import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator;
import com.fasterxml.jackson.dataformat.yaml.YAMLMapper;
import com.fasterxml.jackson.databind.ObjectMapper;
// ... (其他类定义保持不变)
public class SerializationExampleFixed {
public static void main(String[] args) throws JsonProcessingException {
ObjectMapper jsonMapper = new ObjectMapper();
// 关键修改：禁用YAMLGenerator.Feature.USE_NATIVE_TYPE_ID
ObjectMapper yamlMapper = YAMLMapper.builder()
.disable(YAMLGenerator.Feature.WRITE_DOC_START_MARKER) // 可选：禁用文档起始标记
.disable(YAMLGenerator.Feature.USE_NATIVE_TYPE_ID) // 关键：禁用原生类型ID
.build();
final Vehicles vehicles = new Vehicles(ImmutableList.of(new Car("Dodge"), new Truck("Scania")));
System.out.println("--- JSON Output ---");
final String json = jsonMapper.writerWithDefaultPrettyPrinter().writeValueAsString(vehicles);
System.out.println(json);
System.out.println("\n--- YAML Output (After Fix) ---");
final String yaml = yamlMapper.writerWithDefaultPrettyPrinter().writeValueAsString(vehicles);
System.out.println(yaml);
}
}完整示例与验证
应用上述修改后，再次运行程序，您将得到以下YAML输出：
--- JSON Output ---
{
"vehicles" : [ {
"name" : "Dodge",
"type" : "car"
}, {
"name" : "Scania",
"type" : "truck"
} ]
}
--- YAML Output (After Fix) ---
vehicles:
- name: "Dodge"
type: "car"
- name: "Scania"
type: "truck"此时，YAML输出中不再包含!
注意事项
-
适用场景： 禁用YAMLGenerator.Feature.USE_NATIVE_TYPE_ID主要适用于以下情况：
- 您已经通过@JsonTypeInfo配置将类型信息作为对象的一个属性（例如type字段）嵌入。
- 您希望YAML输出尽可能简洁，不包含Jackson特定的元数据标签。
- 您对YAML文件的预期使用者不依赖于这些原生类型标签进行类型识别。
原生类型ID的潜在用途： 在某些特定场景下，USE_NATIVE_TYPE_ID可能是有用的。例如，如果您的多态配置没有通过属性嵌入类型信息（如JsonTypeInfo.As.WRAPPER_OBJECT或As.WRAPPER_ARRAY），或者您希望YAML文件本身携带更明确的Java类型信息（例如，用于跨语言或非Jackson解析器，或者在没有其他类型提示的情况下），那么保留此特性可能更有利。
反序列化影响： 禁用此特性通常不会影响Jackson反序列化时的类型识别。只要您的@JsonTypeInfo配置（特别是use和property属性）正确无误，Jackson在反序列化时仍然能够根据嵌入的type属性（例如"car"或"truck"）正确地将YAML解析为对应的Java子类实例。
其他YAML特性： YAMLGenerator.Feature提供了许多其他配置选项，例如WRITE_DOC_START_MARKER（控制YAML文档开头的---标记），您可以根据具体需求组合使用这些特性来定制YAML的生成行为。
总结
通过在构建YAMLMapper时禁用YAMLGenerator.Feature.USE_NATIVE_TYPE_ID，我们可以有效地解决Jackson在YAML序列化多态对象时生成冗余原生类型ID标签的问题。这一方法使得YAML输出更加简洁、可读，并与JSON输出在类型表示上保持一致，从而提升了数据格式的统一性和开发体验。在实际应用中，开发者应根据具体需求和预期的数据消费者来决定是否禁用此特性。
