[TIL] 🌼24/04/09🌼#Moshi

[TIL] 🌼24/04/09🌼#Moshi

• 프로젝트에서 Json 직렬화/역직렬화에 Gson 라이브러리를 사용했으나, Gson 라이브러리에서 Moshi 라이브러리로 컨버팅하는게 좋겠다는 피드백을 받았다.
• 피드백을 반영하여, 오늘은 Shared Preferences 데이터 저장 로직에서 Gson -> Moshi 컨버팅을 해보았다.

Moshi 라이브러리

• 먼저 Moshi 라이브러리를 사용해야하는 이유에 대해 알아보았다.

📌참고자료

• 직렬화/역직렬화 , Gson vs Moshi | Hede
• Goodbye Gson👋, Hello Moshi🤗 | Reza
• Moshi, Moshi~ 직렬화를 원하신다구요? | 김성윤

Gson 라이브러리

• Java serialization/deserialization library to convert Java Objects into JSON and back
• 현재 maintenance mode

• Gson 직렬화 방식:
  • reflection 사용: 런타임에 객체의 필드에 접근하여 JSON으로 직렬화
  • 데이터 타입 인식: 객체의 데이터 타입 런타임에 확인
  • 유연한 사용: 커스텀 직렬화/역직렬화 구현에 유연

• Gson의 단점:
  • not Kotlin-friendly
    • 코틀린의 default value 무시
      (primitive 타입 default 값: 0, reference 타입 default 값: null)
    • 코틀린의 null-safety 준수하지 X
  • Moshi보다 method 수 많음 (Gson: ~1036개, Moshi: ~500개)
  • Moshi보다 용량 큼 (Gson: ~300kB, Moshi: ~120kB)
  • Java reflection 사용

Moshi 라이브러리

• A modern JSON library for Kotlin and Java

• Moshi 직렬화 방식:
  • 코드 생성 사용:
    • reflection 대신 코드 생성(code-gen) 사용
    • 컴파일 시점에 직렬화/역직렬화 로직 생성
  • 정적 타입 안정성:
    • Kotlin data class와 같은 정적 타입 안정성 지원
    • 컴파일러가 데이터 타입 확인 -> 런타임 시 데이터 타입 불일치 오류 방지
  • 불변(immutable) 객체 지원

• Moshi의 장점:
  • More human-readable serialization failed messages
  • built-in support for polymorphic datatypes
  • Code-gen adapter for Kotlin

프로젝트 리팩토링 (Gson -> Moshi)

📌참고자료: Moshi 관련 Exception error | Inflearn

리팩토링 전

• TourItemJsonConverter.kt

import com.google.gson.Gson
import com.google.gson.reflect.TypeToken

object TourItemJsonConverter {
    fun toJson(tourItem: TourItem): String {
        val serializedPair = tourItem.getContentTypeId() to Gson().toJson(tourItem)
        return Gson().toJson(serializedPair)
    }

    fun fromJson(json: String): TourItem {
        val type = object : TypeToken<Pair<String, String>>() {}.type
        val serializedPair: Pair<String, String> = Gson().fromJson(json, type)

        val tourItemType = when (serializedPair.first) {
            TourContentTypeId.TOURIST_DESTINATION.contentTypeId -> {
                object : TypeToken<TourItem.TouristDestination>() {}.type
            }
            TourContentTypeId.CULTURAL_FACILITIES.contentTypeId -> {
                object : TypeToken<TourItem.CulturalFacilities>() {}.type
            }
            TourContentTypeId.RESTAURANT.contentTypeId -> {
                object : TypeToken<TourItem.Restaurant>() {}.type
            }
            TourContentTypeId.LEISURE_SPORTS.contentTypeId -> {
                object : TypeToken<TourItem.LeisureSports>() {}.type
            }
            TourContentTypeId.EVENT_PERFORMANCE_FESTIVAL.contentTypeId -> {
                object : TypeToken<TourItem.EventPerformanceFestival>() {}.type
            }
            else -> {
                object : TypeToken<TourItem.TouristDestination>() {}.type
            }
        }
        return Gson().fromJson(serializedPair.second, tourItemType)
    }
}

리팩토링 후

• build.gradle(app)에 plugin & dependency 추가
  • kapt 대신 ksp plugin을 사용해야 build 오류가 안난다!

plugins {
    id("com.google.devtools.ksp").version("1.6.10-1.0.4")
}

dependencies {
    implementation("com.squareup.moshi:moshi:1.15.0")
    implementation("com.squareup.moshi:moshi-kotlin:1.14.0")
    ksp ("com.squareup.moshi:moshi-kotlin-codegen:1.8.0")
    implementation("com.squareup.moshi:moshi-adapters:1.9.2")
}

• data class에 @JsonClass(generateAdapter = true) 애노테이션 추가

• TourItemJsonConverter.kt
  • Polymorphic 타입 객체를 직렬화/역직렬화할 때 PolymorphicJsonAdapterFactory 사용!
  • 직렬화/역직렬화 에러 Moshi.JsonDataException 타입으로 catch해 stack trace 출력

import android.util.Log
import com.squareup.moshi.JsonDataException
import com.squareup.moshi.Moshi
import com.squareup.moshi.adapters.PolymorphicJsonAdapterFactory
import com.squareup.moshi.kotlin.reflect.KotlinJsonAdapterFactory

object TourItemJsonConverter {
    private val TAG = "TourItemJsonConverter"

    private val moshi = Moshi.Builder()
        .add(
            PolymorphicJsonAdapterFactory.of(TourItem::class.java, "tour_item_type")
                .withSubtype(TourItem.TouristDestination::class.java, "tourist_attraction")
                .withSubtype(TourItem.CulturalFacilities::class.java, "cultural_facilities")
                .withSubtype(TourItem.Restaurant::class.java, "restaurant")
                .withSubtype(TourItem.LeisureSports::class.java, "leisure_sports")
                .withSubtype(TourItem.EventPerformanceFestival::class.java, "event_performance_festival")
        )
        .add(KotlinJsonAdapterFactory())
        .build()

    fun toJson(tourItem: TourItem): String {
        Log.d(TAG, "toJson, TourItem:${tourItem.getTitle()}")
        return try{
            moshi.adapter(TourItem::class.java).toJson(tourItem)
        }catch (e:JsonDataException){
            e.printStackTrace()
            ""
        }
    }

    fun fromJson(json: String): TourItem? {
        Log.d(TAG, "fromJson, json: ${json}")
        return try {
            moshi.adapter(TourItem::class.java).fromJson(json)
        }catch (e:JsonDataException){
            e.printStackTrace()
            null
        }
    }
}