Jackson精解第4篇-@JacksonInject與@JsonAlias註解

字母哥部落格發表於2020-09-22
JSON

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

本節繼續為大家介紹在JSON反序列化過程中，如何使用@JacksonInject註解和@JsonAlias註解

一、@JacksonInject註解

在使用JSON格式進行反序列化的時候，我們經常有這樣一些需求。我們從客戶端或者其他渠道獲取了一個JSON格式的資料物件，該物件包含若干個屬性。但是我們在將JSON字串反序列化的時候，需要給它加上一些預設資料，比如：

  • responseTime資料響應時間，賦值為當前時間即可；
  • 資料反序列化的操作人，賦值為系統當前使用者等

客戶端返回給我們的資料本身不會攜帶這些附加資訊，這個時候我們就可以使用JacksonInject註解，在JSON字串反序列化為物件的時候，加上這些附加資訊。下面是JacksonInject使用方法

@Data
public class PlayerStar {

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

  @JacksonInject("responseTime")      //注意這裡
  private LocalDateTime responseTime;
}

我們來測試一下反序列化的過程，需要注意的是下文中的jsonInString中並不攜帶responseTime資訊，是我們自己在反序列化的時候注入到java物件中的。

@Test
void testJSON2Object() throws IOException {
  //為responseTime賦值為當前值
  InjectableValues.Std iv = new InjectableValues.Std();
  iv.addValue("responseTime", LocalDateTime.now());

  ObjectMapper mapper = new ObjectMapper();
  mapper.setInjectableValues(iv);       //將可插入值，在反序列化過程中賦值給物件
  
  //將JSON字串反序列化為java物件
  String jsonInString = "{\"name\":\"喬丹\",\"age\":45,\"hobbies\":[\"高爾夫球\",\"棒球\"]}";
  PlayerStar jordan = mapper.readValue(jsonInString, PlayerStar.class);

  System.out.println(jordan);

}

最終的反序列化結果,java 物件的toString()方法輸出結果如下，可以看到多出一個responseTime賦值屬性，值為當前時間

PlayerStar(name=喬丹, age=45, hobbies=[高爾夫球, 棒球], friends=null, salary=null, responseTime=2020-09-22T06:41:09.192)

二、按照資料型別type進行資料注入

在上文的程式碼中，JSON字串反序列化為物件，使用的是屬性id的方法進行注入的

  @JacksonInject("responseTime")      //注意這裡responseTime為屬性id
  private LocalDateTime responseTime;

  InjectableValues.Std iv = new InjectableValues.Std();
  iv.addValue("responseTime", LocalDateTime.now());  //注意這裡responseTime為屬性id，而這要統一

除了可以按照屬性id進行資料的注入，還可以使用java type資料型別進行資料注入。這種方法在一個java 類中，多個成員變數資料型別重複的時候，比如定義多個LocalDateTime成員變數，用起來就不太方便了。所以還是建議大家使用屬性id的方法進行注入資料注入。

  @JacksonInject
  private LocalDateTime responseTime;

  InjectableValues.Std iv = new InjectableValues.Std();
  iv.addValue(LocalDateTime.class, LocalDateTime.now());  //注意這裡LocalDateTime.class

三、 @JsonAlias註解

當我們在開發過程中，可能在v1.0的版本中我們定義的PlayerStar類(上文)包含name屬性，但是我們用著用著發現name這個單詞太通用了，在很多的地方都是系統關鍵字；我們希望在v2.0版本中，給這個成員變數換一個名字，叫做starName，或者playerName。但是我們不希望使用者廢棄v1.0的介面。
也就是說我們希望做到多版本相容，客戶端傳送過來的JSON字串，可以是name、可以是playerName、可以是starName。我們該怎麼做？答案是使用@JsonAlias註解

@Data
public class PlayerStar {

  @JsonAlias({"starName", "playerName" })
  private String name;

下面三種JSON格式資料都可以被正確的反序列化為PlayerStar物件，併為name成員變數賦值

String jsonInString = "{\"name\":\"喬丹\",\"age\":45,\"hobbies\":[\"高爾夫球\",\"棒球\"]}";
String jsonInString = "{\"starName\":\"喬丹\",\"age\":45,\"hobbies\":[\"高爾夫球\",\"棒球\"]}";
String jsonInString = "{\"playerName\":\"喬丹\",\"age\":45,\"hobbies\":[\"高爾夫球\",\"棒球\"]}";

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

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

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

相關文章