本文深入探讨了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类：
@Datapublic final class User implements Serializable { @JsonProperty("alias") private final String alias;}
由于alias字段是final的，Jackson无法在实例化User对象后再通过setter设置其值，因此会抛出反序列化异常。要解决这个问题，需要明确告诉Jackson如何通过构造函数来创建和初始化对象。
解决方案一：显式使用@JsonCreator注解
最直接且明确的解决方案是为带有final字段的类提供一个参数化构造函数，并使用@JsonCreator注解标记它，同时使用@JsonProperty注解指定构造函数参数与JSON属性的映射关系。
示例：
@Datapublic 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：
序列猴子开放平台
具有长序列、多模态、单模型、大数据等特点的超大规模语言模型
0 查看详情
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;@Configurationpublic 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类构造函数只有一个参数：
@Datapublic 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类：
@Datapublic 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字段时。
以上就是Jackson反序列化中@JsonCreator方法的使用时机与策略的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/244429.html
微信扫一扫 
支付宝扫一扫 
