Jackson多型序列化

我叫樂多你養我啊發表於2022-06-01
多型

場景

做一個訊息中心，專門負責傳送訊息。訊息分為幾種渠道，包括手機通知(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。

相關文章