0

0

Jackson 序列化时 __type 字段为 null 的原因与解决方案

花韻仙語

花韻仙語

发布时间:2026-03-08 09:26:02

|

125人浏览过

|

来源于php中文网

原创

Jackson 序列化时 __type 字段为 null 的原因与解决方案

当使用 @JsonTypeInfo(include = EXISTING_PROPERTY) 时,Jackson 不会自动填充类型标识字段(如 __type),而是依赖该字段在运行时已显式赋值;若未手动设置,序列化结果中该字段即为 null。

当使用 `@jsontypeinfo(include = existing_property)` 时,jackson 不会自动填充类型标识字段(如 `__type`),而是依赖该字段在运行时已显式赋值;若未手动设置,序列化结果中该字段即为 `null`。

在基于 OpenAPI 生成的 Java 模型中,若采用 @JsonTypeInfo(include = JsonTypeInfo.As.EXISTING_PROPERTY, property = "__type") 实现多态序列化,开发者常误以为 Jackson 会在序列化时自动注入子类型名称(如 "ConcreteRequest")到 __type 字段。但事实并非如此:EXISTING_PROPERTY 模式要求该字段必须由业务代码显式初始化并维护,Jackson 仅负责读取其当前值用于类型识别,不会自动写入

核心机制说明

  • include = EXISTING_PROPERTY 表示:序列化时将 __type 字段作为普通属性输出(值来自 getter),反序列化时则根据该字段值选择具体子类。
  • 它与 include = WRAPPER_OBJECT 或 WRAPPER_ARRAY 的“自动包装”行为完全不同——后者由 Jackson 完全托管类型信息,而 EXISTING_PROPERTY 将控制权交还给开发者。

因此,若 ConcreteRequest 构造后未调用 setType("ConcreteRequest"),其继承自 BaseRequest 的 type 字段保持默认 null,最终导致 JSON 中 "__type": null。

正确实践:在子类构造器中显式设置类型标识

public class ConcreteRequest extends BaseRequest {
    public ConcreteRequest() {
        // ✅ 关键修复:显式设置 type 字段,确保序列化时非 null
        setType("ConcreteRequest");
    }

    // 其余字段和方法保持不变...
    private SoapTradeInput soapTradeInput;

    public ConcreteRequest soapTradeInput(SoapTradeInput soapTradeInput) {
        this.soapTradeInput = soapTradeInput;
        return this;
    }

    @JsonProperty("soapTradeInput")
    public SoapTradeInput getSoapTradeInput() {
        return soapTradeInput;
    }

    public void setSoapTradeInput(SoapTradeInput soapTradeInput) {
        this.soapTradeInput = soapTradeInput;
    }
}

? 提示:若存在多个子类(如 AnotherRequest, ThirdRequest),每个子类构造器均需设置对应 setType("...") 值,且该值必须与 @JsonSubTypes.Type(name = "...") 中声明的 name 完全一致(区分大小写)。

补充建议与注意事项

  • 避免 setter 覆盖风险:若业务逻辑中可能多次调用 setType(...),建议在构造器中设为 final 或添加校验(例如 Objects.requireNonNull(type, "type cannot be null") 在 getter 中)。

    LogoAi
    LogoAi

    利用AI来设计你喜欢的Logo和品牌标志

    下载
  • 兼容 Builder 模式:若使用 Lombok @Builder 或自定义 Builder,需确保 type 字段被正确初始化:

    @Builder(builderMethodName = "concreteBuilder")
    public ConcreteRequest() {
        setType("ConcreteRequest");
    }
  • 验证序列化结果

    ObjectMapper mapper = new ObjectMapper();
    mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
    // ... 其他配置保持不变
    
    ConcreteRequest req = new ConcreteRequest()
        .businessDate(LocalDate.of(2024, 1, 1))
        .soapTradeInput(new SoapTradeInput());
    
    String json = mapper.writeValueAsString(req);
    System.out.println(json);
    // ✅ 正确输出应包含: "__type":"ConcreteRequest"
  • 替代方案考量:若希望完全免除手动维护 __type,可改用 include = JsonTypeInfo.As.PROPERTY(默认行为),此时 Jackson 会将类型信息作为独立属性注入(不复用业务字段),但需接受字段名与业务语义解耦。

总之,EXISTING_PROPERTY 是一种“契约式”多态策略——它赋予你对类型字段的完全控制权,但也要求你承担初始化责任。理解这一设计意图,是避免 __type: null 问题的根本前提。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

453

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

546

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

331

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

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

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

252

2023.09.22

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

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

1049

2024.03.01

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

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

27

2025.11.27

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

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

27

2025.11.27

JavaScript浏览器渲染机制与前端性能优化实践
JavaScript浏览器渲染机制与前端性能优化实践

本专题围绕 JavaScript 在浏览器中的执行与渲染机制展开,系统讲解 DOM 构建、CSSOM 解析、重排与重绘原理,以及关键渲染路径优化方法。内容涵盖事件循环机制、异步任务调度、资源加载优化、代码拆分与懒加载等性能优化策略。通过真实前端项目案例,帮助开发者理解浏览器底层工作原理,并掌握提升网页加载速度与交互体验的实用技巧。

23

2026.03.06

热门下载

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

精品课程

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

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