🤔 안드로이드에서 JSON 처리

---

기존 안드로이드에서는 json 처리에
gson 과 Moshi 를 많이 사용한다.

나는 아직까지 gson이 편하고 바꿔야 할 필요성은 느끼지 못 했었는데
최근 Compose를 공부하면서
구글 프로젝트에서 json 처리를
Moshi -> kotlinx-serialization로 변경하는 추세를 보고
관심이 생겨 정리해볼려고 한다.

📌 kotlinx-serialization

---

💡 사용하는 이유

✅ reflective mode 코드 생성을 통해 Gson 및 Moshi 보다 빠른 런타임 성능
✅ annotation 프로세서가 아닌 컴파일러 플러그인을 사용하여 Moshi보다 빠른 빌드 시간
✅ 코틀린의 유형 시스템에 대한 지원 향상 및 무효값과 기본값에 대한 지원
✅ 별도의 라이브러리 모듈을 사용하여 다양한 인코딩 형식 지원

🌱 사용법

👉🏻 안드로이드 codelab - retrofit2 with kotlinx.serialization
👉🏻 kotlinx.serialization
👉 예시코드 github

1. json으로 역*직렬화 할 데이터 클래스 생성 @Serializable

import kotlinx.serialization.Serializable

@Serializable
data class Person(
    val name: String,
    val age: Int = 31,
    val sex: Char = 'M',
    val hobby: String = "Game of League of Legends"
)

2. JsonBuilder 옵션 설정

val json = Json {
    encodeDefaults = true // encode 시 디폴트 설정 값이 포함되서 인코딩 됨
    ignoreUnknownKeys = true // 코틀린 클래스로 변환 시 json 없는 프로퍼티는 무시 
}

public class JsonBuilder internal constructor(json: Json) {
    /**
     * Specifies whether default values of Kotlin properties should be encoded.
     * `false` by default.
     */
    public var encodeDefaults: Boolean = json.configuration.encodeDefaults

    /**
     * Specifies whether `null` values should be encoded for nullable properties and must be present in JSON object
     * during decoding.
     *
     * When this flag is disabled properties with `null` values without default are not encoded;
     * during decoding, the absence of a field value is treated as `null` for nullable properties without a default value.
     *
     * `true` by default.
     */
    @ExperimentalSerializationApi
    public var explicitNulls: Boolean = json.configuration.explicitNulls

    /**
     * Specifies whether encounters of unknown properties in the input JSON
     * should be ignored instead of throwing [SerializationException].
     * `false` by default.
     */
    public var ignoreUnknownKeys: Boolean = json.configuration.ignoreUnknownKeys

    /**
     * Removes JSON specification restriction (RFC-4627) and makes parser
     * more liberal to the malformed input. In lenient mode quoted boolean literals,
     * and unquoted string literals are allowed.
     *
     * Its relaxations can be expanded in the future, so that lenient parser becomes even more
     * permissive to invalid value in the input, replacing them with defaults.
     *
     * `false` by default.
     */
    public var isLenient: Boolean = json.configuration.isLenient

    /**
     * Enables structured objects to be serialized as map keys by
     * changing serialized form of the map from JSON object (key-value pairs) to flat array like `[k1, v1, k2, v2]`.
     * `false` by default.
     */
    public var allowStructuredMapKeys: Boolean = json.configuration.allowStructuredMapKeys

    /**
     * Specifies whether resulting JSON should be pretty-printed.
     *  `false` by default.
     */
    public var prettyPrint: Boolean = json.configuration.prettyPrint

    /**
     * Specifies indent string to use with [prettyPrint] mode
     * 4 spaces by default.
     * Experimentality note: this API is experimental because
     * it is not clear whether this option has compelling use-cases.
     */
    @ExperimentalSerializationApi
    public var prettyPrintIndent: String = json.configuration.prettyPrintIndent

    /**
     * Enables coercing incorrect JSON values to the default property value in the following cases:
     *   1. JSON value is `null` but property type is non-nullable.
     *   2. Property type is an enum type, but JSON value contains unknown enum member.
     *
     * `false` by default.
     */
    public var coerceInputValues: Boolean = json.configuration.coerceInputValues

    /**
     * Switches polymorphic serialization to the default array format.
     * This is an option for legacy JSON format and should not be generally used.
     * `false` by default.
     */
    public var useArrayPolymorphism: Boolean = json.configuration.useArrayPolymorphism

    /**
     * Name of the class descriptor property for polymorphic serialization.
     * "type" by default.
     */
    public var classDiscriminator: String = json.configuration.classDiscriminator

    /**
     * Removes JSON specification restriction on
     * special floating-point values such as `NaN` and `Infinity` and enables their serialization and deserialization.
     * When enabling it, please ensure that the receiving party will be able to encode and decode these special values.
     * `false` by default.
     */
    public var allowSpecialFloatingPointValues: Boolean = json.configuration.allowSpecialFloatingPointValues

    /**
     * Specifies whether Json instance makes use of [JsonNames] annotation.
     *
     * Disabling this flag when one does not use [JsonNames] at all may sometimes result in better performance,
     * particularly when a large count of fields is skipped with [ignoreUnknownKeys].
     * `true` by default.
     */
    public var useAlternativeNames: Boolean = json.configuration.useAlternativeNames

    /**
     * Module with contextual and polymorphic serializers to be used in the resulting [Json] instance.
     */
    public var serializersModule: SerializersModule = json.serializersModule

3. 인코드 디코드

// kClass -> json (encode)
private fun encodePersonToJson(json: Json) {
    val person = Person(
        name = "david"
    )
    println("=======================Encode=======================")
    println("person: $person")
    println("Encode process")
    println("json: ${json.encodeToString(person)}")
    println("====================================================")
}

// 결과
=======================Encode=======================
person: Person(name=david, age=31, sex=M, hobby=Game of League of Legends)
Encode process
json: {"name":"david","age":31,"sex":"M","hobby":"Game of League of Legends"}
====================================================

// json -> kClass (decode)
private fun decodeJsonToPerson(json: Json) {
    val jsonPerson = """
        {
            "name" : "david"
            "age" : 32
            "address" : "incheon" // Person에 없는 프로퍼티
        }
    """
    val person = json.decodeFromString<Person>(jsonPerson)
    println("=======================Decode=======================")
    println("json: $jsonPerson")
    println("Decode process")
    println("person: $person")
    println("====================================================")
}

// 결과
=======================Decode=======================
json: 
        {
            "name" : "david"
            "age" : 32
            "address" : "incheon"
        }
    
Decode process
person: Person(name=david, age=32, sex=M, hobby=Game of League of Legends) 👈🏻 "address" 프로퍼티 무시
====================================================

⚡️ sealed class와 함께 사용

0. 다양하게 내려오는 타입의 json

1. 다양한 타입을 클래스로 나누기 위해 sealed class 생성

package advanced

import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable

@Serializable
sealed class ViewType

@Serializable
@SerialName("vt001") // 구분 명시자를 알려줌
data class VT001(
    val title: String,
    val data: List<String>
): ViewType()

@Serializable
@SerialName("vt002") // 구분 명시자를 알려줌
data class VT002(
    val title: String,
    val keyword: String
): ViewType()


@Serializable
@SerialName("vt003") // 구분 명시자를 알려줌
data class VT003(
    val title: String,
    val data: List<String>,
    val views: Int
): ViewType()

2. JsonBuilder 옵션 설정 > classDiscriminator

val json = Json {
   ...
   classDiscriminator = "viewType" // viewType으로 구분
}

3. Decode 하기

expectJsonDecodeLog<VT003>(json) {
        """
            {
                "viewType" : "vt003",
                "title" : "인기 콘텐츠",
                "data" : [
                    "연애참견", "재벌집 막내 아들", "종이의 집"
                ],
                "views" : 200
            } 
        """
}

// 결과
expect type[VT003] 
JsonDecode type[VT003] 
JsonDecode classInfo > VT003(title=인기 콘텐츠, data=[연애참견, 재벌집 막내 아들, 종이의 집], views=200) 👈🏻 "VT003 클래스로 변환됨"

👋🏻 포스트를 마치며

---

• 사용했을 때 좋은 점
• 기본 사용법
• sealed class 사용법

공유하며 느낀 점은 다양한 타입을 지원하면서
코틀린을 사용할 때 기본값과 서버에 대한 처리과 귀찮은 것들이
상당히 편리하게 느껴졌습니다.

개발하며 위의 내용에서 조금 더 추가적으로 공유 해보도록 하겠습니다.