如何序列化反序列化Kotlin密封类

发布于05月25日

我有一门封闭的课程:

sealed class ViewModel {

  data class Loaded(val value : String) : ViewModel()
  object Loading : ViewModel()

}

我如何序列化/反序列化ViewModel类的实例(比方说到JSON格式/从JSON格式)？

我try 使用Genson序列化/反序列化程序库-它可以处理Kotlin数据类，也可以支持多态类型(例如.使用一些元数据来指定具体类型).

However, the library fails on Kotlin object types, as these are singletons without a public constructor. I guess I could write a custom Genson converter to handle it, but maybe there's an easier way to do it?

推荐答案

我最终实现了一个定制的转换器和一个工厂，以便将其正确地插入Genson.

它使用Genson的元数据约定将对象表示为:

{ 
  "@class": "com.example.ViewModel.Loading" 
}

转换器假设设置了useClassMetadata个标志，所以序列化只需要标记一个空对象.对于反序列化，它从元数据解析类名，加载它并获得objectInstance.

object KotlinObjectConverter : Converter<Any> {

override fun serialize(objectData: Any, writer: ObjectWriter, ctx: Context) {
    with(writer) {
        // just empty JSON object, class name will be automatically added as metadata
        beginObject()
        endObject()
    }
}

override fun deserialize(reader: ObjectReader, ctx: Context): Any? =
    Class.forName(reader.nextObjectMetadata().metadata("class"))
        .kotlin.objectInstance
        .also { reader.endObject() }
}

为了确保此转换器仅应用于实际的objects，我使用工厂注册它，该工厂告诉Genson何时使用它，何时退回到默认实现.

object KotlinConverterFactory : Factory<Converter<Any>> {

    override fun create(type: Type, genson: Genson): Converter<Any>? =
        if (TypeUtil.getRawClass(type).kotlin.objectInstance != null) KotlinObjectConverter
        else null

}

工厂可通过builder配置Genson:

GensonBuilder()
        .withConverterFactory(KotlinConverterFactory)
        .useClassMetadata(true) // required to add metadata during serialization
        // some other properties
        .create()

使用链式转换器功能，代码可能会更好，但我还没有时间判断它.