Skip to content

Commit 60c632c

Browse files
sandwwraithsandwwraith
authored
Provide support for JsonNamingStrategy to be used in Json for properties' names. (#2111)
Provide a basic implementation of SnakeCase strategy Fixes #33
1 parent 694e2f7 commit 60c632c

File tree

21 files changed

+769
-61
lines changed

21 files changed

+769
-61
lines changed

‎benchmark/src/jmh/kotlin/kotlinx/benchmarks/json/TwitterFeedBenchmark.kt

+21-4
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ package kotlinx.benchmarks.json
33
import kotlinx.benchmarks.model.*
44
import kotlinx.serialization.*
55
import kotlinx.serialization.json.*
6-
import kotlinx.serialization.json.Json.Default.decodeFromString
7-
import kotlinx.serialization.json.Json.Default.encodeToString
86
import org.openjdk.jmh.annotations.*
97
import java.util.concurrent.*
108

@@ -24,19 +22,25 @@ open class TwitterFeedBenchmark {
2422
*/
2523
private val input = TwitterFeedBenchmark::class.java.getResource("/twitter_macro.json").readBytes().decodeToString()
2624
private val twitter = Json.decodeFromString(MacroTwitterFeed.serializer(), input)
25+
2726
private val jsonNoAltNames = Json { useAlternativeNames = false }
2827
private val jsonIgnoreUnknwn = Json { ignoreUnknownKeys = true }
29-
private val jsonIgnoreUnknwnNoAltNames = Json { ignoreUnknownKeys = true; useAlternativeNames = false}
28+
private val jsonIgnoreUnknwnNoAltNames = Json { ignoreUnknownKeys = true; useAlternativeNames = false }
29+
private val jsonNamingStrategy = Json { namingStrategy = JsonNamingStrategy.SnakeCase }
30+
private val jsonNamingStrategyIgnoreUnknwn = Json(jsonNamingStrategy) { ignoreUnknownKeys = true }
31+
32+
private val twitterKt = jsonNamingStrategy.decodeFromString(MacroTwitterFeedKt.serializer(), input)
3033

3134
@Setup
3235
fun init() {
3336
require(twitter == Json.decodeFromString(MacroTwitterFeed.serializer(), Json.encodeToString(MacroTwitterFeed.serializer(), twitter)))
3437
}
3538

36-
// Order of magnitude: ~400 op/s
39+
// Order of magnitude: ~500 op/s
3740
@Benchmark
3841
fun decodeTwitter() = Json.decodeFromString(MacroTwitterFeed.serializer(), input)
3942

43+
// Should be the same as decodeTwitter, since decodeTwitter never hit unknown name and therefore should never build deserializationNamesMap anyway
4044
@Benchmark
4145
fun decodeTwitterNoAltNames() = jsonNoAltNames.decodeFromString(MacroTwitterFeed.serializer(), input)
4246

@@ -46,7 +50,20 @@ open class TwitterFeedBenchmark {
4650
@Benchmark
4751
fun decodeMicroTwitter() = jsonIgnoreUnknwn.decodeFromString(MicroTwitterFeed.serializer(), input)
4852

53+
// Should be faster than decodeMicroTwitter, as we explicitly opt-out from deserializationNamesMap on unknown name
4954
@Benchmark
5055
fun decodeMicroTwitterNoAltNames() = jsonIgnoreUnknwnNoAltNames.decodeFromString(MicroTwitterFeed.serializer(), input)
5156

57+
// Should be just a bit slower than decodeMicroTwitter, because alternative names map is created in both cases
58+
@Benchmark
59+
fun decodeMicroTwitterWithNamingStrategy(): MicroTwitterFeedKt = jsonNamingStrategyIgnoreUnknwn.decodeFromString(MicroTwitterFeedKt.serializer(), input)
60+
61+
// Can be slower than decodeTwitter, as we always build deserializationNamesMap when naming strategy is used
62+
@Benchmark
63+
fun decodeTwitterWithNamingStrategy(): MacroTwitterFeedKt = jsonNamingStrategy.decodeFromString(MacroTwitterFeedKt.serializer(), input)
64+
65+
// 15-20% slower than without the strategy. Without serializationNamesMap (invoking strategy on every write), up to 50% slower
66+
@Benchmark
67+
fun encodeTwitterWithNamingStrategy(): String = jsonNamingStrategy.encodeToString(MacroTwitterFeedKt.serializer(), twitterKt)
68+
5269
}

‎benchmark/src/jmh/kotlin/kotlinx/benchmarks/model/MacroTwitterUntailored.kt

+170
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
package kotlinx.benchmarks.model
2+
3+
import kotlinx.serialization.*
4+
import kotlinx.serialization.json.*
5+
6+
/**
7+
* All model classes are the same as in MacroTwitter.kt but named accordingly to Kotlin naming policies to test JsonNamingStrategy performance.
8+
* Only Size, SizeType and Urls are not copied
9+
*/
10+
11+
@Serializable
12+
data class MacroTwitterFeedKt(
13+
val statuses: List<TwitterStatusKt>,
14+
val searchMetadata: SearchMetadata
15+
)
16+
17+
@Serializable
18+
data class MicroTwitterFeedKt(
19+
val statuses: List<TwitterTrimmedStatusKt>
20+
)
21+
22+
@Serializable
23+
data class TwitterTrimmedStatusKt(
24+
val metadata: MetadataKt,
25+
val createdAt: String,
26+
val id: Long,
27+
val idStr: String,
28+
val text: String,
29+
val source: String,
30+
val truncated: Boolean,
31+
val user: TwitterTrimmedUserKt,
32+
val retweetedStatus: TwitterTrimmedStatusKt? = null,
33+
)
34+
35+
@Serializable
36+
data class TwitterStatusKt(
37+
val metadata: MetadataKt,
38+
val createdAt: String,
39+
val id: Long,
40+
val idStr: String,
41+
val text: String,
42+
val source: String,
43+
val truncated: Boolean,
44+
val inReplyToStatusId: Long?,
45+
val inReplyToStatusIdStr: String?,
46+
val inReplyToUserId: Long?,
47+
val inReplyToUserIdStr: String?,
48+
val inReplyToScreenName: String?,
49+
val user: TwitterUserKt,
50+
val geo: String?,
51+
val coordinates: String?,
52+
val place: String?,
53+
val contributors: List<String>?,
54+
val retweetedStatus: TwitterStatusKt? = null,
55+
val retweetCount: Int,
56+
val favoriteCount: Int,
57+
val entities: StatusEntitiesKt,
58+
val favorited: Boolean,
59+
val retweeted: Boolean,
60+
val lang: String,
61+
val possiblySensitive: Boolean? = null
62+
)
63+
64+
@Serializable
65+
data class StatusEntitiesKt(
66+
val hashtags: List<Hashtag>,
67+
val symbols: List<String>,
68+
val urls: List<Url>,
69+
val userMentions: List<TwitterUserMentionKt>,
70+
val media: List<TwitterMediaKt>? = null
71+
)
72+
73+
@Serializable
74+
data class TwitterMediaKt(
75+
val id: Long,
76+
val idStr: String,
77+
val url: String,
78+
val mediaUrl: String,
79+
val mediaUrlHttps: String,
80+
val expandedUrl: String,
81+
val displayUrl: String,
82+
val indices: List<Int>,
83+
val type: String,
84+
val sizes: SizeType,
85+
val sourceStatusId: Long? = null,
86+
val sourceStatusIdStr: String? = null
87+
)
88+
89+
@Serializable
90+
data class TwitterUserMentionKt(
91+
val screenName: String,
92+
val name: String,
93+
val id: Long,
94+
val idStr: String,
95+
val indices: List<Int>
96+
)
97+
98+
@Serializable
99+
data class MetadataKt(
100+
val resultType: String,
101+
val isoLanguageCode: String
102+
)
103+
104+
@Serializable
105+
data class TwitterTrimmedUserKt(
106+
val id: Long,
107+
val idStr: String,
108+
val name: String,
109+
val screenName: String,
110+
val location: String,
111+
val description: String,
112+
val url: String?,
113+
val entities: UserEntitiesKt,
114+
val protected: Boolean,
115+
val followersCount: Int,
116+
val friendsCount: Int,
117+
val listedCount: Int,
118+
val createdAt: String,
119+
val favouritesCount: Int,
120+
)
121+
122+
@Serializable
123+
data class TwitterUserKt(
124+
val id: Long,
125+
val idStr: String,
126+
val name: String,
127+
val screenName: String,
128+
val location: String,
129+
val description: String,
130+
val url: String?,
131+
val entities: UserEntitiesKt,
132+
val protected: Boolean,
133+
val followersCount: Int,
134+
val friendsCount: Int,
135+
val listedCount: Int,
136+
val createdAt: String,
137+
val favouritesCount: Int,
138+
val utcOffset: Int?,
139+
val timeZone: String?,
140+
val geoEnabled: Boolean,
141+
val verified: Boolean,
142+
val statusesCount: Int,
143+
val lang: String,
144+
val contributorsEnabled: Boolean,
145+
val isTranslator: Boolean,
146+
val isTranslationEnabled: Boolean,
147+
val profileBackgroundColor: String,
148+
val profileBackgroundImageUrl: String,
149+
val profileBackgroundImageUrlHttps: String,
150+
val profileBackgroundTile: Boolean,
151+
val profileImageUrl: String,
152+
val profileImageUrlHttps: String,
153+
val profileBannerUrl: String? = null,
154+
val profileLinkColor: String,
155+
val profileSidebarBorderColor: String,
156+
val profileSidebarFillColor: String,
157+
val profileTextColor: String,
158+
val profileUseBackgroundImage: Boolean,
159+
val defaultProfile: Boolean,
160+
val defaultProfileImage: Boolean,
161+
val following: Boolean,
162+
val followRequestSent: Boolean,
163+
val notifications: Boolean
164+
)
165+
166+
@Serializable
167+
data class UserEntitiesKt(
168+
val url: Urls? = null,
169+
val description: Urls
170+
)

‎core/commonMain/src/kotlinx/serialization/Annotations.kt

+3
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,9 @@ public annotation class Serializer(
145145
* // Prints "{"int":42}"
146146
* println(Json.encodeToString(CustomName(42)))
147147
* ```
148+
*
149+
* If a name of class or property is overridden with this annotation, original source code name is not available for the library.
150+
* Tools like `JsonNamingStrategy` and `ProtoBufSchemaGenerator` would see and transform [value] from [SerialName] annotation.
148151
*/
149152
@Target(AnnotationTarget.PROPERTY, AnnotationTarget.CLASS)
150153
// @Retention(AnnotationRetention.RUNTIME) still runtime, but KT-41082

‎core/commonMain/src/kotlinx/serialization/descriptors/SerialDescriptor.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ public interface SerialDescriptor {
259259
public fun getElementDescriptor(index: Int): SerialDescriptor
260260

261261
/**
262-
* Whether the element at the given [index] is optional (can be absent is serialized form).
262+
* Whether the element at the given [index] is optional (can be absent in serialized form).
263263
* For generated descriptors, all elements that have a corresponding default parameter value are
264264
* marked as optional. Custom serializers can treat optional values in a serialization-specific manner
265265
* without default parameters constraint.

‎core/commonMain/src/kotlinx/serialization/internal/Tagged.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,7 @@ public abstract class NamedValueDecoder : TaggedDecoder<String>() {
331331
final override fun SerialDescriptor.getTag(index: Int): String = nested(elementName(this, index))
332332

333333
protected fun nested(nestedName: String): String = composeName(currentTagOrNull ?: "", nestedName)
334-
protected open fun elementName(desc: SerialDescriptor, index: Int): String = desc.getElementName(index)
334+
protected open fun elementName(descriptor: SerialDescriptor, index: Int): String = descriptor.getElementName(index)
335335
protected open fun composeName(parentName: String, childName: String): String =
336336
if (parentName.isEmpty()) childName else "$parentName.$childName"
337337
}

‎formats/json-tests/commonTest/src/kotlinx/serialization/features/JsonNamingStrategyExclusionTest.kt

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
package kotlinx.serialization.features
2+
3+
import kotlinx.serialization.*
4+
import kotlinx.serialization.json.*
5+
import kotlin.test.*
6+
7+
class JsonNamingStrategyExclusionTest : JsonTestBase() {
8+
@SerialInfo
9+
@Target(AnnotationTarget.CLASS, AnnotationTarget.PROPERTY)
10+
annotation class OriginalSerialName
11+
12+
private fun List<Annotation>.hasOriginal() = filterIsInstance<OriginalSerialName>().isNotEmpty()
13+
14+
private val myStrategy = JsonNamingStrategy { descriptor, index, serialName ->
15+
if (descriptor.annotations.hasOriginal() || descriptor.getElementAnnotations(index).hasOriginal()) serialName
16+
else JsonNamingStrategy.SnakeCase.serialNameForJson(descriptor, index, serialName)
17+
}
18+
19+
@Serializable
20+
@OriginalSerialName
21+
data class Foo(val firstArg: String = "a", val secondArg: String = "b")
22+
23+
enum class E {
24+
@OriginalSerialName
25+
FIRST_E,
26+
SECOND_E
27+
}
28+
29+
@Serializable
30+
data class Bar(
31+
val firstBar: String = "a",
32+
@OriginalSerialName val secondBar: String = "b",
33+
val fooBar: Foo = Foo(),
34+
val enumBarOne: E = E.FIRST_E,
35+
val enumBarTwo: E = E.SECOND_E
36+
)
37+
38+
private fun doTest(json: Json) {
39+
val j = Json(json) {
40+
namingStrategy = myStrategy
41+
}
42+
val bar = Bar()
43+
assertJsonFormAndRestored(
44+
Bar.serializer(),
45+
bar,
46+
"""{"first_bar":"a","secondBar":"b","foo_bar":{"firstArg":"a","secondArg":"b"},"enum_bar_one":"FIRST_E","enum_bar_two":"SECOND_E"}""",
47+
j
48+
)
49+
}
50+
51+
@Test
52+
fun testJsonNamingStrategyWithAlternativeNames() = doTest(Json(default) {
53+
useAlternativeNames = true
54+
})
55+
56+
@Test
57+
fun testJsonNamingStrategyWithoutAlternativeNames() = doTest(Json(default) {
58+
useAlternativeNames = false
59+
})
60+
}

0 commit comments

Comments
 (0)