Jackson的序列化及反序列化【@JsonValue及@JsonCreator注解】

2024-04-14 15:18

本文主要是介绍Jackson的序列化及反序列化【@JsonValue及@JsonCreator注解】,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

Jackson的序列化

@JsonValue注解

@JsonValue 可以用在get方法或者属性字段上,一个类只能用一个,当加上@JsonValue注解时,序列化时只返回这一个字段的值,而不是这个类的属性键值对。

Teacher.class

package org.zpli.springdemo.bean;import com.fasterxml.jackson.annotation.JsonValue;
import lombok.Getter;
import lombok.Setter;/*** created at 2021/6/3 3:38 下午** @author somnuszpli*/
@Setter
@Getter
public class Teacher {// @JsonValueString name;int age;String address;}

测试方法:

@Test
public void test2() throws JsonProcessingException {ObjectMapper mapper = new ObjectMapper();Teacher teacher = new Teacher();teacher.setName("somnuszpli");teacher.setAge(24);teacher.setAddress("China");String teacherStr = mapper.writeValueAsString(teacher);System.out.println(teacherStr);
}

输出结果:

{"name":"somnuszpli","age":24,"address":"China"}

在Teacher类的name属性上添加@JsonValue 注解

package org.zpli.springdemo.bean;import com.fasterxml.jackson.annotation.JsonValue;
import lombok.Getter;
import lombok.Setter;/*** created at 2021/6/3 3:38 下午** @author somnuszpli*/
@Setter
@Getter
public class Teacher {@JsonValueString name;int age;String address;}

运行测试方法,输出结果为:

"somnuszpli"

Jackson的反序列化

一、Jackson反序列化过程做了什么?

对于Jackson的JSON数据格式,反序列化过程就是将JSON字符串反序列化为java 对象

ObjectMapper mapper = new ObjectMapper();//将JSON字符串反序列化为java对象
String jsonInString = "{\"name\":\"乔丹\",\"age\":45,\"hobbies\":[\"高尔夫球\",\"棒球\"]}";
PlayerStar jordan = mapper.readValue(jsonInString, PlayerStar.class);System.out.println(jordan);

默认情况下,Jackson在反序列化过程中调用了哪些函数,给大家介绍一下

  • 首先调用反序列化的目标类PlayerStar的无参构造函数,构造一个java对象
  • 然后调用该类的成员变量的set方法,为该对象的每一个成员变量赋值。

所以默认情况下,一个Java类使用Jackson做反序列化,必须有public无参构造函数(java中不写也默认有),必须有成员变量的set方法。

二、@JsonCreator注解

默认情况下,Jackson的反序列化过程是上面描述的那样,默认选择类的无参构造函数创建类对象并使用setter方法给属性赋值,当没有无参构造函数时会报错。除此之外,我们还可以使用@JsonCreator注解自定义反序列化的过程,在我们自定义的反序列化函数里面,我们有更强的灵活性,可以完成更多的非规定动作。使用@JsonCreator注解的参数前面需要加上@JsonProperty,否则会报错。一共有两种自定义反序列化渠道:

  • @JsonCreator注解加在构造方法上
  • @JsonCreator注解加在工厂静态方法上

使用了@JsonCreator注解之后,将使用该注解标注的方法进行反序列化对象的构造,默认的使用无参构造函数及set方法进行反序列化的过程失效。

2.1.@JsonCreator注解加在构造方法上

该PlayerStar对应的JSON字符串是第一小节中的jsonInString。下文的构造函数,你希望将哪些属性值赋值给java 对象的成员变量,你就使用@JsonProperty("salary")去定义它。

package org.zpli.springdemo.bean;import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.math.BigDecimal;
import java.util.Arrays;
import java.util.List;
import java.util.Map;/*** created at 2021/6/3 3:14 下午** @author somnuszpli*/
public class PlayerStar {private String name;private Integer age;private String[] hobbies;               // 业余爱好,数组private List<String> friends;           // 朋友private Map<String, BigDecimal> salary; // 年收入 Map//这段是我们的核心代码,使用JsonCreator注解说明该方法是反序列化构造方法。@JsonCreatorpublic PlayerStar(@JsonProperty("name") String name,@JsonProperty("age") Integer age,@JsonProperty("hobbies") String[] hobbies,@JsonProperty("friends") List<String> friends,@JsonProperty("salary") Map<String, BigDecimal> salary) {this.name = name;this.age = age;this.hobbies = hobbies;this.friends = friends;this.salary = salary;}@Overridepublic String toString() {return "PlayerStar{" +"name='" + name + '\'' +", age=" + age +", hobbies=" + Arrays.toString(hobbies) +", friends=" + friends +", salary=" + salary +'}';}
}

我们使用第一小节中的反序列化代码,将jsonInString反序列化构造PlayerStar对象,控制台输出结果如下(对象的toString()方法输出):

PlayerStar{name='乔丹', age=45, hobbies=[高尔夫球, 棒球], friends=null, salary=null}

@JsonCreator标注的构造方法里面下断点,也的确证明在java 对象反序列化构造的过程中使用的是该方法。

2.2.@JsonCreator注解加在工厂静态方法上

除了可以将@JsonCreator加在构造方法上,还可以使用静态工厂函数反序列化构造java对象。使用方法如下:

package org.zpli.springdemo.bean;import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.math.BigDecimal;
import java.util.Arrays;
import java.util.List;
import java.util.Map;/*** created at 2021/6/3 3:14 下午** @author somnuszpli*/
public class PlayerStar {private String name;private Integer age;private String[] hobbies;               // 业余爱好,数组private List<String> friends;           // 朋友private Map<String, BigDecimal> salary; // 年收入 Map@JsonCreatorpublic static PlayerStar createPlayer(@JsonProperty("name") String name,@JsonProperty("age") Integer age,@JsonProperty("hobbies") String[] hobbies,@JsonProperty("friends") List<String> friends,@JsonProperty("salary") Map<String, BigDecimal> salary) {PlayerStar player = new PlayerStar();  //new 一个java对象player.name = name;    //赋值player.age = age;player.hobbies = hobbies;player.friends = friends;player.salary = salary;return player;}@Overridepublic String toString() {return "PlayerStar{" +"name='" + name + '\'' +", age=" + age +", hobbies=" + Arrays.toString(hobbies) +", friends=" + friends +", salary=" + salary +'}';}
}

使用@JsonCreator注解加在工厂静态方法上,可以达到一样的反序列化效果。

三、@ConstructorProperties注解

@ConstructorProperties注解的作用和@JsonCreator注解起到的作用是一致的,但是它只能加在构造方法上,作为反序列化函数。但是它的语法更简洁,使用起来也更加方便,不用@JsonProperty注解。又提供了灵活性,我们可以在构造方法反序列化过程中,针对该对象做更多的非规定操作。

package org.zpli.springdemo.bean;import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.beans.ConstructorProperties;
import java.math.BigDecimal;
import java.util.Arrays;
import java.util.List;
import java.util.Map;/*** created at 2021/6/3 3:14 下午** @author somnuszpli*/
public class PlayerStar {private String name;private Integer age;private String[] hobbies;               // 业余爱好,数组private List<String> friends;           // 朋友private Map<String, BigDecimal> salary; // 年收入 Map@ConstructorProperties({"name", "age","hobbies", "friends","salary"})public PlayerStar(String name,Integer age,String[] hobbies,List<String> friends,Map<String, BigDecimal> salary) {this.name = name;this.age = age;this.hobbies = hobbies;this.friends = friends;this.salary = salary;}@Overridepublic String toString() {return "PlayerStar{" +"name='" + name + '\'' +", age=" + age +", hobbies=" + Arrays.toString(hobbies) +", friends=" + friends +", salary=" + salary +'}';}
}

使用@ConstructorProperties注解加在构造方法上,可以达到一样的反序列化效果。

这篇关于Jackson的序列化及反序列化【@JsonValue及@JsonCreator注解】的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/903324

相关文章

使用Jackson进行JSON生成与解析的新手指南

《使用Jackson进行JSON生成与解析的新手指南》这篇文章主要为大家详细介绍了如何使用Jackson进行JSON生成与解析处理,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1. 核心依赖2. 基础用法2.1 对象转 jsON(序列化)2.2 JSON 转对象(反序列化)3.

SpringCloud动态配置注解@RefreshScope与@Component的深度解析

《SpringCloud动态配置注解@RefreshScope与@Component的深度解析》在现代微服务架构中,动态配置管理是一个关键需求,本文将为大家介绍SpringCloud中相关的注解@Re... 目录引言1. @RefreshScope 的作用与原理1.1 什么是 @RefreshScope1.

Spring事务中@Transactional注解不生效的原因分析与解决

《Spring事务中@Transactional注解不生效的原因分析与解决》在Spring框架中,@Transactional注解是管理数据库事务的核心方式,本文将深入分析事务自调用的底层原理,解释为... 目录1. 引言2. 事务自调用问题重现2.1 示例代码2.2 问题现象3. 为什么事务自调用会失效3

Django序列化中SerializerMethodField的使用详解

《Django序列化中SerializerMethodField的使用详解》:本文主要介绍Django序列化中SerializerMethodField的使用,具有很好的参考价值,希望对大家有所帮... 目录SerializerMethodField的基本概念使用SerializerMethodField的

Java常用注解扩展对比举例详解

《Java常用注解扩展对比举例详解》:本文主要介绍Java常用注解扩展对比的相关资料,提供了丰富的代码示例,并总结了最佳实践建议,帮助开发者更好地理解和应用这些注解,需要的朋友可以参考下... 目录一、@Controller 与 @RestController 对比二、使用 @Data 与 不使用 @Dat

基于@RequestParam注解之Spring MVC参数绑定的利器

《基于@RequestParam注解之SpringMVC参数绑定的利器》:本文主要介绍基于@RequestParam注解之SpringMVC参数绑定的利器,具有很好的参考价值,希望对大家有所帮助... 目录@RequestParam注解:Spring MVC参数绑定的利器什么是@RequestParam?@

Jackson库进行JSON 序列化时遇到了无限递归(Infinite Recursion)的问题及解决方案

《Jackson库进行JSON序列化时遇到了无限递归(InfiniteRecursion)的问题及解决方案》使用Jackson库进行JSON序列化时遇到了无限递归(InfiniteRecursi... 目录解决方案‌1. 使用 @jsonIgnore 忽略一个方向的引用2. 使用 @JsonManagedR

Spring Security注解方式权限控制过程

《SpringSecurity注解方式权限控制过程》:本文主要介绍SpringSecurity注解方式权限控制过程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、摘要二、实现步骤2.1 在配置类中添加权限注解的支持2.2 创建Controller类2.3 Us

Java中使用注解校验手机号格式的详细指南

《Java中使用注解校验手机号格式的详细指南》在现代的Web应用开发中,数据校验是一个非常重要的环节,本文将详细介绍如何在Java中使用注解对手机号格式进行校验,感兴趣的小伙伴可以了解下... 目录1. 引言2. 数据校验的重要性3. Java中的数据校验框架4. 使用注解校验手机号格式4.1 @NotBl

SpringBoot自定义注解如何解决公共字段填充问题

《SpringBoot自定义注解如何解决公共字段填充问题》本文介绍了在系统开发中,如何使用AOP切面编程实现公共字段自动填充的功能,从而简化代码,通过自定义注解和切面类,可以统一处理创建时间和修改时间... 目录1.1 问题分析1.2 实现思路1.3 代码开发1.3.1 步骤一1.3.2 步骤二1.3.3