首页
/ Jackson-databind 2.18版本中@JsonUnwrapped与多态类的兼容性问题分析

Jackson-databind 2.18版本中@JsonUnwrapped与多态类的兼容性问题分析

2025-06-20 19:28:53作者:乔或婵

问题背景

在Jackson-databind 2.18版本升级后,开发者遇到了一个关于@JsonUnwrapped注解在多态类中使用的兼容性问题。具体表现为,在2.17.3版本中能够正常工作的代码,在升级到2.18版本后出现了"Unrecognized field"的错误。

问题复现

让我们先来看一个典型的代码示例:

@JsonTypeInfo(use = Id.NAME, include = As.PROPERTY, property = "name")
@JsonSubTypes({
    @Type(value = SubA.class, name = "A"),
})
interface Parent {}

static class SubA implements Parent {
    @JsonUnwrapped
    @JsonProperty(access = READ_ONLY)
    private Model model;

    @JsonCreator
    public SubA(@JsonProperty("model") Model model) {
        this.model = model;
    }
}

static class Model {
    @JsonProperty
    private double x;
}

在2.17.3版本中,这段代码可以正常解析JSON数据,但在2.18版本中会抛出"Unrecognized field"异常。

问题根源

经过Jackson开发团队的深入分析,发现这个问题源于2.18版本对@JsonCreator处理逻辑的改进。在2.17版本中,处理存在一定的不严谨性,而2.18版本修正了这种行为:

  1. 在2.17版本中,@JsonCreator被错误地识别为委托模式(DELEGATING),而实际上由于使用了@JsonProperty注解,它应该被识别为属性模式(PROPERTIES)。

  2. 2.18版本正确地识别了这种场景,导致原本依赖错误行为的代码无法正常工作。

解决方案

针对这个问题,Jackson开发团队提供了几种解决方案:

方案一:将@JsonUnwrapped移到构造器参数上

static class SubA implements Parent {
    private Model model;
    
    @JsonCreator
    public SubA(@JsonUnwrapped Model model) {
        this.model = model;
    }
}

这是最推荐的解决方案,因为它更符合Jackson的设计意图。

方案二:显式指定@JsonCreator模式

static class SubA implements Parent {
    @JsonUnwrapped
    @JsonProperty(access = READ_ONLY)
    private Model model;

    @JsonCreator(mode = JsonCreator.Mode.DELEGATING)
    public SubA(@JsonProperty("model") Model model) {
        this.model = model;
    }
}

这种方式通过显式声明DELEGATING模式来保持与2.17版本相同的行为。

方案三:使用无参构造器

static class SubA implements Parent {
    @JsonUnwrapped
    private Model model;

    public SubA() { }
}

这种方式依赖于Jackson通过反射设置字段值的能力。

技术建议

  1. 注解使用规范@JsonUnwrapped通常应该用于构造器参数或setter方法,而不是字段上。这样可以更明确地表达开发者的意图。

  2. 版本升级注意事项:在升级Jackson版本时,特别是涉及到注解处理逻辑的变化时,应该充分测试涉及多态类型和特殊注解组合的代码。

  3. 模式选择:当使用@JsonCreator时,应该根据实际情况明确指定模式(PROPERTIES或DELEGATING),避免依赖框架的默认行为。

总结

这个问题展示了Jackson在版本迭代中对注解处理逻辑的改进。虽然这种改进可能导致一些现有代码需要调整,但它带来了更一致和可预测的行为。开发者应该遵循框架的最佳实践,明确表达自己的意图,而不是依赖框架的隐式行为。

对于正在从2.17迁移到2.18的用户,建议审查所有使用@JsonUnwrapped@JsonCreator组合的代码,并根据上述建议进行调整。这样可以确保代码在新版本中的稳定性和可维护性。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8