json 如何序列化/封装Kotlin密封类?

2admgd59  于 2023-10-21  发布在  Kotlin
关注(0)|答案(5)|浏览(197)

我有一个下面的密封类:

sealed class ViewModel {

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

}

我如何序列化/重新序列化ViewModel类的示例,比如说从JSON格式序列化/重新序列化?
我试过使用Genson序列化器/并行化器库-它可以处理Kotlin数据类,也可以支持多态类型(例如。使用某些元数据来指定具体类型)。
但是,库在Kotlinobject类型上失败,因为这些类型是没有公共构造函数的单例。我想我可以写一个自定义的Genson转换器来处理它,但也许有一个更简单的方法来做到这一点?

w8ntj3qf

w8ntj3qf1#

关于创建自定义序列化程序,您可能是对的。
我尝试使用Jackson库和Kotlin序列化和反序列化你的类。
以下是Jackson的Maven依赖项:

<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-core -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-core</artifactId>
    <version>2.8.8</version>
</dependency>

<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.8.8</version>
</dependency>

您可以使用此库将密封类序列化为JSON,而无需额外的自定义序列化器,但反序列化需要自定义反序列化器。
下面是我用来序列化和反序列化密封类的玩具代码:

import com.fasterxml.jackson.core.JsonParser
import com.fasterxml.jackson.databind.DeserializationContext
import com.fasterxml.jackson.databind.JsonDeserializer
import com.fasterxml.jackson.databind.JsonNode
import com.fasterxml.jackson.databind.ObjectMapper
import com.fasterxml.jackson.databind.module.SimpleModule

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

// Custom serializer
class ViewModelDeserializer : JsonDeserializer<ViewModel>() {
    override fun deserialize(jp: JsonParser?, p1: DeserializationContext?): ViewModel {
        val node: JsonNode? = jp?.getCodec()?.readTree(jp)
        val value = node?.get("value")
        return if (value != null) ViewModel.Loaded(value.asText()) else ViewModel.Loading
    }
}

fun main(args: Array<String>) {
    val m = createCustomMapper()
    val ser1 = m.writeValueAsString(ViewModel.Loading)
    println(ser1)
    val ser2 = m.writeValueAsString(ViewModel.Loaded("test"))
    println(ser2)
    val deserialized1 = m.readValue(ser1, ViewModel::class.java)
    val deserialized2 = m.readValue(ser2, ViewModel::class.java)
    println(deserialized1)
    println(deserialized2)
}

// Using mapper with custom serializer
private fun createCustomMapper(): ObjectMapper {
    val m = ObjectMapper()
    val sm = SimpleModule()
    sm.addDeserializer(ViewModel::class.java, ViewModelDeserializer())
    m.registerModule(sm)
    return m
}

如果你运行这段代码,这是输出:

{}
{"value":"test"}
ViewModel$Loading@1753acfe
Loaded(value=test)
wljmcqd8

wljmcqd82#

我最近也遇到了类似的问题(虽然用的是Jackson,而不是Genson。)
假设我有以下内容:

sealed class Parent(val name: String)

object ChildOne : Parent("ValOne")
object ChildTwo : Parent("ValTwo")

然后将JsonCreator函数添加到密封类中:

sealed class Parent(val name: String) {

    private companion object {
        @JsonCreator
        @JvmStatic
        fun findBySimpleClassName(simpleName: String): Parent? {
            return Parent::class.sealedSubclasses.first {
                it.simpleName == simpleName
            }.objectInstance
        }
    }
}

现在,您可以在json属性中使用ChildOneChildTwo作为key进行格式化。

a7qyws3x

a7qyws3x3#

我最终实现了一个自定义转换器加上一个工厂,以正确地插入到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() }
}

为了确保这个转换器只应用于实际的对象,我使用一个工厂来注册它,它告诉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()

代码可能会更好的链接转换器功能,但我没有时间检查出来。

lg40wkob

lg40wkob4#

不需要@JsonCreatorsealdSubClass。Jackson在其jackson-module-kotlin中提供了这种支持,只需要一个注解@JsonTypeInfo(use = JsonTypeInfo.Id.NAME)

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME)
  sealed class SuperClass{
      class A: SuperClass()
      class B: SuperClass()
  }

...
val mapper = jacksonObjectMapper()
val root: SuperClass = mapper.readValue(json)
when(root){
    is A -> "It's A"
    is B -> "It's B"
}

上面的例子是从它的主repo README复制的:https://github.com/FasterXML/jackson-module-kotlin

6tqwzwtp

6tqwzwtp5#

我遇到了一个类似的问题,花了一天的时间来解决它,@X.Y https://stackoverflow.com/a/71315804/18916677的一个答案帮助了我,但它有点不完整
要解决你面临的问题,你需要两件事,
1.你的JacksonobjectMapper需要一个配置为支持Singleton对象的KotlinModule,下面是一个代码片段
瓦尔objectMapper:ObjectMapper = JsonMapper.builder().build()objectMapper.registerModule(KotlinModule.Builder().enable(KotlinFeature.SingletonSupport).build())
1.第二件事是由上面的答案-> https://stackoverflow.com/a/71315804/18916677提供的,这是@JsonTypeInfo(use = JsonTypeInfo.Id.NAME)注解
通过执行上述两个步骤,Jackson使用类名序列化对象,并使用类名将其序列化,同时保持单例行为不变
如果您只使用第二步解决问题,您可能会看到问题已经解决,但是每次执行示例化时,您最终都会得到不同的示例
!!编码快乐!!

相关问题