乐趣区

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

jiezi


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。

欢送关注我的博客，外面有很多精品合集

  • 本文转载注明出处（必须带连贯，不能只转文字）：字母哥博客。

感觉对您有帮忙的话，帮我点赞、分享！您的反对是我不竭的创作能源！。另外，笔者最近一段时间输入了如下的精品内容，期待您的关注。

  • 《手摸手教你学 Spring Boot2.0》
  • 《Spring Security-JWT-OAuth2 一本通》
  • 《实战前后端拆散 RBAC 权限管理系统》
  • 《实战 SpringCloud 微服务从青铜到王者》
  • 《VUE 深入浅出系列》
退出移动版