Skip to content

Deserialization of kotlin singleton as singletons #244

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
package com.fasterxml.jackson.module.kotlin

import com.fasterxml.jackson.databind.BeanDescription
import com.fasterxml.jackson.databind.DeserializationConfig
import com.fasterxml.jackson.databind.JsonDeserializer
import com.fasterxml.jackson.databind.deser.BeanDeserializerModifier

object KotlinBeanDeserializerModifier: BeanDeserializerModifier() {
override fun modifyDeserializer(
config: DeserializationConfig,
beanDesc: BeanDescription,
deserializer: JsonDeserializer<*>
) = super.modifyDeserializer(config, beanDesc, deserializer)
.maybeSingletonDeserializer(objectSingletonInstance(beanDesc.beanClass))
}

fun JsonDeserializer<*>.maybeSingletonDeserializer(singleton: Any?) = when (singleton) {
null -> this
else -> this.asSingletonDeserializer(singleton)
}

private fun objectSingletonInstance(beanClass: Class<*>): Any? = if (!beanClass.isKotlinClass()) {
null
} else {
beanClass.kotlin.objectInstance
}
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ class KotlinModule(val reflectionCacheSize: Int = 512, val nullToEmptyCollection

context.addValueInstantiators(KotlinInstantiators(cache, nullToEmptyCollection, nullToEmptyMap))

context.addBeanDeserializerModifier(KotlinBeanDeserializerModifier)

fun addMixIn(clazz: Class<*>, mixin: Class<*>) {
context.setMixInAnnotations(clazz, mixin)
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
package com.fasterxml.jackson.module.kotlin

import com.fasterxml.jackson.core.JsonParser
import com.fasterxml.jackson.databind.BeanProperty
import com.fasterxml.jackson.databind.DeserializationContext
import com.fasterxml.jackson.databind.JsonDeserializer
import com.fasterxml.jackson.databind.deser.ContextualDeserializer
import com.fasterxml.jackson.databind.deser.ResolvableDeserializer

internal fun JsonDeserializer<*>.asSingletonDeserializer(singleton: Any) =
KotlinObjectSingletonDeserializer(singleton, this)

/** deserialize as normal, but return the canonical singleton instance. */
internal class KotlinObjectSingletonDeserializer(
private val singletonInstance: Any,
private val defaultDeserializer: JsonDeserializer<*>
) : JsonDeserializer<Any>(),
// Additional interfaces of a specific 'JsonDeserializer' must be supported
// Kotlin objectInstances are currently handled by a BeanSerializer which
// implements 'ContextualDeserializer' and 'ResolvableDeserializer'.
ContextualDeserializer,
ResolvableDeserializer {

override fun resolve(ctxt: DeserializationContext?) {
if (defaultDeserializer is ResolvableDeserializer) {
defaultDeserializer.resolve(ctxt)
}
}

override fun createContextual(ctxt: DeserializationContext?, property: BeanProperty?): JsonDeserializer<*> =
if (defaultDeserializer is ContextualDeserializer) {
defaultDeserializer.createContextual(ctxt, property)
.asSingletonDeserializer(singletonInstance)
} else {
this
}

override fun deserialize(p: JsonParser, ctxt: DeserializationContext): Any {
defaultDeserializer.deserialize(p, ctxt)
return singletonInstance
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
package com.fasterxml.jackson.module.kotlin.test

import com.fasterxml.jackson.databind.ObjectMapper
import com.fasterxml.jackson.databind.SerializationFeature
import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
import com.fasterxml.jackson.module.kotlin.readValue
import org.hamcrest.CoreMatchers.equalTo
import org.hamcrest.CoreMatchers.not
import org.hamcrest.MatcherAssert.assertThat
import org.junit.Test

class ObjectSingletonTest {

val mapper: ObjectMapper = jacksonObjectMapper()
.configure(SerializationFeature.INDENT_OUTPUT, false)

object Singleton {
var content = 1 // mutable state
}

@Test
fun deserializationPreservesSingletonProperty() {
val js = mapper.writeValueAsString(Singleton)
val newSingleton = mapper.readValue<Singleton>(js)

assertThat(newSingleton, equalTo(Singleton))
}

@Test
fun deserializationResetsSingletonObjectState() {
// persist current singleton state
val js = mapper.writeValueAsString(Singleton)
val initial = Singleton.content

// mutate the in-memory singleton state
val after = initial + 1
Singleton.content = after
assertThat(Singleton.content, equalTo(after))

// read back persisted state resets singleton state
val newSingleton = mapper.readValue<Singleton>(js)
assertThat(newSingleton.content, equalTo(initial))
assertThat(Singleton.content, equalTo(initial))
}

@Test
fun deserializedObjectsBehaveLikeSingletons() {
val js = mapper.writeValueAsString(Singleton)
val newSingleton = mapper.readValue<Singleton>(js)
assertThat(newSingleton.content, equalTo(Singleton.content))

newSingleton.content += 1;

assertThat(Singleton.content, equalTo(newSingleton.content))
}

}