Jackson多態序列化怎么實現

這篇文章主要介紹“Jackson多態序列化怎么實現”，在日常操作中，相信很多人在Jackson多態序列化怎么實現問題上存在疑惑，小編查閱了各式資料，整理出簡單好用的操作方法，希望對大家解答”Jackson多態序列化怎么實現”的疑惑有所幫助！接下來，請跟著小編一起來學習吧！

場景

做一個消息中心，專門負責發送消息。消息分為幾種渠道，包括手機通知(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多態序列化怎么實現”的學習就結束了，希望能夠解決大家的疑惑。理論與實踐的搭配能更好的幫助大家學習，快去試試吧！若想繼續學習更多相關知識，請繼續關注億速云網站，小編會繼續努力為大家帶來更多實用的文章！