Jackson反序列化不可变类

简介: Jackson 默认的反序列化策略需要无参构造器和字段 setter 函数。对于不可变类(如 `ImmutableUser`),可以通过以下三种方式解决:1. **使用 Jackson 注解**:在全参构造器上使用 `@JsonCreator` 和 `@JsonProperty` 注解。2. **使用 jackson-module-parameter-names**:引入依赖并注册 `ParameterNamesModule` 模块。3. **使用 Mixins 机制**:创建一个 Mixin 类,使用 `@JsonCreator` 和 `@JsonProperty` 注解

Jackson默认的反序列化策略需要无参构造器,并提供字段setter函数。

如下ImmutableUser类属性都被final修饰,只有全参构造器,没有setter方法,它的实例一经创建就不可变。如何使用Jackson反序列化它呢?

java

代码解读

复制代码

public class ImmutableUser {

  private final String name;
  private final int age;
  private final String identityCard;

  public ImmutableUser(String name, int age, String identityCard) {
    this.name = name;
    this.age = age;
    this.identityCard = identityCard;
  }

  public String getName() {
    return name;
  }

  public int getAge() {
    return age;
  }

  public String getIdentityCard() {
    return identityCard;
  }
}

或许你会写下这样的代码,结果发现一执行就报错了:no Creators, like default constructor, exist.

java

代码解读

复制代码

@Test
public void readImmutableUser() throws JsonProcessingException {
  String userJson = "{"name":"Tom","age":23,"identityCard":"61012420000101012x"}";
  ObjectMapper mapper = new ObjectMapper();
  ImmutableUser user = mapper.readValue(userJson, ImmutableUser.class);
  System.out.println(MAPPER.writeValueAsString(user));
}

com.fasterxml.jackson.databind.exc.InvalidDefinitionException: Cannot construct instance of com.learn.more.entiry.ImmutableUser (no Creators, like default constructor, exist): ......

一 使用Jackson注解

可以使用@JsonProperty更改反序列化策略。

java

代码解读

复制代码

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;

// 与ImmutableUser的区别:使用@JsonProperty、@JsonCreator修饰全参构造器
public class ImmutableUser2 {

  private final String name;
  private final int age;
  private final String identityCard;

  @JsonCreator
  public ImmutableUser2(@JsonProperty("name") String name,
  @JsonProperty("age") int age, @JsonProperty("identityCard") String identityCard) {
    this.name = name;
    this.age = age;
    this.identityCard = identityCard;
  }

  public String getName() {
    return name;
  }

  public int getAge() {
    return age;
  }

  public String getIdentityCard() {
    return identityCard;
  }
}

还是上面的测试代码,这次发现执行成功了。 需注意,@JsonProperty的value必须填写,且最好与Json串中字段名一致。否则将导致下面的异常。

com.fasterxml.jackson.databind.exc.InvalidDefinitionException: Invalid type definition for type com.learn.more.entiry.ImmutableUser2: ..., annotations: ... has no property name (and is not Injectable): can not use as property-based Creator

二 使用jackson-module-parameter-names

如果ImmutableUser类来自jar包,我们无法修改源码来添加@JsonProperty、@JsonCreator注解。又该如何处理呢?

由官方维护的jackson-module-parameter-namesModule,正好可以实现无侵入的反序列化不可变类。引入依赖:

xml

代码解读

复制代码

 <dependency>
      <groupId>com.fasterxml.jackson.module</groupId>
      <artifactId>jackson-module-parameter-names</artifactId>
      <version>${jackson.version}</version>
</dependency>

向ObjectMapper注册ParameterNamesModule,就可以执行成功了。

java

代码解读

复制代码

@Test
public void readImmutableUser() throws JsonProcessingException {
  String userJson = "{"name":"Tom","age":23,"identityCard":"61012420000101012x"}";
  ObjectMapper mapper = new ObjectMapper();
  mapper.registerModule(new ParameterNamesModule());
  ImmutableUser user = mapper.readValue(userJson, ImmutableUser.class);
  System.out.println(MAPPER.writeValueAsString(user));
}

三 使用Mixins机制

Jackson提供了mixins 机制,支持外挂式的序列化/反序列化策略声明,从而避免对源数据结构的侵入性改变。我们反序列化第三方的不可变类时,可以使用该机制:

创建ImmutableUserMixin类,具有与ImmutableUser相似的构造器参数,使用 @JsonProperty声明了参数对应的json字段。

java

代码解读

复制代码

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;

public class ImmutableUserMixin {

  @JsonCreator
  public ImmutableUserMixin(@JsonProperty("name") String name,
  @JsonProperty("age") int age, @JsonProperty("identityCard") String identityCard) {

  }
}

再创建一个自定义的JacksonMixinModule类,将ImmutableUser与ImmutableUserMixin对应关系,设置到SetupContext

java

代码解读

复制代码

import com.fasterxml.jackson.databind.module.SimpleModule;
import com.learn.more.entiry.ImmutableUser;
import com.learn.more.entiry.ImmutableUserMixin;

public class JacksonMixinModule extends SimpleModule {

  public JacksonMixinModule() {
    super(JacksonMixinModule.class.getName());
  }

  // 注册所有使用Mixin机制的类
  @Override
  public void setupModule(SetupContext context) {
    context.setMixInAnnotations(ImmutableUser.class, ImmutableUserMixin.class);
    // ......
  }
}

向ObjectMapper注册JacksonMixinModule类。那么,在反序列化ImmutableUser时,将依据ImmutableUserMixin的构造器声明来绑定属性值。

java

代码解读

复制代码

@Test
public void readImmutableUserMixin() throws JsonProcessingException {
  String userJson = "{"name":"Tom","age":23,"identityCard":"61012420000101012x"}";
  ObjectMapper mapper = new ObjectMapper();
  mapper.registerModule(new JacksonMixinModule());
  ImmutableUser user = mapper.readValue(userJson, ImmutableUser.class);
  System.out.println(MAPPER.writeValueAsString(user));
}

可以成功反序列化



相关文章
|
12月前
|
安全 Java 编译器
Java泛型是什么?
本文回顾了作者五年的工作经历,强调了自我学习的重要性,并介绍了Java泛型的基础知识,包括泛型的概念、泛型集合、泛型方法、泛型接口、泛型类及类型擦除等内容,旨在帮助读者理解泛型机制及其在编程中的应用。
134 2
Java泛型是什么?
|
缓存 安全 Java
Spring Get请求 与post请求
本文详细介绍了Spring框架中GET请求和POST请求的区别及应用场景。GET请求用于从服务器获取资源,参数附在URL末尾,适合查看非敏感信息;POST请求用于向服务器提交数据,参数在请求体中传输,适合处理敏感信息。Spring通过`@GetMapping`和`@PostMapping`注解分别处理这两种请求。此外,文章还提供了示例代码,展示了如何在Spring中实现这两种请求的处理。最后,文章总结了推荐使用POST请求的原因,包括更高的安全性、更大的数据传输量、更好的幂等性及灵活性。
440 1
Spring Get请求 与post请求
|
2月前
|
人工智能 JavaScript 前端开发
理解 JavaScript 中的节流和防抖:实现 `throttle` 和 `debounce` 函数
节流(throttle)是指在一定时间间隔内只执行一次函数,常用于控制高频事件触发频率,如滚动、窗口调整等。本文介绍其实现原理与代码示例。
|
3月前
|
人工智能 安全 Go
go快速上手:golang中的反射
本文深入解析Go语言反射机制,涵盖reflect包的核心类型与操作方法,通过实例演示如何动态获取类型信息、修改值及调用方法,并探讨反射的高级用法与注意事项,帮助开发者合理高效地使用反射。
118 1
|
3月前
|
存储 人工智能 Java
java之通过Http下载文件
本文介绍了使用Java实现通过文件链接下载文件到本地的方法,主要涉及URL、HttpURLConnection及输入输出流的操作。
179 0
|
11月前
|
前端开发 安全 Java
springboot解决跨域问题
跨域问题指前端调用与后端接口不在同一域名或端口时产生的安全限制。本文介绍两种在Spring Boot中解决跨域问题的方法:一是通过配置CorsFilter,二是实现WebMvcConfigurer接口。配置完成后重启项目即可生效。作者:博笙困了。来源:稀土掘金。
288 6
|
11月前
|
算法 大数据 Go
Go文件操作:掌握Go的文件读写与操作技巧
本文介绍了Go语言的文件操作功能,包括文件的打开、读写和关闭。Go语言通过`os`和`io`包提供了丰富的文件操作接口,使开发者能够轻松实现文件的读写和管理。文章详细讲解了核心概念、具体操作步骤和代码示例,并探讨了实际应用场景和未来发展趋势。
164 4
|
算法 安全 测试技术
golang 栈数据结构的实现和应用
本文详细介绍了“栈”这一数据结构的特点,并用Golang实现栈。栈是一种FILO(First In Last Out,即先进后出或后进先出)的数据结构。文章展示了如何用slice和链表来实现栈,并通过golang benchmark测试了二者的性能差异。此外,还提供了几个使用栈结构解决的实际算法问题示例,如有效的括号匹配等。
237 1
golang 栈数据结构的实现和应用
|
11月前
|
SQL Rust Java
Java 8 异步编程利器:CompletableFuture
Java 8引入了CompletableFuture,这是一个强大的异步编程工具,增强了Future的功能,支持链式调用、任务组合与异常处理等特性,使异步编程更加直观和高效。本文详细介绍了CompletableFuture的基本概念、用法及高级功能,帮助开发者更好地掌握这一工具。
182 0
|
8月前
|
Java Spring
SpringBoot 实战 不同参数调用不同实现
本文介绍了如何在实际工作中根据不同的入参调用不同的实现,采用`map+enum`的方式实现优雅且严谨的解决方案。通过Spring Boot框架中的工厂模式或策略模式,避免了使用冗长的`if...else...`语句。文中详细展示了定义接口、实现类、枚举类以及控制器调用的代码示例,确保用户输入的合法性并简化了代码逻辑。
205 1
SpringBoot 实战 不同参数调用不同实现