日志

JSON数据处理框架Jackson精解第一篇-序列化与反序列化核心用法

 来源    2020-09-17    1  


Jackson是Spring Boot默认的JSON数据处理框架,但是其并不依赖于任何的Spring 库。有的小伙伴以为Jackson只能在Spring框架内使用,其实不是的,没有这种限制。它提供了很多的JSON数据处理方法、注解,也包括流式API、树模型、数据绑定,以及复杂数据类型转换等功能。它虽然简单易用,但绝对不是小玩具,本节为大家介绍Jackson的基础核心用法,更多的内容我会写成一个系列,5-10篇文章,请您继续关注我。

一、基础准备

在任意项目中引入下面的jar就可以使用jackson进行JSON的数据序列化与反序列化的功能。

<dependency>
	<groupId>com.fasterxml.jackson.core</groupId>
	<artifactId>jackson-databind</artifactId>
	<version>2.9.8</version>
</dependency>

写一个PlayerStar的实体类,实体类主要体现篮球明星的名字、年龄、业余爱好、朋友、年收入等信息,为了尽可能地演示Jackson的序列化与反序列化功能,将数组、List、Map都融合到这个类里面。并通过getInstance初始化篮球明星Jordan这个对象。

@Data
public class PlayerStar {

  private String name;
  private Integer age;
  private String[] hobbies;    //业余爱好,数组
  private List<String> friends;   //  朋友
  private Map<String, BigDecimal> salary; //年收入 Map


  //初始化一个对象用于测试
  public static PlayerStar getInstance(){
    PlayerStar playerStar = new PlayerStar();

    playerStar.setName("乔丹");
    playerStar.setAge(45);
    playerStar.setHobbies(new String[]{"高尔夫球", "棒球"});
    Map<String, BigDecimal> salary = new HashMap<String, BigDecimal>() {{
      put("2000", new BigDecimal(10000000));
      put("2010", new BigDecimal(62000000));
      put("2020", new BigDecimal(112400000));
    }};
    playerStar.setSalary(salary);
    playerStar.setFriends(Arrays.asList("kobe", "curry", "james"));

    return playerStar;
  }

}

二、序列化方法

下面代码演示了如何将PlayerStar对象序列化为JSON字符串。

  • writeValue可以接收File作为参数,将JSON序列化结果保存到文件中
  • writeValueAsString将JSON序列化结果以String形式返回
  • writerWithDefaultPrettyPrinter方法可以将JSON序列化结果进行格式化,更好的显示结构,易于查看
@Test
void testObject2JSON() throws IOException {
  //获取对象实例
  PlayerStar player = PlayerStar.getInstance();

  //ObjectMapper作为Jackson的API工具类存在
  ObjectMapper mapper = new ObjectMapper();
  //将player对象以JSON格式进行序列化,并将序列化结果写入文件
  mapper.writeValue(new File("d:\\data\\jackson\\player.json"), player);

  //将player对象以JSON格式进行序列化为String对象
  String jsonString = mapper.writeValueAsString(player);
  System.out.println(jsonString);

  //将player对象以JSON格式进行序列化为String对象(格式美化)
  String jsonInString2 = mapper.writerWithDefaultPrettyPrinter()
          .writeValueAsString(player);
  System.out.println(jsonInString2);
}

jsonString的控制台打印输出结果,也是d:\data\jackson\player.json文件的内容

{"name":"乔丹","age":45,"hobbies":["高尔夫球","棒球"],"friends":["kobe","curry","james"],"salary":{"2000":10000000,"2010":62000000,"2020":112400000}}

jsonString2的控制台打印输出,格式进行了美化,因为使用了writerWithDefaultPrettyPrinter()方法

{
  "name" : "乔丹",
  "age" : 45,
  "hobbies" : [ "高尔夫球", "棒球" ],
  "friends" : [ "kobe", "curry", "james" ],
  "salary" : {
    "2000" : 10000000,
    "2010" : 62000000,
    "2020" : 112400000
  }
}

三、反序列化方法

下面代码演示了如何将JSON字符串反序列化为Java对象

@Test
void testJSON2Object() throws IOException {
  ObjectMapper mapper = new ObjectMapper();
  //从文件中读取JSON字符串,反序列化为java对象
  PlayerStar player = mapper.readValue(new File("d:\\data\\jackson\\player.json"), PlayerStar.class);
  System.out.println(player);

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

  System.out.println(jordan);

}

PlayerStar对象控制台输出结果如下(注意这里的输出不是JSON格式,而是java对象的toString()方法值):

PlayerStar(name=乔丹, age=45, hobbies=[高尔夫球, 棒球], friends=[kobe, curry, james], salary={2000=10000000, 2010=62000000, 2020=112400000})
PlayerStar(name=乔丹, age=45, hobbies=[高尔夫球, 棒球], friends=null, salary=null)

四、字段重命名@JsonProperty

可以使用 @JsonProperty来影响序列化和反序列化对象属性的重命名。

@Data
public class PlayerStar {

  @JsonProperty("playerName")
  private String name;  //将属性name序列化为playerName,同时影响反序列化

使用上面代码的注解之后,JSON序列化的结果name属性变成playerName属性

{"playerName":"乔丹"  ……

同时影响反序列化,下面的反序列化代码会报错,因为使用了name属性。应该使用playerName才可以。

String jsonInString = "{\"name\":\"乔丹\",\"age\":45,\"hobbies\":[\"高尔夫球\",\"棒球\"]}";
PlayerStar jordan = mapper.readValue(jsonInString, PlayerStar.class);

五、忽略null字段的序列化@JsonInclude

当我们不为对象的成员变量赋值的时候,默认情况下,Jackson的序列化结果是下面的这样的。

{
  "age" : 45,
  "hobbies" : null,
  "friends" : null,
  "salary" : null,
  "playerName" : "乔丹"
}

如果我们不希望将null值,体现在JSON序列化结果中,我们可以使用下面的方法。如果希望在某次序列化的全局范围内,忽略null成员变量,可以使用下面的API

ObjectMapper mapper = new ObjectMapper();
mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

或者是在类名的上面加上如下注解。该注解将针对类里面的所有成员变量生效,只要成员变量为null,将不会被包含在序列化结果中。

@JsonInclude(JsonInclude.Include.NON_NULL)
public class PlayerStar {
   ......
}

如果我们想针对PlayerStar类里面某些成员变量单独忽略null,可以在成员变量上面加注解。

@JsonInclude(JsonInclude.Include.NON_NULL)
private String[] hobbies;    //业余爱好,数组
@JsonInclude(JsonInclude.Include.NON_NULL)
private List<String> friends;   //  朋友
@JsonInclude(JsonInclude.Include.NON_NULL)
private Map<String, BigDecimal> salary; //年收入 Map

忽略为null的成员变量后,JSON序列化结果是下面这样的

{
  "age" : 45,
  "playerName" : "乔丹"
}

六、忽略指定的字段

默认情况下,jackson不会将static和transient的成员变量进行序列化与反序列化操作。我们还可以通过

  • @JsonIgnore加在类成员变量上面,该成员变量将被排除在序列化和反序列化的过程之外
  • @JsonIgnoreProperties加在类声明上面,指定该类里面哪些字段被排除在序列化和反序列化的过程之外

上面的两种注解选其一即可,下面的代码两种注解我都用了,功能是重复的

@Data
@JsonIgnoreProperties({"hobbies", "friends","salary"})
public class PlayerStar {

  @JsonProperty("playerName")
  private String name;
  private Integer age;

  @JsonIgnore
  private String[] hobbies;    //业余爱好,数组
  @JsonIgnore
  private List<String> friends;   //  朋友
  @JsonIgnore
  private Map<String, BigDecimal> salary; //年收入 Map

......

在类或成员变量上面加上注解之后,序列化结果如下,指定字段被忽略。

{
  "age" : 45,
  "playerName" : "乔丹"
}

需要注意的是这两个注解不只是影响序列化为JSON字符串的过程,也影响JSON字符串反序列化为java对象的过程。举例:如果JSON字符串包含了类中被JsonIgnore的属性值hobbies,不会被反序列化赋值给java对象的成员变量hobbies。

欢迎关注我的博客,里面有很多精品合集

  • 本文转载注明出处(必须带连接,不能只转文字):字母哥博客

觉得对您有帮助的话,帮我点赞、分享!您的支持是我不竭的创作动力! 。另外,笔者最近一段时间输出了如下的精品内容,期待您的关注。

相关文章
JSON提供程序jackson使用布尔类型进行序列化和反序列化问题
问答我使用带有JSON对象的布尔包装器时遇到问题,当为布尔值创建JSON对象时,它包含字符串cotes,例如"isUrgent":"1"现在问题是我必须每次为每个请 ...
1
python接口自动化(十九)--Json 数据处理---实战(详解)
日志简介 上一篇说了关于json数据处理,是为了断言方便,这篇就带各位小伙伴实战一下.首先捋一下思路,然后根据思路一步一步的去实现和实战,不要一开始就盲目的动手和无头苍蝇一样到处乱撞,撞得头破血流后而放弃 ...
2
Java中JNI的使用详解第一篇:HelloWorld
日志今天开始研究JNI技术,首先还是老套路,输出一个HelloWorld:具体流程如下:在Java中定义一个方法,在C++中实现这个方法,在方法内部输出“Hello World",然后再回到Ja ...
1
drf框架serializers中ModelSerializer类简化序列化和反序列化操作
日志0905自我总结 drf框架serializers中ModelSerializer类 基于seriallizer类进行简化 https://www.cnblogs.com/pythonywy/p/11 ...
1
Java IO详解(六)------序列化与反序列化(对象流)
日志File 类的介绍:https://www.cnblogs.com/ysocean/p/6851878.html Java IO 流的分类介绍:https://www.cnblogs.com/ysoc ...
1
c# Json 自定义类作为字典键时,序列化和反序列化的处理方法
日志一般情况下,Newtonsoft.Json.dll 对Dictionary<int,object>.Dictionary<string,object>等序列化与反序列化都是成功 ...
1
Django框架深入了解_02(DRF之序列化、反序列化)
日志序列化:将Python对象准换成json格式的字符串,反之即为反序列化 DRF的序列化使用过程: 使用drf的序列化组件 -1 新建一个序列化类继承Serializer -2 在类中写要序列化的字段 ...
python接口自动化(十七)--Json 数据处理---一次爬坑记(详解)
日志简介 有些 post 的请求参数是 json 格式的,这个前面发送post 请求里面提到过,需要导入 json模块处理.现在企业公司一般常见的接口因为json数据容易处理,所以绝大多数返回数据也是 j ...
1
SSH框架之Spring第一篇
日志1.1. spring概述: 1.1.1 spring介绍 : Spring是分层的Java SE/EE应用 full-stack轻量级开源框架,以IoC(Inverse Of Control : 反 ...
1
SSH框架之Struts2第一篇
日志1.2 Struts2的概述 : Struts2是一个基于MVC设计模式的WEB层的框架. 1.2.1 常见web层框架 Struts1,Struts2,WebWork,SpringMVC Strut ...
1
SSH框架之Hibernate第一篇
日志1.2Hibernate的概述: 1.2.1 什么Hibernate? Hibernate(开发源代码的对象关系映射框架)是一个开放源代码的对象关系映射框架,它对JDBC进行了非常轻量级的对象封装,它 ...
轻量级ORM框架——第一篇:Dapper快速学习
日志我们都知道ORM全称叫做Object Relationship Mapper,也就是可以用object来map我们的db,而且市面上的orm框架有很多,其中有一个框架 叫做dapper,而且被称为th ...
2
php如何使用rabbitmq实现发布消息和消费消息(tp框架)(第一篇)
日志1,默认已经安装好了rabbitmq: 参考 http://www.cnblogs.com/spicy/p/7017603.html 2,安装rabbitmq客户端: 方法1: pecl 扩展安装  ...
1
面试 JDK 第一篇 Object类面试详解
日志1.Object类有哪些方法 1>clone()方法 保护方法,实现对象的浅复制,只有实现了Cloneable接口才可以调用该方法,否则抛出CloneNotSupportedException异 ...
1
第一篇 Volley的使用之json请求
日志最近项目写完,有开始新的学习了,volley很久以前就接触了,也看了源码,然而却没有通过文章去记录自己的学习成果. 首先讲下volley的特点:   1,扩展性强.Volley 中大多是基于接口的设计 ...
1
Django(二)框架第一篇基础
日志https://www.cnblogs.com/haiyan123/p/7701412.html 一个小问题: 什么是根目录:就是没有路径,只有域名..url(r'^$') 补充一张关于wsgiref ...
2
SpringBoot(2) Json框架 -- Jackson返回结果处理
日志一.常用框架 阿里 fastjson,谷歌gson等 JavaBean序列化为Json,性能:Jackson > FastJson > Gson > Json-lib 同个结构 Ja ...
Django框架第一篇基础
日志一个小问题: 什么是根目录:就是没有路径,只有域名..url(r'^$') 补充一张关于wsgiref模块的图片 一.MTV模型 Django的MTV分别代表: Model(模型):和数据库相关的,负 ...
1
在net中json序列化与反序列化 面向对象六大原则 (第一篇) 一步一步带你了解linq to Object 10分钟浅谈泛型协变与逆变
日志在net中json序列化与反序列化 准备好饮料,我们一起来玩玩JSON,什么是Json:一种数据表示形式,JSON:JavaScript Object Notation对象表示法 Json语法规则: ...
1
Spring框架第一篇之Spring的第一个程序
日志一.下载Spring的jar包 通过http://repo.spring.io/release/org/springframework/spring/地址下载最新的Spring的zip包,当然,如果你 ...
1