首页 > Java > java教程 > 正文

Jackson YAML序列化:如何移除多态对象的原生类型标签

霞舞
发布: 2025-11-27 17:01:04
原创
812人浏览过

Jackson YAML序列化:如何移除多态对象的原生类型标签

在使用jackson进行多态对象的yaml序列化时,即使已配置`@jsontypeinfo`通过现有属性识别类型,yaml输出仍可能默认包含如`!`这样的原生类型标签。本文将深入探讨这一现象的成因,并提供通过禁用`yamlgenerator.feature.use_native_type_id`特性来移除这些标签的专业教程,确保yaml输出与json保持一致的简洁性。

引言:Jackson多态序列化与YAML类型标签问题

Jackson库在Java应用中广泛用于JSON和YAML数据的序列化与反序列化。对于包含多态类型的对象,例如一个接口Vehicle及其实现类Car和Truck,我们通常会使用@JsonTypeInfo注解来指导Jackson如何识别和处理这些子类型。当配置@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.EXISTING_PROPERTY, property = "type")时,我们期望Jackson通过对象中已存在的type属性来区分不同的子类型,并在序列化时避免额外添加类型元数据。

对于JSON序列化,这种配置通常能达到预期效果,输出的JSON中不会包含任何额外的类元信息。然而,在使用jackson-dataformat-yaml进行YAML序列化时,即使采用了相同的多态配置,我们可能会发现YAML输出中依然存在类似!<car>或!<truck>的原生类型标签。这些标签在某些场景下可能是不必要的,甚至会影响YAML的可读性和与其他系统的兼容性。

问题复现示例

为了更清晰地说明这一问题,我们来看一个具体的代码示例。假设我们有Vehicle接口和Car、Truck两个实现类,以及一个包含Vehicle列表的Vehicles容器类。

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 java.util.Arrays;
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") })
interface Vehicle {
    String getName();
}

// Car 实现类
class Car implements Vehicle {
    String name;
    String type = "car"; // 类型标识属性

    @JsonCreator
    public Car(@JsonProperty("name") final String name) {
        this.name = requireNonNull(name);
    }

    @Override
    public String getName() {
        return name;
    }

    public String getType() {
        return type;
    }
}

// Truck 实现类
class Truck implements Vehicle {
    String name;
    String type = "truck"; // 类型标识属性

    @JsonCreator
    public Truck(@JsonProperty("name") final String name) {
        this.name = requireNonNull(name);
    }

    @Override
    public String getName() {
        return name;
    }

    public String getType() {
        return type;
    }
}

// 包含Vehicle列表的容器类
class Vehicles {
    List<Vehicle> vehicles;

    @JsonCreator
    public Vehicles(@JsonProperty("vehicles") final List<Vehicle> vehicles) {
        this.vehicles = requireNonNull(vehicles);
    }

    public List<Vehicle> getVehicles() {
        return vehicles;
    }
}

public class YamlTagRemovalDemo {
    public static void main(String[] args) throws JsonProcessingException {
        // 标准JSON ObjectMapper
        ObjectMapper JSON_MAPPER = new ObjectMapper();

        // YAML ObjectMapper,默认配置
        ObjectMapper YAML_MAPPER_DEFAULT = YAMLMapper.builder()
            .disable(YAMLGenerator.Feature.WRITE_DOC_START_MARKER) // 禁用文档开始标记
            .build();

        final Vehicles vehicles = new Vehicles(Arrays.asList(new Car("Dodge"), new Truck("Scania")));

        System.out.println("--- JSON Output ---");
        final String json = JSON_MAPPER.writerWithDefaultPrettyPrinter().writeValueAsString(vehicles);
        System.out.println(json);

        System.out.println("\n--- YAML Output (Default) ---");
        final String yamlDefault = YAML_MAPPER_DEFAULT.writerWithDefaultPrettyPrinter().writeValueAsString(vehicles);
        System.out.println(yamlDefault);
    }
}
登录后复制

运行上述代码,我们将得到如下输出:

JSON Output:

{
  "vehicles" : [ {
    "name" : "Dodge",
    "type" : "car"
  }, {
    "name" : "Scania",
    "type" : "truck"
  } ]
}
登录后复制

YAML Output (Default):

vehicles:
- !<car>
  name: "Dodge"
  type: "car"
- !<truck>
  name: "Scania"
  type: "truck"
登录后复制

从输出可以看出,JSON完美地移除了类型元数据,仅保留了name和type属性。然而,YAML输出中依然存在!<car>和!<truck>这样的标签,这正是我们希望解决的问题。

解决方案:禁用YAMLGenerator.Feature.USE_NATIVE_TYPE_ID

Jackson jackson-dataformat-yaml库在处理多态类型时,默认会启用YAMLGenerator.Feature.USE_NATIVE_TYPE_ID特性。这个特性指示YAMLMapper在序列化时,利用YAML的原生标签(!符号后跟类型名)来标记对象的实际类型,即使已经通过@JsonTypeInfo指定了其他类型识别方式。这在某些场景下可能是有用的,例如,当没有显式的类型属性或需要更严格的类型声明时。

STORYD
STORYD

帮你写出让领导满意的精美文稿

STORYD 164
查看详情 STORYD

要解决YAML输出中多余类型标签的问题,我们只需在构建YAMLMapper时禁用此特性即可。

修改main方法中的YAML_MAPPER构建部分:

public class YamlTagRemovalDemo {
    public static void main(String[] args) throws JsonProcessingException {
        // ... (其他代码不变)

        // YAML ObjectMapper,禁用原生类型ID特性
        ObjectMapper YAML_MAPPER_FIXED = YAMLMapper.builder()
            .disable(YAMLGenerator.Feature.WRITE_DOC_START_MARKER) // 禁用文档开始标记
            .disable(YAMLGenerator.Feature.USE_NATIVE_TYPE_ID) // 禁用原生类型ID
            .build();

        final Vehicles vehicles = new Vehicles(Arrays.asList(new Car("Dodge"), new Truck("Scania")));

        // ... (JSON 输出不变)

        System.out.println("\n--- YAML Output (Fixed) ---");
        final String yamlFixed = YAML_MAPPER_FIXED.writerWithDefaultPrettyPrinter().writeValueAsString(vehicles);
        System.out.println(yamlFixed);
    }
}
登录后复制

重新运行代码,现在“YAML Output (Fixed)”部分将产生我们期望的输出:

YAML Output (Fixed):

vehicles:
- name: "Dodge"
  type: "car"
- name: "Scania"
  type: "truck"
登录后复制

可以看到,!<car>和!<truck>标签已经被成功移除,YAML输出变得更加简洁,与JSON输出在类型元数据方面保持了一致。

注意事项与总结

  1. 特性作用: YAMLGenerator.Feature.USE_NATIVE_TYPE_ID是一个专门针对YAML格式的特性,它控制Jackson是否在序列化时使用YAML的原生类型标签来标记多态对象。默认情况下,此特性是启用的。
  2. 适用场景: 如果你的应用中已经通过@JsonTypeInfo注解明确指定了类型识别方式(例如,通过一个现有属性type),并且不希望YAML输出中出现冗余的原生类型标签,那么禁用USE_NATIVE_TYPE_ID是正确的选择。
  3. 潜在影响: 在某些复杂的多态场景下,或者当没有明确的类型属性来区分子类型时,原生类型标签可能提供了额外的类型信息,有助于反序列化。在禁用此特性之前,请确保你的类型识别机制(如@JsonTypeInfo)能够完全满足反序列化的需求。
  4. YAML版本: YAML 1.1规范中定义了隐式和显式标签。!<type>属于显式标签的一种。禁用此特性意味着我们依赖Jackson在反序列化时通过其他方式(例如@JsonTypeInfo配置)来推断类型,而不是依赖YAML标签本身。

通过本文的教程,我们了解了Jackson在YAML序列化多态对象时出现原生类型标签的原因,并掌握了通过禁用YAMLGenerator.Feature.USE_NATIVE_TYPE_ID特性来解决这一问题的具体方法。这使得我们能够更好地控制YAML输出的格式,使其满足特定的简洁性和兼容性要求。

以上就是Jackson YAML序列化:如何移除多态对象的原生类型标签的详细内容,更多请关注php中文网其它相关文章!

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

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