一、基礎(chǔ)準(zhǔn)備

在任意項(xiàng)目中引入下面的jar就可以使用jackson進(jìn)行JSON的數(shù)據(jù)序列化與反序列化的功能。

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

寫一個(gè)PlayerStar的實(shí)體類，實(shí)體類主要體現(xiàn)籃球明星的名字、年齡、業(yè)余愛好、朋友、年收入等信息，為了盡可能地演示Jackson的序列化與反序列化功能，將數(shù)組、List、Map都融合到這個(gè)類里面。并通過getInstance初始化籃球明星Jordan這個(gè)對(duì)象。

@Data
public class PlayerStar {

  private String name;
  private Integer age;
  private String[] hobbies;    //業(yè)余愛好,數(shù)組
  private List<String> friends;   //  朋友
  private Map<String, BigDecimal> salary; //年收入 Map


  //初始化一個(gè)對(duì)象用于測(cè)試
  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對(duì)象序列化為JSON字符串。

• writeValue可以接收File作為參數(shù)，將JSON序列化結(jié)果保存到文件中
• writeValueAsString將JSON序列化結(jié)果以String形式返回
• writerWithDefaultPrettyPrinter方法可以將JSON序列化結(jié)果進(jìn)行格式化，更好的顯示結(jié)構(gòu)，易于查看

@Test
void testObject2JSON() throws IOException {
  //獲取對(duì)象實(shí)例
  PlayerStar player = PlayerStar.getInstance();

  //ObjectMapper作為Jackson的API工具類存在
  ObjectMapper mapper = new ObjectMapper();
  //將player對(duì)象以JSON格式進(jìn)行序列化，并將序列化結(jié)果寫入文件
  mapper.writeValue(new File("d:\\data\\jackson\\player.json"), player);

  //將player對(duì)象以JSON格式進(jìn)行序列化為String對(duì)象
  String jsonString = mapper.writeValueAsString(player);
  System.out.println(jsonString);

  //將player對(duì)象以JSON格式進(jìn)行序列化為String對(duì)象(格式美化)
  String jsonInString2 = mapper.writerWithDefaultPrettyPrinter()
          .writeValueAsString(player);
  System.out.println(jsonInString2);
}

jsonString的控制臺(tái)打印輸出結(jié)果，也是d:\data\jackson\player.json文件的內(nèi)容

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

jsonString2的控制臺(tái)打印輸出，格式進(jìn)行了美化，因?yàn)槭褂昧藈riterWithDefaultPrettyPrinter()方法

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

三、反序列化方法

下面代碼演示了如何將JSON字符串反序列化為Java對(duì)象

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

  //將JSON字符串反序列化為java對(duì)象
  String jsonInString = "{\"name\":\"喬丹\",\"age\":45,\"hobbies\":[\"高爾夫球\",\"棒球\"]}";
  PlayerStar jordan = mapper.readValue(jsonInString, PlayerStar.class);

  System.out.println(jordan);

}

PlayerStar對(duì)象控制臺(tái)輸出結(jié)果如下(注意這里的輸出不是JSON格式，而是java對(duì)象的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來影響序列化和反序列化對(duì)象屬性的重命名。

@Data
public class PlayerStar {

  @JsonProperty("playerName")
  private String name;  //將屬性name序列化為playerName，同時(shí)影響反序列化

使用上面代碼的注解之后，JSON序列化的結(jié)果name屬性變成playerName屬性

{"playerName":"喬丹"  ……

同時(shí)影響反序列化,下面的反序列化代碼會(huì)報(bào)錯(cuò)，因?yàn)槭褂昧薾ame屬性。應(yīng)該使用playerName才可以。

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

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

當(dāng)我們不為對(duì)象的成員變量賦值的時(shí)候，默認(rèn)情況下，Jackson的序列化結(jié)果是下面的這樣的。

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

如果我們不希望將null值，體現(xiàn)在JSON序列化結(jié)果中，我們可以使用下面的方法。如果希望在某次序列化的全局范圍內(nèi)，忽略null成員變量，可以使用下面的API

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

或者是在類名的上面加上如下注解。該注解將針對(duì)類里面的所有成員變量生效，只要成員變量為null，將不會(huì)被包含在序列化結(jié)果中。

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

如果我們想針對(duì)PlayerStar類里面某些成員變量單獨(dú)忽略null，可以在成員變量上面加注解。

@JsonInclude(JsonInclude.Include.NON_NULL)
private String[] hobbies;    //業(yè)余愛好,數(shù)組
@JsonInclude(JsonInclude.Include.NON_NULL)
private List<String> friends;   //  朋友
@JsonInclude(JsonInclude.Include.NON_NULL)
private Map<String, BigDecimal> salary; //年收入 Map

忽略為null的成員變量后,JSON序列化結(jié)果是下面這樣的

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

六、忽略指定的字段

默認(rèn)情況下，jackson不會(huì)將static和transient的成員變量進(jìn)行序列化與反序列化操作。我們還可以通過

• @JsonIgnore加在類成員變量上面，該成員變量將被排除在序列化和反序列化的過程之外
• @JsonIgnoreProperties加在類聲明上面，指定該類里面哪些字段被排除在序列化和反序列化的過程之外

上面的兩種注解選其一即可，下面的代碼兩種注解我都用了，功能是重復(fù)的

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

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

  @JsonIgnore
  private String[] hobbies;    //業(yè)余愛好,數(shù)組
  @JsonIgnore
  private List<String> friends;   //  朋友
  @JsonIgnore
  private Map<String, BigDecimal> salary; //年收入 Map

......

在類或成員變量上面加上注解之后，序列化結(jié)果如下，指定字段被忽略。

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

需要注意的是這兩個(gè)注解不只是影響序列化為JSON字符串的過程，也影響JSON字符串反序列化為java對(duì)象的過程。舉例：如果JSON字符串包含了類中被JsonIgnore的屬性值hobbies，不會(huì)被反序列化賦值給java對(duì)象的成員變量hobbies。

歡迎關(guān)注我的博客，里面有很多精品合集

• 本文轉(zhuǎn)載注明出處（必須帶連接，不能只轉(zhuǎn)文字）：字母哥博客。

覺得對(duì)您有幫助的話，幫我點(diǎn)贊、分享！您的支持是我不竭的創(chuàng)作動(dòng)力！ 。另外，筆者最近一段時(shí)間輸出了如下的精品內(nèi)容，期待您的關(guān)注。

• 《手摸手教你學(xué)Spring Boot2.0》
• 《Spring Security-JWT-OAuth2一本通》
• 《實(shí)戰(zhàn)前后端分離RBAC權(quán)限管理系統(tǒng)》
• 《實(shí)戰(zhàn)SpringCloud微服務(wù)從青銅到王者》
• 《VUE深入淺出系列》