Kotlin Serialization and Json (Android)

October 11, 2019

Setup

Edit Project build.gradle.

buildscript {
    ...

    dependencies {
        ...
        classpath "org.jetbrains.kotlin:kotlin-serialization:$kotlin_version"
    }
}

Edit Module:app build.gradle

...

apply plugin: 'kotlin-android'

apply plugin: 'kotlinx-serialization'

...

dependencies {
    ...

    implementation "org.jetbrains.kotlinx:kotlinx-serialization-runtime:0.13.0"

    ...
}

Apply the following to proguard-rules.pro.

-keepattributes *Annotation*, InnerClasses
-dontnote kotlinx.serialization.SerializationKt
-keep,includedescriptorclasses class com.yourcompany.yourpackage.**$$serializer { *; } # <-- change package name to your app's
-keepclassmembers class com.yourcompany.yourpackage.** { # <-- change package name to your app's
    *** Companion;
}
-keepclasseswithmembers class com.yourcompany.yourpackage.** { # <-- change package name to your app's
    kotlinx.serialization.KSerializer serializer(...);
}

Code

@Serializable
class Person(val name: String, @SerialName("nick_name") val nickName: String, val age: Int, val friends: List<String>)

// if json string has extra field which is not to be serialize into object, use non-strict mode

// val json = Json(JsonConfiguration.Stable)

val json = Json(JsonConfiguration.Stable.copy(strictMode = false))

// val json = Json.nonstrict


val jsonString = """{"name":"Desmond","nick_name":"King","age":40,"friends":["Jack","Mei Ru","Han"],"extra_field":"not used"}"""

val person = json.parse(Person.serializer(), jsonString)
val jsonData = json.stringify(Person.serializer(), person)

jsonData output

{"name":"Desmond","nick_name":"King","age":40,"friends":["Jack","Mei Ru","Han"]

References:

https://github.com/Kotlin/kotlinx.serialization

By Desmond Lua

A dream boy who enjoys programming and travelling, maker of Travelopy. Follow me on @d_luaz.

Tags:

Setup Android Kotlin Coroutines (1.1) With Coroutine Scope

Android Kotlin Coroutines Setup and Basic Usage

Setup Dagger 2 For Android Kotlin

Guide to learning Android Dev with Kotlin and Architecture Components (ViewModel, LiveData and Room)

Kotlin Coroutines Wait Task to Complete

Migrating to Android Kotlin 1.3 Coroutines

Android Standardize Context and Activity Property for Activity and Fragment

Kotlin Android Extentions ViewBinding for RecyclerView ViewHolder (LayoutContainer)

Kotlin Serialization: Json Parse JsonDecodingException (Encountered an unknown key x)

Kotlin Serialization: Json Parse MissingFieldException (Field 'x' is required, but it was missing)

Android Kotlin Auto Close Resource/Cursor on Exception

Kotlin Android Coroutine Context: Default Dispatcher vs Commonpool

Android Check File Exist (Kotlin)

Syntax To Inject Constructor For Kotlin