-
Notifications
You must be signed in to change notification settings - Fork 615
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make SerialModule sealed class instead of interface
* As explained in #697, it appears that concatenating two modules as "behaviours" (as opposed to "bag of serializers") is way too dangerous for the end users and implies a lot of inconsistent behaviours and performance hits. So the most rational solution here is to prohibit such concatenations by closing the way to implement your own SerialModule * In order to still solve "fallback serializer" use-case, new 'default' DSL is introduced along with its support in PolymorphicSerializer Fixes #697 Fixes #448
- Loading branch information
Showing
15 changed files
with
299 additions
and
146 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
106 changes: 93 additions & 13 deletions
106
runtime/commonMain/src/kotlinx/serialization/modules/SerialModule.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,60 +1,140 @@ | ||
| /* | ||
| * Copyright 2017-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. | ||
| * Copyright 2017-2020 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. | ||
| */ | ||
|
|
||
| @file:Suppress("UNCHECKED_CAST", "RedundantVisibilityModifier") | ||
|
|
||
| package kotlinx.serialization.modules | ||
|
|
||
| import kotlinx.serialization.* | ||
| import kotlinx.serialization.internal.* | ||
| import kotlin.reflect.* | ||
|
|
||
| /** | ||
| * [SerialModule] is a collection of serializers used by [ContextSerializer] and [PolymorphicSerializer] | ||
| * to override or provide serializers at the runtime, whereas at the compile-time they provided by the serialization plugin. | ||
| * It can be considered as a map where serializers can be found using their statically known KClasses. | ||
| * | ||
| * It can be considered as a map where serializers are found using statically known KClasses. | ||
| * | ||
| * To enable runtime resolution of serializers, one of the special annotations must be used on target types | ||
| * and a serial module with serializers should be used during construction of [SerialFormat]. | ||
| * To enable runtime serializers resolution, one of the special annotations must be used on target types | ||
| * ([Polymorphic] or [ContextualSerialization]), and a serial module with serializers should be used during construction of [SerialFormat]. | ||
| * | ||
| * @see ContextualSerialization | ||
| * @see Polymorphic | ||
| */ | ||
| public interface SerialModule { | ||
| public sealed class SerialModule { | ||
|
|
||
| /** | ||
| * Returns a contextual serializer associated with a given [kclass]. | ||
| * This method is used in context-sensitive operations on a property marked with [ContextualSerialization] by a [ContextSerializer] | ||
| */ | ||
| public fun <T : Any> getContextual(kclass: KClass<T>): KSerializer<T>? | ||
| public abstract fun <T : Any> getContextual(kclass: KClass<T>): KSerializer<T>? | ||
|
|
||
| /** | ||
| * Returns a polymorphic serializer registered for a class of the given [value] in the scope of [baseClass]. | ||
| */ | ||
| public fun <T : Any> getPolymorphic(baseClass: KClass<T>, value: T): KSerializer<out T>? | ||
| public abstract fun <T : Any> getPolymorphic(baseClass: KClass<T>, value: T): KSerializer<out T>? | ||
|
|
||
| /** | ||
| * Returns a polymorphic serializer registered for for a [serializedClassName] in the scope of [baseClass]. | ||
| */ | ||
| public fun <T : Any> getPolymorphic(baseClass: KClass<T>, serializedClassName: String): KSerializer<out T>? | ||
| public abstract fun <T : Any> getPolymorphic(baseClass: KClass<T>, serializedClassName: String): KSerializer<out T>? | ||
|
|
||
| /** | ||
| * Returns a default polymorphic serializer registered for a [serializedClassName] in the scope of [baseClass]. | ||
| * In contrast with [getPolymorphic], module user registers a factory function for default serializers that can | ||
| * provide a serializer even for an unknown in advance [serializedClassName]. | ||
| */ | ||
| public abstract fun <T : Any> getDefaultPolymorphic( | ||
| baseClass: KClass<T>, | ||
| serializedClassName: String | ||
| ): DeserializationStrategy<out T>? | ||
|
|
||
| /** | ||
| * Copies contents of this module to the given [collector]. | ||
| */ | ||
| public fun dumpTo(collector: SerialModuleCollector) | ||
| public abstract fun dumpTo(collector: SerialModuleCollector) | ||
| } | ||
|
|
||
| /** | ||
| * A [SerialModule] which is empty and always returns `null`. | ||
| */ | ||
| public object EmptyModule : SerialModule { | ||
| public object EmptyModule : SerialModule() { | ||
| public override fun <T : Any> getContextual(kclass: KClass<T>): KSerializer<T>? = null | ||
| public override fun <T : Any> getPolymorphic(baseClass: KClass<T>, value: T): KSerializer<out T>? = null | ||
| public override fun <T : Any> getPolymorphic( | ||
| baseClass: KClass<T>, | ||
| serializedClassName: String | ||
| ): KSerializer<out T>? = null | ||
|
|
||
| override fun <T : Any> getDefaultPolymorphic( | ||
| baseClass: KClass<T>, | ||
| serializedClassName: String | ||
| ): DeserializationStrategy<out T>? = null | ||
|
|
||
| public override fun dumpTo(collector: SerialModuleCollector) = Unit | ||
| } | ||
|
|
||
| internal typealias PolymorphicProvider<Base> = (className: String) -> DeserializationStrategy<out Base>? | ||
|
|
||
| /** | ||
| * A default implementation of [SerialModule] | ||
| * which uses hash maps to store serializers associated with KClasses. | ||
| */ | ||
| @Suppress("UNCHECKED_CAST") | ||
| internal class SerialModuleImpl( | ||
| private val class2Serializer: Map<KClass<*>, KSerializer<*>>, | ||
| private val polyBase2Serializers: Map<KClass<*>, Map<KClass<*>, KSerializer<*>>>, | ||
| private val polyBase2NamedSerializers: Map<KClass<*>, Map<String, KSerializer<*>>>, | ||
| private val polyBase2DefaultProvider: Map<KClass<*>, PolymorphicProvider<*>> | ||
| ) : SerialModule() { | ||
|
|
||
| override fun <T : Any> getPolymorphic(baseClass: KClass<T>, value: T): KSerializer<out T>? { | ||
| if (!value.isInstanceOf(baseClass)) return null | ||
| val custom = polyBase2Serializers[baseClass]?.get(value::class) as? KSerializer<out T> | ||
| if (custom != null) return custom | ||
| if (baseClass == Any::class) { | ||
| val serializer = StandardSubtypesOfAny.getSubclassSerializer(value) | ||
| return serializer as? KSerializer<out T> | ||
| } | ||
| return null | ||
| } | ||
|
|
||
| override fun <T : Any> getDefaultPolymorphic( | ||
| baseClass: KClass<T>, | ||
| serializedClassName: String | ||
| ): DeserializationStrategy<out T>? = | ||
| (polyBase2DefaultProvider[baseClass] as? PolymorphicProvider<T>)?.invoke(serializedClassName) | ||
|
|
||
| override fun <T : Any> getPolymorphic(baseClass: KClass<T>, serializedClassName: String): KSerializer<out T>? { | ||
| val standardPolymorphic = | ||
| if (baseClass == Any::class) StandardSubtypesOfAny.getDefaultDeserializer(serializedClassName) | ||
| else null | ||
|
|
||
| if (standardPolymorphic != null) return standardPolymorphic as KSerializer<out T> | ||
| return polyBase2NamedSerializers[baseClass]?.get(serializedClassName) as? KSerializer<out T> | ||
| } | ||
|
|
||
| override fun <T : Any> getContextual(kclass: KClass<T>): KSerializer<T>? = | ||
| class2Serializer[kclass] as? KSerializer<T> | ||
|
|
||
| override fun dumpTo(collector: SerialModuleCollector) { | ||
| class2Serializer.forEach { (kclass, serial) -> | ||
| collector.contextual( | ||
| kclass as KClass<Any>, | ||
| serial.cast() | ||
| ) | ||
| } | ||
|
|
||
| polyBase2Serializers.forEach { (baseClass, classMap) -> | ||
| classMap.forEach { (actualClass, serializer) -> | ||
| collector.polymorphic( | ||
| baseClass as KClass<Any>, | ||
| actualClass as KClass<Any>, | ||
| serializer.cast() | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| polyBase2DefaultProvider.forEach { (baseClass, provider) -> | ||
| collector.defaultPolymorphic(baseClass as KClass<Any>, provider as (PolymorphicProvider<out Any>)) | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.