[Kotlin] Room db Migration 방법 + Gson 이용해 다양한 타입 데이터 저장하기

테이블에 사용자가 추가한 사진을 저장하기 위해 image column 이 추가될 필요성 생김

1.  Room에 데이터를 저장할 때는 기본적으로 primitive type과 그 wrapping 타입만 지원

하지만 나는 image uri의 path를 List로 저장을 하려고 한다

 

 

2. Gson 이용하여 TypeConverter 클래스 생성

TypeConverter

Room에 primitive type이 아닌 다른 타입의 데이터를 저장하기 위해선 Room에서 제공하는 TypeConverter 어노테이션을 사용하면 됩니다.

class Converters {
    @TypeConverter
    fun fromTimestamp(value: Long?): Date? {
        return value?.let { Date(it) }
    }
    
    @TypeConverter
    fun dateToTimestamp(date: Date?): Long? {
        return date?.time?.toLong()
    }
}

위 소스를 참고로 해서 만들었다.

package com.example.memolog.repository

import android.util.Log
import androidx.room.ProvidedTypeConverter
import com.google.gson.Gson

@ProvidedTypeConverter
class StringListTypeConverter(private val gson: Gson) {

    @androidx.room.TypeConverter
    fun listToJson(value: List<String>?): String? {
        return value?.let{ gson.toJson(value) }
    }

    @androidx.room.TypeConverter
    fun jsonToList(value: String?): List<String> {
        return if(value?.isEmpty() == true){ // "" 공백값
            Log.d("MemoDebug", "value==$value==")
            emptyList()
        }else{
            gson.fromJson(value, Array<String>::class.java).toList()
        }
    }

}

** isEmpty() 와 null 의 차이

Type변환 할때 자꾸 null이 들어와서 어떻게 Gson이 어떻게 변환해야 할지 몰라서 null 을 체크했어야 했다.

https://coding-mia.tistory.com/139

[Kotlin] Null vs Empty vs Blank

 

 

3. AppDatabase.kt 버전 올리기, 만든 TypeConverter 추가

@Database(
    entities = [Memo::class],
    version = 2
)
@TypeConverters(
    value = [StringListTypeConverter::class]
)
abstract class AppDatabase : RoomDatabase() {
    abstract fun memoDao(): MemoDao
}

 

4. Database 생성해주는 곳 가서 column 추가, migration 정의 및 추가

class GlobalApplication: Application() {
    companion object{
        lateinit var appInstance: GlobalApplication
            private set

        lateinit var databaseInstance: AppDatabase
            private set

        fun provideGson(): Gson {
            return Gson()
        }

        private val MIGRATION_1_2 = object : Migration(1, 2) {
            override fun migrate(database: SupportSQLiteDatabase) {
                database.execSQL("ALTER TABLE 'memo' ADD COLUMN 'image' TEXT NOT NULL DEFAULT ''")
            }
        }
    }

    override fun onCreate() {
        super.onCreate()
        appInstance = this

        databaseInstance = Room.databaseBuilder(
            appInstance.applicationContext,
            AppDatabase::class.java, "exampleApp.db"
        )
            //.fallbackToDestructiveMigration() // 이전에 생성한 데이터베이스를 삭제한 후 새로운 데이터베이스를 생성
            .allowMainThreadQueries()
            .addTypeConverter(StringListTypeConverter(provideGson()))
            .addMigrations(MIGRATION_1_2)
            .build()
    }
}

 

원래 내 의도는 image column 자체를 nullable 로 만들고 싶었는데, 그 방법을 아직 찾지 못해 일단 NOT NULL로 DEFAULT 값을 '' 공백을 넣어주었다. 

database.execSQL("ALTER TABLE 'memo' ADD COLUMN 'image' TEXT NOT NULL DEFAULT ''")

 

<Migration 적용 후>

기존 memo data 에서 image 컬럼이 추가되었다.

DEFAULT 로 '' 공백을 넣었기 때문에 아무 값이 없다.

 

새로운 data를 추가했더니 [""] 이 추가되었다. 

 

 

memo를 insert 하는 곳을 이렇게 추가 해줬다. 그래서 [""] 공백 리스트가 추가 되었다.

출처: https://leveloper.tistory.com/215 [꾸준하게]

 

---

데이터베이스 스키마변화 에러 문제해결

https://android-dev.tistory.com/49