在 kotlin 中使用 Gson 序列化数据类中的密封类

Question

我为 CustomAttribute 数据类下的 json 字段 Value 创建了一个密封类。该字段可以返回String 或Array of Strings。

我们如何从 json 中反序列化这个密封类？

data class CustomAttribute (
     val attributeCode: String,
     val value: Value 
)

sealed class Value {
      class StringArrayValue(val value: List<String>) : Value()
      class StringValue(val value: String)            : Value()
}

Answer 1

一种解决方案是按照this answer 中的说明使用RuntimeTypeAdapterFactory

val valueTypeAdapter = RuntimeTypeAdapter.of(Value::class.java)
    .registerSubtype(StringArrayValue::class.java)
    .registerSubtype(StringValue::class.java)
val gson = GsonBuilder().registerTypeAdapter(valueTypeAdapter).create()

RuntimeTypeAdapter 包含在 Gson 的源代码中，但不作为 Maven 工件公开。

它旨在复制/粘贴到您的项目from here

Answer 2

我过去曾成功序列化和反序列化一个密封类，并声明使用 Jackson 而不是 Gson 作为我的序列化引擎。

我的密封类被定义为：

@JsonTypeInfo(use = JsonTypeInfo.Id.MINIMAL_CLASS, include = JsonTypeInfo.As.PROPERTY, visible = true)
sealed class FlexibleResponseModel
    class SnapshotResponse(val collection: List<EntityModel>): FlexibleResponseModel()
    class DifferentialResponse(val collection: List<EntityModel>): FlexibleResponseModel()
    class EventDrivenResponse(val collection: List<EntityEventModel>): FlexibleResponseModel()
    class ErrorResponse(val error: String): FlexibleResponseModel()

使用注释后，无需进一步配置 Jackson 实例即可正确序列化和反序列化此密封类的实例，前提是通信双方都拥有密封类的统一定义。

虽然我认识到 JsonTypeInfo 是 Jackson 特定的注释，但如果此功能是必须的，也许您可​​能会考虑从 Gson 切换 - 或者您可能能够找到 Gson 的等效配置，其中也包括该类序列化数据中的标识符。