Jackson反序列化:处理final字段与@JsonCreator的使用解析

jackson反序列化:处理final字段与@jsoncreator的使用解析

本文深入探讨了Jackson库在反序列化包含final字段的Java对象时可能遇到的MismatchedInputException。核心问题在于Jackson默认的反序列化机制依赖无参构造器和setter方法,这与final字段的“一次赋值”特性冲突。文章详细阐述了两种解决方案:显式使用@JsonCreator注解标记构造器,以及通过引入ParameterNamesModule模块自动化参数名解析,并特别指出单参数构造器在此模块下的特殊处理方式,确保JSON数据能够正确映射到不可变对象。

1. 理解Jackson反序列化与final字段的冲突

当使用Jackson库将JSON数据反序列化为Java对象时,其默认策略是首先通过无参构造器实例化对象,然后通过调用对应的setter方法来填充字段值。然而,对于被final关键字修饰的字段,它们只能在声明时或构造器中被赋值一次,之后便不可更改。这意味着Jackson无法通过setter方法为final字段赋值,因为它们在对象实例化后就已经被默认初始化(例如,对象类型为null,基本类型为0或false),并且不能被重新赋值。

考虑以下User类定义:

@Data // Lombok注解,自动生成getter/setter/equals/hashCode/toString等public final class User implements Serializable {    @JsonProperty("alias")    private final String alias; // final字段}

当Jackson尝试将JSON(例如{“alias”: “Smith”})反序列化为User对象时,如果没有显式指定构造器,就会出现MismatchedInputException,错误信息通常提示“Cannot construct instance… no delegate- or property-based Creator”。这是因为Jackson找不到一个合适的构造器来在对象创建时就为final字段alias赋值。

2. 解决方案一:使用@JsonCreator显式指定构造器

解决final字段反序列化问题的最直接方法是为Java类提供一个带参数的构造器,并使用@JsonCreator注解标记它。同时,构造器中的每个参数都应该使用@JsonProperty注解,以明确指定其对应的JSON字段名。

import com.fasterxml.jackson.annotation.JsonCreator;import com.fasterxml.jackson.annotation.JsonProperty;import lombok.Data; // 假设使用Lombok@Datapublic final class User implements Serializable {    @JsonProperty("alias")    private final String alias;    @JsonCreator // 标记此构造器为Jackson的反序列化入口    public User(@JsonProperty("alias") String alias){ // 使用@JsonProperty映射构造器参数        this.alias = alias;    }}

通过这种方式,Jackson在反序列化时会优先查找并使用被@JsonCreator标记的构造器,并将JSON中的相应字段值作为参数传递给构造器,从而在对象创建时就完成了final字段的初始化。

3. 解决方案二:引入ParameterNamesModule自动化参数名解析

手动为每个构造器参数添加@JsonProperty在参数较多时会显得冗余。Jackson提供了ParameterNamesModule模块,它能够利用Java 8及更高版本编译的字节码中包含的参数名信息,自动将JSON字段映射到构造器参数,从而减少显式注解的需求。

3.1 添加Maven依赖

首先,需要在项目的pom.xml中添加jackson-modules-java8依赖(其中包含了parameter-names模块):

    com.fasterxml.jackson.module    jackson-modules-java8    2.13.3 

3.2 配置ObjectMapper

在Spring Boot等框架中,可以通过注册一个ParameterNamesModule的Bean来配置全局的ObjectMapper:

import com.fasterxml.jackson.module.paramnames.ParameterNamesModule;import com.fasterxml.jackson.annotation.JsonCreator;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;@Configurationpublic class JacksonConfig {    @Bean    public ParameterNamesModule parameterNamesModule() {        // JsonCreator.Mode.PROPERTIES 模式指示参数从JSON对象的属性中绑定        return new ParameterNamesModule(JsonCreator.Mode.PROPERTIES);    }}

配置完成后,对于具有多个参数的构造器,Jackson将能够自动识别参数名并进行映射,无需在每个参数上添加@JsonProperty。例如:

@Datapublic final class Product implements Serializable {    private final String name;    private final Double price;    // 无需@JsonProperty注解参数,ParameterNamesModule会自动识别name和price    @JsonCreator    public Product(String name, Double price) {        this.name = name;        this.price = price;    }}

3.3 ParameterNamesModule的注意事项:单参数构造器

尽管ParameterNamesModule非常方便,但它有一个重要的限制:对于单参数构造器,即使启用了ParameterNamesModule,仍然需要显式地在构造器参数上使用@JsonProperty注解。

这是为了保持Jackson的向后兼容性。如果一个类只有一个带参数的构造器,并且只有一个参数,Jackson会将其视为一个“委托”构造器,尝试将整个JSON值(如果不是对象)绑定到该参数。为了明确告诉Jackson该参数应从JSON对象的属性中绑定,必须使用@JsonProperty。

因此,对于像User类这样只有一个final字段(即单参数构造器)的情况,即使引入了ParameterNamesModule,@JsonProperty(“alias”)仍然是必需的:

@Datapublic final class User implements Serializable {    @JsonProperty("alias")    private final String alias;    @JsonCreator    // 对于单参数构造器,即使有ParameterNamesModule,@JsonProperty仍是必需的    public User(@JsonProperty("alias") String alias){        this.alias = alias;    }}

4. 为什么Multiplication类在示例中没有报错?

在原始问题中,Multiplication类也包含final字段:

@Datapublic final class Multiplication implements Serializable {    @JsonProperty("factorA")    private final Integer factorA;    @JsonProperty("factorB")    private final Integer factorB;}

然而,在提供的测试代码片段中,Multiplication对象是通过Java代码直接实例化的 (new Multiplication(50,70)),而不是从JSON反序列化而来的。随后,这个Multiplication对象被包含在MultiplicationResultAttempt中,并最终被Jackson序列化为JSON (jsonResult.write(attempt).getJson()),发送到API端点。

因此,Multiplication类在测试场景中没有引发反序列化错误,是因为它根本没有经历Jackson的反序列化过程。如果Multiplication类也需要从外部JSON数据中反序列化,那么它将面临与User类相同的问题,并需要采用上述的@JsonCreator或ParameterNamesModule方案来正确处理其final字段。

总结

当Java类中包含final字段,且需要通过Jackson进行反序列化时,由于Jackson默认的无参构造器加setter机制无法处理final字段的“一次赋值”特性,会导致反序列化失败。解决此问题的核心在于为Jackson提供一个明确的、能够初始化final字段的构造器:

显式使用@JsonCreator:在带参数的构造器上添加@JsonCreator注解,并在每个构造器参数上添加@JsonProperty注解,这是最直接和通用的方法。引入ParameterNamesModule:对于Java 8+项目,可以通过引入ParameterNamesModule来自动化多参数构造器的参数名映射,减少@JsonProperty的冗余。但需注意,单参数构造器仍需在参数上显式使用@JsonProperty

选择哪种方法取决于项目的具体需求和团队偏好。对于简单的类或需要最大兼容性的场景,显式@JsonCreator是可靠的选择;而对于包含多个final字段且构造器参数较多的类,ParameterNamesModule能显著提高代码简洁性。理解Jackson的反序列化机制和final字段的特性,是编写健壮、可维护的Java应用程序的关键。

以上就是Jackson反序列化:处理final字段与@JsonCreator的使用解析的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/132666.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2025年11月29日 01:40:21
下一篇 2025年11月29日 02:03:25

相关推荐

  • CSS mask属性无法获取图片:为什么我的图片不见了?

    CSS mask属性无法获取图片 在使用CSS mask属性时,可能会遇到无法获取指定照片的情况。这个问题通常表现为: 网络面板中没有请求图片:尽管CSS代码中指定了图片地址,但网络面板中却找不到图片的请求记录。 问题原因: 此问题的可能原因是浏览器的兼容性问题。某些较旧版本的浏览器可能不支持CSS…

    2025年12月24日
    900
  • 为什么设置 `overflow: hidden` 会导致 `inline-block` 元素错位?

    overflow 导致 inline-block 元素错位解析 当多个 inline-block 元素并列排列时,可能会出现错位显示的问题。这通常是由于其中一个元素设置了 overflow 属性引起的。 问题现象 在不设置 overflow 属性时,元素按预期显示在同一水平线上: 不设置 overf…

    2025年12月24日 好文分享
    400
  • 网页使用本地字体:为什么 CSS 代码中明明指定了“荆南麦圆体”,页面却仍然显示“微软雅黑”?

    网页中使用本地字体 本文将解答如何将本地安装字体应用到网页中,避免使用 src 属性直接引入字体文件。 问题: 想要在网页上使用已安装的“荆南麦圆体”字体,但 css 代码中将其置于第一位的“font-family”属性,页面仍显示“微软雅黑”字体。 立即学习“前端免费学习笔记(深入)”; 答案: …

    2025年12月24日
    000
  • 为什么我的特定 DIV 在 Edge 浏览器中无法显示?

    特定 DIV 无法显示:用户代理样式表的困扰 当你在 Edge 浏览器中打开项目中的某个 div 时,却发现它无法正常显示,仔细检查样式后,发现是由用户代理样式表中的 display none 引起的。但你疑问的是,为什么会出现这样的样式表,而且只针对特定的 div? 背后的原因 用户代理样式表是由…

    2025年12月24日
    200
  • inline-block元素错位了,是为什么?

    inline-block元素错位背后的原因 inline-block元素是一种特殊类型的块级元素,它可以与其他元素行内排列。但是,在某些情况下,inline-block元素可能会出现错位显示的问题。 错位的原因 当inline-block元素设置了overflow:hidden属性时,它会影响元素的…

    2025年12月24日
    000
  • 为什么 CSS mask 属性未请求指定图片?

    解决 css mask 属性未请求图片的问题 在使用 css mask 属性时,指定了图片地址,但网络面板显示未请求获取该图片,这可能是由于浏览器兼容性问题造成的。 问题 如下代码所示: 立即学习“前端免费学习笔记(深入)”; icon [data-icon=”cloud”] { –icon-cl…

    2025年12月24日
    200
  • 为什么使用 inline-block 元素时会错位?

    inline-block 元素错位成因剖析 在使用 inline-block 元素时,可能会遇到它们错位显示的问题。如代码 demo 所示,当设置了 overflow 属性时,a 标签就会错位下沉,而未设置时却不会。 问题根源: overflow:hidden 属性影响了 inline-block …

    2025年12月24日
    000
  • 为什么我的 CSS 元素放大效果无法正常生效?

    css 设置元素放大效果的疑问解答 原提问者在尝试给元素添加 10em 字体大小和过渡效果后,未能在进入页面时看到放大效果。探究发现,原提问者将 CSS 代码直接写在页面中,导致放大效果无法触发。 解决办法如下: 将 CSS 样式写在一个单独的文件中,并使用 标签引入该样式文件。这个操作与原提问者观…

    2025年12月24日
    000
  • 为什么我的 em 和 transition 设置后元素没有放大?

    元素设置 em 和 transition 后不放大 一个 youtube 视频中展示了设置 em 和 transition 的元素在页面加载后会放大,但同样的代码在提问者电脑上没有达到预期效果。 可能原因: 问题在于 css 代码的位置。在视频中,css 被放置在单独的文件中并通过 link 标签引…

    2025年12月24日
    100
  • 为什么在父元素为inline或inline-block时,子元素设置width: 100%会出现不同的显示效果?

    width:100%在父元素为inline或inline-block下的显示问题 问题提出 当父元素为inline或inline-block时,内部元素设置width:100%会出现不同的显示效果。以代码为例: 测试内容 这是inline-block span 效果1:父元素为inline-bloc…

    2025年12月24日
    400
  • 深入理解CSS框架与JS之间的关系

    深入理解CSS框架与JS之间的关系 在现代web开发中,CSS框架和JavaScript (JS) 是两个常用的工具。CSS框架通过提供一系列样式和布局选项,可以帮助我们快速构建美观的网页。而JS则提供了一套功能强大的脚本语言,可以为网页添加交互和动态效果。本文将深入探讨CSS框架和JS之间的关系,…

    2025年12月24日
    000
  • HTML+CSS+JS实现雪花飘扬(代码分享)

    使用html+css+js如何实现下雪特效?下面本篇文章给大家分享一个html+css+js实现雪花飘扬的示例,希望对大家有所帮助。 很多南方的小伙伴可能没怎么见过或者从来没见过下雪,今天我给大家带来一个小Demo,模拟了下雪场景,首先让我们看一下运行效果 可以点击看看在线运行:http://hai…

    2025年12月24日 好文分享
    500
  • 10款好看且实用的文字动画特效,让你的页面更吸引人!

    图片和文字是网页不可缺少的组成部分,图片运用得当可以让网页变得生动,但普通的文字不行。那么就可以给文字添加一些样式,实现一下好看的文字效果,让页面变得更交互,更吸引人。下面创想鸟就来给大家分享10款文字动画特效,好看且实用,快来收藏吧! 1、网页玻璃文字动画特效 模板简介:使用css3制作网页渐变底…

    2025年12月24日 好文分享
    000
  • tp5如何引入css文件

    tp5引入css文件的方法:1、将css文件放在public目录下的static文件里即可;2、在页面引入中写上“”语句即可。 本教程操作环境:windows7系统、CSS3&&HTML5版、Dell G3电脑。 其实很简单,只需要将css,js,image文件放在这个目录下即可 页…

    2025年12月24日
    000
  • 聊聊CSS 与 JS 是如何阻塞 DOM 解析和渲染的

    本篇文章给大家介绍一下css和js阻塞 dom 解析和渲染的原理。有一定的参考价值,有需要的朋友可以参考一下,希望对大家有所帮助。 hello~各位亲爱的看官老爷们大家好。估计大家都听过,尽量将CSS放头部,JS放底部,这样可以提高页面的性能。然而,为什么呢?大家有考虑过么?很长一段时间,我都是知其…

    2025年12月24日
    200
  • js如何修改css样式

    js修改css样式的方法:1、使用【obj.className】来修改样式表的类名;2、使用【obj.style.cssTest】来修改嵌入式的css;3、使用【obj.className】来修改样式表的类名;4、使用更改外联的css。 本教程操作环境:windows7系统、css3版,DELL G…

    2025年12月24日
    000
  • 如何使用纯CSS、JS实现图片轮播效果

    本篇文章给大家详细介绍一下使用纯css、js实现图片轮播效果的方法。有一定的参考价值,有需要的朋友可以参考一下,希望对大家有所帮助。 .carousel {width: 648px;height: 400px;margin: 0 auto;text-align: center;position: a…

    2025年12月24日
    000
  • js如何修改css

    js修改css的方法:1、使用【obj.style.cssTest】来修改嵌入式的css;2、使用【bj.className】来修改样式表的类名;3、使用更改外联的css文件,从而改变元素的css。 本教程操作环境:windows7系统、css3版,DELL G3电脑。 js修改css的方法: 方法…

    2025年12月24日
    000
  • js如何改变css样式

    js改变css样式的方法:1、使用cssText方法;2、使用【setProperty()】方法;3、使用css属性对应的style属性。 本教程操作环境:windows7系统、css3版,DELL G3电脑。 js改变css样式的方法: 第一种:用cssText div.style.cssText…

    2025年12月24日
    000
  • 为什么css放上面js放下面

    css放上面js放下面的原因:1、在加载html生成DOM tree的时候,可以同时对DOM tree进行渲染,这样可以防止闪跳,白屏或者布局混乱;2、javascript加载后会立即执行,同时会阻塞后面的资源加载。 本文操作环境:Windows7系统、HTML5&&CSS3版,DE…

    2025年12月24日
    000

发表回复

登录后才能评论
关注微信