Jackson多態序列化圖文詳解

Posted on by

場景

做一個消息中心，專門負責發送消息。消息分為幾種渠道，包括手機通知(Push)、短信(SMS)、郵件(Email)，Websocket等渠道。

我定義瞭一個基類MessageRequest用來接收請求參數，代碼如下：

public class MessageRequest implements Serializable {
  protected MessageChannel channel;
  private MessageRequest(){}
  protected MessageRequest(MessageChannel channel){
    this.channel = channel;
  }
  
  public MessageChannel getChannel() {
    return this.channel;
  }
}

在MessageRequest中有個屬性channel是枚舉MessageChannel，該枚舉列舉所有渠道，代碼如下：

public enum MessageChanne {
  PUSH,
  EMAIL,
  WEBSOCKET,
  SMS,
  ;
  
  MessageChannel() {}
}

MessageRequest有各種渠道的子類實現，以Push為例：

public class PushMessageReuqest extends MessageRequest {
  public PushMessageRequest() {
    super(MessageChannel.PUSH);
  }
  
  private String title;
  // 省略其他字段以及getter、setter方法
  ...
}

我在接口入參使用MessageRequest接收：

public class MessageController {
  @PostMapping("/sendMessage")
  public R<Object> sendMessage(MessageRequest request) {
    System.out.println(request);
  }
}

使用postman發送push請求之後發現後端收到的類型還是基類，並且title字段丟失。

這與我預想的不符，因為客戶端知道渠道，構建對應的渠道消息體給我就好瞭啊！為什麼類型被擦除瞭呢？我的想法就是發送push請求啊。。。。。後來才知道序列化之後在反序列化的時候不知道給你反序列化成什麼類型，序列化工具也沒有聰明到能根據你的channel屬性就知道是什麼類型，但是我又想這樣做。那麼怎麼辦呢？？？？

Jackson多態類型序列化/反序列化

經過查詢資料以及咨詢瞭一下領導，發現瞭@JsonTypeInfo和@JsonSubTypes兩個註解。

@JsonTypeInfo作用於類/接口，被用來開啟多態類型處理，它有一些屬性：

  • use(必選)：定義使用哪一種類型標識碼，有以下幾個可選項。
    • NONE：不使用識別碼
    • CLASS：使用完全限定類名做識別碼
    • MINIMAL_CLASS：使用類名(忽略包名)做識別碼，和基類在同一個包可用
    • NAME：指定名稱
    • CUSTOM：自定義識別碼，由@JsonTypeIdResolver對應
  • include(可選)：指定識別碼如何被包含進去，有以下幾個可選項。
    • PROPERTY：作為兄弟屬性加入，默認值
    • WRAPPER_OBJECT：作為一個包裝的對象
    • WRAPPER_ARRAY：作為包裝的數組
    • EXTERNAL_PROPERTY：作為擴展屬性
    • EXISTING_PROPERTY：作為已存在的屬性(符合我的場景，用channel)
  • property(可選)：指定識別碼的屬性名稱。該屬性隻有當use為CLASS(不指定默認為@class)、MINIMAL_CLASS(不指定默認為@c)、NAME(不指定默認為@type，include為PROPERTY、EXISTING_PROPERTY、EXTERNAL_PROPERTY時才有效。
  • defaultImpl(可選)：如果類型識別碼不存在或者無效，可以使用該屬性來指定反序列化時使用的默認類型。
  • visible(可選，默認false)：屬性定義瞭類型標識符是否會成為反序列化器的一部分，默認為false，也就是說Jackson會從json內容中刪除類型標識再傳遞給JsonDeserializer。

@JsonSubTypes作用於類/接口，用來列出給定類/接口的子類。一般配合@JsonTypeInfo使用

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "channel")
@JsonSubTypes({
  @JsonSubTypes.Type(value = PushMessageRequest.class, name = "PUSH"),
  @JsonSubTypes.Type(value = EmailMessageRequest.class, name = "EMAIL")
})

JsonSubTypes的值是一個@JsonSubTypes.Type[]數組，參數value表示類型，參數name表示@JsonTypeInfo註解中property屬性的值，對比以上代碼即：channel = "PUSH"或channel = "EMAIL"。name為可選值，不指定時需在子類提供JsonTypeName註解並指定value屬性。

實戰

改造上面提供的MessageReuqest

// include默認為PROPERTY，這裡可以不加
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "channel")
@JsonSubTypes({
  @JsonSubTypes.Type(value = PushMessageRequest.class, name = "PUSH"),
  @JsonSubTypes.Type(value = EmailMessageRequest.class, name = "EMAIL")
})
public class MessageRequest implements Serializable {
  
  protected MessageChannel channel;
  
  private MessageRequest(){}
  
  protected MessageRequest(MessageChannel channel){
    this.channel = channel;
  }
  
  public MessageChannel getChannel() {
    return this.channel;
  }
}

此時通過postman請求發現入參類型有瞭變化

include屬性使用默認的PROPERTY時發現序列化之後的json會多出來一個屬性，屬性名對應的就是@JsonTypeInfo的property的值。雖然不影響使用，但是我看著很不舒服。基於我這種情況可以使用include=EXISTING_PROPERTY。

總結

到此這篇關於Jackson多態序列化的文章就介紹到這瞭,更多相關Jackson多態序列化內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：