場景

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

我定義了一個基類MessageRequest用來接收請求參數(shù)，代碼如下：

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有各種渠道的子類實現(xiàn)，以Push為例：

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

我在接口入?yún)⑹褂?code>MessageRequest接收：

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

使用postman發(fā)送push請求之后發(fā)現(xiàn)后端收到的類型還是基類，并且title字段丟失。

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

Jackson多態(tài)類型序列化/反序列化

經(jīng)過查詢資料以及咨詢了一下領(lǐng)導(dǎo)，發(fā)現(xiàn)了@JsonTypeInfo和@JsonSubTypes兩個注解。

@JsonTypeInfo作用于類/接口，被用來開啟多態(tài)類型處理，它有一些屬性：

• use(必選)：定義使用哪一種類型標識碼，有以下幾個可選項。
  • NONE：不使用識別碼
  • CLASS：使用完全限定類名做識別碼
  • MINIMAL_CLASS：使用類名(忽略包名)做識別碼，和基類在同一個包可用
  • NAME：指定名稱
  • CUSTOM：自定義識別碼，由@JsonTypeIdResolver對應(yīng)
• include(可選)：指定識別碼如何被包含進去，有以下幾個可選項。
  • PROPERTY：作為兄弟屬性加入，默認值
  • WRAPPER_OBJECT：作為一個包裝的對象
  • WRAPPER_ARRAY：作為包裝的數(shù)組
  • 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內(nèi)容中刪除類型標識再傳遞給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[]數(shù)組，參數(shù)value表示類型，參數(shù)name表示@JsonTypeInfo注解中property屬性的值，對比以上代碼即：channel = "PUSH"或channel = "EMAIL"。name為可選值，不指定時需在子類提供JsonTypeName注解并指定value屬性。

實戰(zhàn)

改造上面提供的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請求發(fā)現(xiàn)入?yún)㈩愋陀辛俗兓?/p>

include屬性使用默認的PROPERTY時發(fā)現(xiàn)序列化之后的json會多出來一個屬性，屬性名對應(yīng)的就是@JsonTypeInfo的property的值。雖然不影響使用，但是我看著很不舒服?；谖疫@種情況可以使用include=EXISTING_PROPERTY。

總結(jié)

到此這篇關(guān)于Jackson多態(tài)序列化的文章就介紹到這了,更多相關(guān)Jackson多態(tài)序列化內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論