Kotlin Serialization and Json (Android)
October 11, 2019Setup
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:
- algo-trading
- algolia
- analytics
- android
- android-ktx
- android-permission
- android-studio
- apps-script
- bash
- binance
- bootstrap
- bootstrapvue
- chartjs
- chrome
- cloud-functions
- coding-interview
- contentresolver
- coroutines
- crashlytics
- crypto
- css
- dagger2
- datastore
- datetime
- docker
- eslint
- firebase
- firebase-auth
- firebase-hosting
- firestore
- firestore-security-rules
- flask
- fontawesome
- fresco
- git
- github
- glide
- godot
- google-app-engine
- google-cloud-storage
- google-colab
- google-drive
- google-maps
- google-places
- google-play
- google-sheets
- gradle
- html
- hugo
- inkscape
- java
- java-time
- javascript
- jetpack-compose
- jetson-nano
- kotlin
- kotlin-serialization
- layout
- lets-encrypt
- lifecycle
- linux
- logging
- lubuntu
- markdown
- mate
- material-design
- matplotlib
- md5
- mongodb
- moshi
- mplfinance
- mysql
- navigation
- nginx
- nodejs
- npm
- nuxtjs
- nvm
- pandas
- payment
- pip
- pwa
- pyenv
- python
- recylerview
- regex
- room
- rxjava
- scoped-storage
- selenium
- social-media
- ssh
- ssl
- static-site-generator
- static-website-hosting
- sublime-text
- ubuntu
- unit-test
- uwsgi
- viewmodel
- viewpager2
- virtualbox
- vue-chartjs
- vue-cli
- vue-router
- vuejs
- vuelidate
- vuepress
- web-development
- web-hosting
- webpack
- windows
- workmanager
- wsl
- yarn