屬性序列化自定義與字母表排序-JSON框架Jackson精解第3篇

字母哥部落格發表於2020-09-21
排序JSON框架

Jackson是Spring Boot預設的JSON資料處理框架，但是其並不依賴於任何的Spring 庫。有的小夥伴以為Jackson只能在Spring框架內使用，其實不是的，沒有這種限制。它提供了很多的JSON資料處理方法、註解，也包括流式API、樹模型、資料繫結，以及複雜資料型別轉換等功能。它雖然簡單易用，但絕對不是小玩具，更多的內容我會寫成一個系列，5-10篇文章，請您繼續關注我。

大家在平時進行JSON資料序列化過程中，經常會有按照一定順序序列化屬性這樣的需求。本文為大家介紹如何對JSON序列化的屬性進行排序，可以自定義順序，也可以按照字母表順序排序。

一、@JsonPropertyOrder屬性排序

通過JsonPropertyOrder註解指定java POJO中各個成員變數的屬性序列化順序。

@Data
@JsonPropertyOrder({"salary","name","age","hobbies","friends"})
public class PlayerStar {

  private String name;
  private Integer age;
  private String[] hobbies;    //業餘愛好,陣列
  private List<String> friends;   //  朋友
  private Map<String, BigDecimal> salary; //年收入 Map
}

最終Java POJO物件序列化為如下的字串，屬性是按照JsonPropertyOrder註解定義的順序序列化的（"salary","name","age","hobbies","friends"）。如果不使用JsonPropertyOrder指定順序，預設是按照Java類成員變數的宣告順序進行序列化。

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

可以使用下面的程式碼將PlayerStar物件序列化為字串

  //getInstance是一個為PlayerStar各屬性賦值的初始化方法，可以參考本系列文章第一節：基礎資料準備
  PlayerStar jordan = PlayerStar.getInstance();

  //ObjectMapper作為Jackson的API工具類存在
  ObjectMapper mapper = new ObjectMapper();
  String jsonInString2 = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(jordan);
  System.out.println(jsonInString2);

二、字母表順序排序

使用@JsonPropertyOrder(alphabetic = true)定義Java類成員變數的序列化順序

@JsonPropertyOrder(alphabetic = true)
public class PlayerStar {
     //成員變數定義和上文一致
}

在英語字母表中，age(a開頭) > friends(f開頭) ->hobbies(h開頭)，以此類推，所以最終JSON序列化結果如下：

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

歡迎關注我的部落格，裡面有很多精品合集

  • 本文轉載註明出處（必須帶連線，不能只轉文字）：字母哥部落格。

覺得對您有幫助的話，幫我點贊、分享！您的支援是我不竭的創作動力！ 。另外，筆者最近一段時間輸出瞭如下的精品內容，期待您的關注。

相關文章