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

一、基础准备

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

  1. <dependency>
  2.     <groupId>com.fasterxml.jackson.core</groupId>
  3.     <artifactId>jackson-databind</artifactId>
  4.     <version>2.9.8</version>
  5. </dependency>

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

  1. @Data
  2. public class PlayerStar {
  4.   private String name;
  5.   private Integer age;
  6.   private String[] hobbies;    //业余爱好,数组
  7.   private List<String> friends;   //  朋友
  8.   private Map<String, BigDecimal> salary; //年收入 Map
  10.   //初始化一个对象用于测试
  11.   public static PlayerStar getInstance(){
  12.     PlayerStar playerStar = new PlayerStar();
  14.     playerStar.setName("乔丹");
  15.     playerStar.setAge(45);
  16.     playerStar.setHobbies(new String[]{"高尔夫球", "棒球"});
  17.     Map<String, BigDecimal> salary = new HashMap<String, BigDecimal>() {{
  18.       put("2000", new BigDecimal(10000000));
  19.       put("2010", new BigDecimal(62000000));
  20.       put("2020", new BigDecimal(112400000));
  21.     }};
  22.     playerStar.setSalary(salary);
  23.     playerStar.setFriends(Arrays.asList("kobe", "curry", "james"));
  25.     return playerStar;
  26.   }
  28. }

二、序列化方法

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

  • writeValue可以接收File作为参数，将JSON序列化结果保存到文件中
  • writeValueAsString将JSON序列化结果以String形式返回

  • writerWithDefaultPrettyPrinter方法可以将JSON序列化结果进行格式化，更好的显示结构，易于查看

    1. @Test
    2. void testObject2JSON() throws IOException {
    3. //获取对象实例
    4. PlayerStar player = PlayerStar.getInstance();
    6. //ObjectMapper作为Jackson的API工具类存在
    7. ObjectMapper mapper = new ObjectMapper();
    8. //将player对象以JSON格式进行序列化，并将序列化结果写入文件
    9. mapper.writeValue(new File("d:\data\jackson\player.json"), player);
    11. //将player对象以JSON格式进行序列化为String对象
    12. String jsonString = mapper.writeValueAsString(player);
    13. System.out.println(jsonString);
    15. //将player对象以JSON格式进行序列化为String对象(格式美化)
    16. String jsonInString2 = mapper.writerWithDefaultPrettyPrinter()
    17.         .writeValueAsString(player);
    18. System.out.println(jsonInString2);
    19. }

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

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

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

    1. {
    2. "name" : "乔丹",
    3. "age" : 45,
    4. "hobbies" : [ "高尔夫球", "棒球" ],
    5. "friends" : [ "kobe", "curry", "james" ],
    6. "salary" : {
    7.   "2000" : 10000000,
    8.   "2010" : 62000000,
    9.   "2020" : 112400000
    10. }
    11. }

三、反序列化方法

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

  1. @Test
  2. void testJSON2Object() throws IOException {
  3.   ObjectMapper mapper = new ObjectMapper();
  4.   //从文件中读取JSON字符串，反序列化为java对象
  5.   PlayerStar player = mapper.readValue(new File("d:\data\jackson\player.json"), PlayerStar.class);
  6.   System.out.println(player);
  8.   //将JSON字符串反序列化为java对象
  9.   String jsonInString = "{\"name\":\"乔丹\",\"age\":45,\"hobbies\":[\"高尔夫球\",\"棒球\"]}";
  10.   PlayerStar jordan = mapper.readValue(jsonInString, PlayerStar.class);
  12.   System.out.println(jordan);
  14. }

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

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

四、字段重命名 @JsonProperty

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

  1. @Data
  2. public class PlayerStar {
  4.   @JsonProperty("playerName")
  5.   private String name;  //将属性name序列化为playerName，同时影响反序列化

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

  1. {"playerName":"乔丹"  ……

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

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

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

当我们不为对象的成员变量赋值的时候，默认情况下，Jackson的序列化结果是下面的这样的。
{ “age” : 45, “hobbies” : null, “friends” : null, “salary” : null, “playerName” : “乔丹” }
如果我们不希望将null值，体现在JSON序列化结果中，我们可以使用下面的方法。如果希望在某次序列化的全局范围内，忽略null成员变量，可以使用下面的API

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

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

  1. @JsonInclude(JsonInclude.Include.NON_NULL)
  2. public class PlayerStar {
  3.    ......
  4. }

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

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

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

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

六、忽略指定的字段

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

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

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

  1. @Data
  2. @JsonIgnoreProperties({"hobbies", "friends","salary"})
  3. public class PlayerStar {
  5.   @JsonProperty("playerName")
  6.   private String name;
  7.   private Integer age;
  9.   @JsonIgnore
  10.   private String[] hobbies;    //业余爱好,数组
  11.   @JsonIgnore
  12.   private List<String> friends;   //  朋友
  13.   @JsonIgnore
  14.   private Map<String, BigDecimal> salary; //年收入 Map
  16. ......

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

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

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