Jackson反序列化：@JsonCreator用法与替代方案

本文深入解析了在使用Jackson库反序列化Java对象时，特别是当类包含final字段且缺少无参构造函数时所面临的挑战。针对Jackson默认反序列化机制失效的问题，详细介绍了两种解决方案。首选方案是使用`@JsonCreator`注解显式指定用于反序列化的构造函数，并配合`@JsonProperty`注解进行JSON字段与构造函数参数的映射。另一种方案是利用`ParameterNamesModule`模块实现参数名自动推断，从而简化多参数构造函数的处理。但需注意，`ParameterNamesModule`在处理单参数构造函数时仍需`@JsonProperty`注解。文章强调了在选择方案时需考虑项目具体需求，并提醒开发者确保编译时保留参数名信息，以保证基于构造函数反序列化的顺利进行。

1. Jackson默认反序列化机制与final字段的冲突

Jackson作为流行的JSON处理库，其默认的反序列化机制通常依赖于以下两个步骤：

1. 实例化对象： 调用类的无参构造函数（或默认构造函数）来创建对象实例。
2. 属性赋值： 通过对应的setter方法或直接访问字段来设置JSON数据中匹配的属性值。

然而，当类中包含final修饰的字段时，这种机制便会失效。final字段一旦初始化便不可再赋值。如果一个类只提供了带参数的构造函数（例如，Lombok的@Data注解在所有字段都是final时，会生成一个包含所有final字段的构造函数），并且没有无参构造函数，那么Jackson将无法通过其默认机制实例化对象并设置final字段，因为这些字段必须在构造函数中进行初始化。

考虑以下User类：

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

当尝试反序列化包含alias字段的JSON字符串时，由于alias是final的，Jackson无法在创建对象后再通过setter赋值。因此，会抛出MismatchedInputException，提示“Cannot construct instance... no delegate- or property-based Creator”。

2. 解决方案一：使用@JsonCreator显式指定构造函数

解决final字段反序列化问题的最直接方法是使用@JsonCreator注解。此注解明确告诉Jackson，在反序列化时应使用哪个构造函数来创建对象实例。同时，为了让Jackson正确地将JSON字段映射到构造函数的参数，每个构造函数参数都需要使用@JsonProperty注解来指定其对应的JSON字段名。

以下是修改后的User类示例：

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

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

通过添加@JsonCreator注解到带参数的构造函数，并为参数alias加上@JsonProperty("alias")，Jackson就能识别并使用此构造函数来完成反序列化。

3. 解决方案二：利用ParameterNamesModule实现参数名推断

除了显式使用@JsonCreator外，Jackson还提供了ParameterNamesModule模块，它能够利用Java 8及更高版本提供的参数名信息（如果编译时保留了这些信息，例如使用-parameters编译选项），自动将JSON属性名映射到构造函数参数。这在处理多参数构造函数时尤为方便，可以减少@JsonProperty注解的使用。

步骤 1: 添加Maven依赖

首先，需要在项目的pom.xml中添加jackson-modules-java8依赖：

    com.fasterxml.jackson.module
    jackson-modules-java8
    2.13.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() {
        return new ParameterNamesModule(JsonCreator.Mode.PROPERTIES);
    }
}

通过这种配置，Jackson在反序列化时会尝试使用构造函数的参数名来匹配JSON属性。

注意事项与特殊情况：单参数构造函数

尽管ParameterNamesModule在多参数构造函数中表现出色，但对于单参数构造函数，它有一个重要的限制：

如果类含有一个单参数构造函数，其参数仍然需要使用@JsonProperty("propertyName")进行注解。这是为了保持与旧版Jackson行为的兼容性。

这意味着，即使配置了ParameterNamesModule，对于像User类（只有一个alias字段，对应一个单参数构造函数）这样的情况，你仍然需要为构造函数参数添加@JsonProperty注解。

例如，如果User类只有一个final字段alias，即使引入了ParameterNamesModule，其构造函数仍需如下定义：

// 即使配置了ParameterNamesModule，对于单参数构造函数，仍需JsonProperty
@JsonCreator
public User(@JsonProperty("alias") String alias){
    this.alias = alias;
}

然而，对于像Multiplication这样包含多个final字段的类：

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

如果其对应的构造函数是public Multiplication(Integer factorA, Integer factorB)，那么在配置了ParameterNamesModule的情况下，Jackson通常能够自动识别factorA和factorB这两个参数，而无需在构造函数上使用@JsonCreator或在参数上使用@JsonProperty（前提是编译时保留了参数名信息）。这解释了为什么在某些情况下，即使类包含final字段，Multiplication对象也能正常反序列化，而User对象却需要额外的注解。

4. 总结与最佳实践

在处理Java对象与JSON之间的反序列化时，尤其是当类中包含final字段且没有无参构造函数时，理解Jackson的工作原理至关重要。

• 默认机制限制： Jackson默认通过无参构造函数和setter方法进行反序列化，这不适用于final字段。
• @JsonCreator： 这是最直接且明确的解决方案，通过在构造函数上添加@JsonCreator并配合参数上的@JsonProperty，显式告知Jackson如何构建对象。它适用于所有情况，包括单参数和多参数构造函数。
• ParameterNamesModule： 作为一种更自动化的方法，它能利用Java 8的参数名信息，在多参数构造函数场景下减少@JsonProperty的使用。但请记住其对单参数构造函数的特殊要求，即参数仍需@JsonProperty注解。

选择哪种方法取决于项目的具体需求和偏好。如果追求明确性和控制，@JsonCreator是可靠的选择。如果希望减少冗余注解并利用Java 8特性，ParameterNamesModule则是一个很好的补充，但需注意其在单参数构造函数上的限制。无论选择哪种，确保编译时保留了参数名信息（通常通过Maven或Gradle配置-parameters编译器选项）是成功实现基于构造函数反序列化的关键。

今天关于《Jackson反序列化：@JsonCreator用法与替代方案》的内容介绍就到此结束，如果有什么疑问或者建议，可以在golang学习网公众号下多多回复交流；文中若有不正之处，也希望回复留言以告知！