0

0

Jackson反序列化中@JsonCreator方法的使用时机与策略

霞舞

霞舞

发布时间:2025-07-14 12:44:37

|

1057人浏览过

|

来源于php中文网

原创

jackson反序列化中@jsoncreator方法的使用时机与策略

本文深入探讨了Jackson库在处理带有final字段的Java对象时,何时需要@JsonCreator注解以及如何解决反序列化失败的问题。文章详细介绍了通过显式使用@JsonCreator和引入ParameterNamesModule两种核心解决方案,并阐述了它们各自的适用场景、配置方法及注意事项,旨在帮助开发者理解并有效处理Jackson反序列化中的创建者模式。

理解Jackson的反序列化机制与final字段的冲突

当使用Jackson库进行JSON到Java对象的反序列化时,其默认机制通常是首先调用类的无参构造函数实例化对象,然后通过字段的setter方法或直接访问字段来填充数据。然而,这种默认机制在遇到带有final修饰符的字段时会失效。

final字段的特性是它们只能被赋值一次,通常在声明时、实例初始化块中或构造函数中完成。一旦赋值,就不能再次修改。Jackson的默认反序列化流程试图在对象实例化后通过setter(或直接字段注入)来设置这些final字段,这与final的特性相悖,从而导致MismatchedInputException,错误信息通常会提示“Cannot construct instance of ... (no delegate- or property-based Creator)”。

例如,对于以下User类:

@Data
public final class User implements Serializable {
    @JsonProperty("alias")
    private final String alias;
}

由于alias字段是final的,Jackson无法在实例化User对象后再通过setter设置其值,因此会抛出反序列化异常。要解决这个问题,需要明确告诉Jackson如何通过构造函数来创建和初始化对象。

解决方案一:显式使用@JsonCreator注解

最直接且明确的解决方案是为带有final字段的类提供一个参数化构造函数,并使用@JsonCreator注解标记它,同时使用@JsonProperty注解指定构造函数参数与JSON属性的映射关系。

示例:

@Data
public final class User implements Serializable {
    @JsonProperty("alias")
    private final String alias;

    @JsonCreator
    public User(@JsonProperty("alias") String alias){
        this.alias = alias;
    }
}

在这个例子中:

  • @JsonCreator注解告诉Jackson,在反序列化时应该使用这个特定的构造函数来创建User实例。
  • @JsonProperty("alias")注解在构造函数的参数alias上,确保Jackson能够将JSON中名为alias的属性值正确地绑定到这个构造函数参数上。

这种方法清晰明了,适用于所有情况,包括单参数和多参数构造函数。

解决方案二:利用Jackson的ParameterNamesModule

另一种更灵活的解决方案是利用Jackson的ParameterNamesModule。这个模块允许Jackson在Java 8及更高版本中,通过JVM的参数名称发现功能(需要编译时开启-parameters选项),自动推断构造函数参数的名称,从而无需在每个参数上显式添加@JsonProperty注解。

1. 添加依赖

首先,需要在项目的pom.xml(Maven)或build.gradle(Gradle)中添加jackson-modules-java8依赖,它包含了ParameterNamesModule:

英特尔AI工具
英特尔AI工具

英特尔AI与机器学习解决方案

下载

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

2. 配置ObjectMapper

接下来,需要将ParameterNamesModule注册到Jackson的ObjectMapper实例中。在Spring Boot应用中,可以通过将ParameterNamesModule声明为一个Spring Bean来自动配置ObjectMapper:

import com.fasterxml.jackson.module.paramnames.ParameterNamesModule;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class JacksonConfig {

    @Bean
    public ParameterNamesModule parameterNamesModule() {
        // JsonCreator.Mode.PROPERTIES 模式表示参数将从JSON对象的属性中绑定
        return new ParameterNamesModule(JsonCreator.Mode.PROPERTIES);
    }
}

通过这种配置,Jackson在反序列化时,如果发现类有参数化构造函数,并且字段是final的,它会尝试使用该构造函数,并根据参数名(通过ParameterNamesModule获取)匹配JSON属性。

ParameterNamesModule的注意事项与单参数构造函数的特殊性

尽管ParameterNamesModule非常方便,但它有一个重要的“陷阱”:对于只有一个参数的构造函数,即使启用了ParameterNamesModule,其参数仍需要显式地使用@JsonProperty注解。这是为了保持与旧版本Jackson行为的兼容性。

引用官方文档的解释:

  • JsonCreator.Mode.PROPERTIES模式通常用于多参数构造函数,其参数将从传入JSON对象的匹配属性中绑定。
  • 对于单参数构造函数,这种模式是模糊的。为了保持遗留行为,如果类有一个单参数构造函数,其参数仍然需要使用@JsonProperty("propertyName")进行注解。

这意味着,如果你的User类构造函数只有一个参数:

@Data
public final class User implements Serializable {
    @JsonProperty("alias")
    private final String alias;

    // 即使配置了ParameterNamesModule,这个单参数构造函数也需要@JsonProperty
    public User(String alias){ // 错误示范,缺少@JsonProperty
        this.alias = alias;
    }
    // 正确示范:
    @JsonCreator // 可选,但明确更好
    public User(@JsonProperty("alias") String alias){
        this.alias = alias;
    }
}

而对于多参数构造函数,例如Multiplication类:

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

    // 假设存在以下构造函数,且ParameterNamesModule已配置
    public Multiplication(Integer factorA, Integer factorB) {
        this.factorA = factorA;
        this.factorB = factorB;
    }
}

如果Multiplication类具有如上所示的多参数构造函数,并且ParameterNamesModule已正确配置且项目编译时开启了-parameters选项,那么Jackson在反序列化时可以自动识别并使用这个构造函数,而无需在factorA和factorB参数上显式添加@JsonProperty(当然,添加了也不会有问题)。这解释了为什么在某些情况下,带有final字段的多参数对象可能无需@JsonCreator也能成功反序列化。

总结与最佳实践

  • 核心原则:当Java对象包含final字段时,Jackson无法使用默认的无参构造函数加setter机制进行反序列化。此时,必须通过构造函数来初始化这些final字段。
  • 显式@JsonCreator:最直接、最通用的解决方案。在参数化构造函数上添加@JsonCreator,并在每个参数上添加@JsonProperty。这种方法清晰且兼容性最好,适用于所有Java版本和所有构造函数参数数量。
  • ParameterNamesModule:在Java 8及更高版本中,如果项目编译时开启了-parameters选项,并且构造函数参数数量大于一,ParameterNamesModule可以简化代码,避免在每个构造函数参数上重复添加@JsonProperty。但请务必记住单参数构造函数的特殊性,它们仍然需要@JsonProperty。
  • 选择建议
    • 对于简单场景或需要明确控制反序列化过程时,使用@JsonCreator和@JsonProperty是稳妥的选择。
    • 对于大量DTO(数据传输对象)且希望减少注解冗余时,可以考虑引入ParameterNamesModule,但要留意其对单参数构造函数的限制。
    • 确保你的Java项目在编译时启用了-parameters选项,否则ParameterNamesModule将无法获取参数名称。

理解这些机制有助于开发者更有效地使用Jackson进行JSON处理,尤其是在构建不可变对象或使用Lombok的@Data配合final字段时。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

116

2025.08.06

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

37

2026.01.26

spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

135

2023.09.05

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

390

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

70

2025.08.19

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

35

2025.12.22

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

180

2025.12.24

json数据格式
json数据格式

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

420

2023.08.07

C++ 设计模式与软件架构
C++ 设计模式与软件架构

本专题深入讲解 C++ 中的常见设计模式与架构优化,包括单例模式、工厂模式、观察者模式、策略模式、命令模式等,结合实际案例展示如何在 C++ 项目中应用这些模式提升代码可维护性与扩展性。通过案例分析,帮助开发者掌握 如何运用设计模式构建高质量的软件架构,提升系统的灵活性与可扩展性。

14

2026.01.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Django 教程
Django 教程

共28课时 | 3.7万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.3万人学习

Sass 教程
Sass 教程

共14课时 | 0.8万人学习

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

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