Jackson处理final字段与@JsonCreator使用技巧

怎么入门文章编程？需要学习哪些知识点？这是新手们刚接触编程时常见的问题；下面golang学习网就来给大家整理分享一些知识点，希望能够给初学者一些帮助。本篇文章就来介绍《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

@Data
public 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模块）：

<dependency>
    <groupId>com.fasterxml.jackson.module</groupId>
    <artifactId>jackson-modules-java8</artifactId>
    <version>2.13.3</version> <!-- 使用适合你Jackson版本的最新稳定版 -->
</dependency>

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;

@Configuration
public class JacksonConfig {

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

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

@Data
public 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")仍然是必需的：

@Data
public 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字段：

@Data
public 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字段的构造器：

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

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

以上就是本文的全部内容了，是否有顺利帮助你解决问题？若是能给你带来学习上的帮助，请大家多多支持golang学习网！更多关于文章的相关知识，也可关注golang学习网公众号。