[Android] Room을 이용하여 로컬 데이터베이스 저장하기

🧐 Room?

 로컬 데이터베이스를 이용하는 방법 중 하나는 안드로이드에서 기본적으로 제공하는 데이터베이스인 SQLite가 있다.

하지만 구글에서 2017년 AAC(Android Architecture Components)를 내놓음으로 SQLite를 직접 사용하여 구현하는 것보다 Room을 사용할 것을 권장했다. 권장 사유는 아래 안드로이드 SQLite 공식 문서 Caution 내용을 참고할 수 있었다.

SQLite 사용 전 caution (출처: developer.android.com)

1. SQL Query를 직접 작성했어야 했고, 이를 컴파일 시점에서 유효성 검증이 불가하다는 점
2. Database Scheme이 변경될 때 일일이 Query를 업데이트해야한다는 점
3. 데이터를 객체로 변환할 때 많은 boilerplate code를 작성해야한다는 점

 

 Room은 SQLite의 추상 레이어를 제공하여 모든 SQLite의 기능들을 이용할 수 있으면서 더 편하게 접근할 수 있게 해준다.

 당연하게 위에서 말했던 것처럼 객체로 데이터를 주고받을 수 있도록 설계되어 있으며, 직접 Query를 작성하지 않고도 기본적인 CRUD 작업을 쉽게 할 수 있다.

 또한 RxJava, LiveData, Flow와 같은 Observable 객체를 반환할 수 있도록 지원하며 테스팅 또한 편리하게 지원해준다.

 

---

👨‍👩‍👧‍👦 Room Component

 📌 Entity

 Entity는 데이터베이스에 저장할 데이터 구조를 정의하는 것이다.

즉, 데이터베이스 테이블 Column 정보이다. 여기서 정의된 데이터들이 모여 테이블을 구성하게 된다.

 

 @Entity 어노테이션이 설정된 Data class로 정의하면 된다.

@Entity(tableName = "CONTENT")
data class Todo(
    @PrimaryKey(autoGenerate = true) @ColumnInfo(name = "t_id") val tId: Int = 0,
    @ColumnInfo(name = "content") val content: String,
    @ColumnInfo(name = "is_checked") var isChecked: Boolean = false,
    @ColumnInfo(name = "created_at") val createdAt: Long = System.currentTimeMills()
)

 @Entity 어노테이션 Parameter에 테이블에 대해 여러 설정을 줄 수 있다. 해당 내용은 공식 문서(@Entity)를 참고하자.

위 코드에서는 tableName을 정의했으나 SQLite에서는 테이블 이름을 대소문자 구별하지 않으며, default 값은 데이터 클래스 이름이 되므로 클래스 이름과 동일하다면 작성할 필요가 없다.

 

 Room Entity는 반드시 1개 이상의 PrimaryKey가 필요하다. 해당 Field에 @PrimaryKey 어노테이션을 사용하면 된다.

PrimaryKey의 속성에는 autoGenerate가 있다. true로 할 경우 유니크한 값을 자동으로 만들어준다.

@Entity의 속성에 Primary Keys를 어레이 형태로도 정의할 수 있음으로 필요시 문서를 확인해보자.

 

 @ColumInfo 어노테이션은 Field 값의 속성을 명시할 수 있다.

Kotlin의 네이밍 컨벤션은 camelCase이지만, 데이터베이스에선 보통 snake_case를 사용하기에 이름을 변경해줬다.

Default는 field 이름이 된다. 이외의 속성은 공식 문서(@ColumInfo)를 참고하자.

 

 

 📌 DAO(Data Access Object)

 Room에서는 데이터베이스에 직접 접근하지 않고 DAO라는 객체를 정의하여 접근해야한다.

 DAO는 무조건 Interface 또는 Abstract class로 정의되어야 한다. 컴파일 시점에서 DAO 어노테이션을 찾아 구현하기 때문이다.

또한, 이를 통해 쿼리 오류를 컴파일 시점에서 발견할 수 있다.

 

 Entity에 대해 자동완성을 지원하기에 Query 작성시에 오타를 줄여주기도 한다.

 

@Dao
interface TodoDao {
    @Insert
    fun insertTodoContent(vararg todo: Todo)

    @Delete
    fun deleteTodoContent(todo: Todo)

    @Update
    fun updateTodoCheckState(todo: Todo)
    
    @Query("SELECT * FROM CONTENT ORDER BY created_at DESC")
    fun getTodoContents(): List<Todo>
}

 @Dao 어노테이션을 이용하여 Room에게 DAO class임을 알려준다.

 

 @Insert 어노테이션을 메소드에 지정할 경우 모든 매개변수를 삽입하는 구현을 자동으로 만들어준다.

여러 매개변수 타입을 가질 수 있다는 특성으로 단일 객체 또는 배열 형태 등 모든 데이터 입력이 가능하다.

위 코드에서는 vararg 가변 인자를 통해 여러 객체를 받도록 하였다.

 Insert 속성으로 충돌이 발생했을 때 어떻게 처리할 것인지에 대한 옵션을 설정할 수 있다.

Option	Description
ABORT (default)	트랜잭션을 롤백한다.
REPLACE	기존 rows를 새로운 rows로 대체한다.
IGNORE	기존 rows를 지킨다.(무시한다)

@Insert(OnConflict = OnConflictStrategy.IGNORE)
fun insertTodoContent(vararg todo: Todo)

 위와 같이 사용할 수 있으며 더 자세한 내용은 공식 문서(@Insert)를 참고하자.

 

 @Delete 어노테이션은 데이터를 삭제할 때 사용한다. PrimaryKey에 매칭되는 Entity를 찾아 값을 삭제한다.

 

 @Update 어노테이션은 데이터를 갱신할 때 사용한다. Delete와 마찬가지로 PrimaryKey에 매칭되는 값을 찾는다.

 

 @Query 어노테이션은 직접 Query를 작성하여 SQL을 작동시킬 때 사용한다.

데이터를 불러올 때 주로 사용되며 R/W 작업을 모두 실행할 수 있다.

 Parameter를 이용하여 아래와 같이 Query를 작성할 수도 있다. parameter가 LIKE절 뒤에 콜론과 함께 사용되는 것을 볼 수 있다.

@Query("SELECT * FROM CONTENT WHERE content LIKE :content ORDER BY created_at DESC")
fun getTodoMatchingContents(content: String): List<Todo>

 

 * Flow, LiveData, Rxjava2 등의 Observable 객체로도 반환이 가능하며, PagingSource(Paging 3) 객체도 최근 지원하기 시작했다.

 

 

 📌 Database

  Database는 실제 데이터베이스에 연결을 위한 액세스 포인트 역할을 한다.

@Database(entities = [Todo::class], version = 1)
abstract class AppDatabase: RoomDatabase() {

    abstract fun getTodoDao(): TodoDao

    companion object {
        @Volatile private var instance: AppDatabase? = null

        fun getInstance(context: Context): AppDatabase {
            return instance ?: synchronized(this) {
                instance ?: buildDatabase(context).also { instance = it }
            }
        }

        private fun buildDatabase(context: Context): AppDatabase {
            return Room.databaseBuilder(context, AppDatabase::class.java, "todo.db")
            	//.allowMainThreadQueries()
                .build()
        }
    }
}

 Database 클래스는 RoomDatabase를 상속받는 Abstract class이어야 한다.

클래스에는 @Database 어노테이션이 포함되어야 하며 속성에는 데이터베이스에 사용될 Entity들을 어레이 형식으로 담는다.

또한 Database version을 관리한다. 데이터 Scheme이 변경되었을 때 Migration과 같은 작업을 수월히 수행한다.

 

 데이터베이스 객체를 singleton으로 선언하는 것이 바람직하다. 데이터베이스에 접근할 때마다 객체를 생성하게 되면 이 자체에도 많은 비용이 들어가며, 구글 문서에 따르면 단일 프로세스 내에서 여러 인스턴스에 액세스할 필요가 거의 없다고 한다.

또한 서로 다른 스레드에서 데이터베이스를 한 번에 접근하려는 것을 막기 위해 synchronized를 통하여 동기화를 시켜줄 필요가 있다.

 

 Room.databaseBuilder() 또는 Room.inMemoryDatabaseBuilder()로 인스턴스를 얻을 수 있다. 후자는 프로세스 종료 시에 사라지는 메모리 형태의 데이터베이스이다.

 

 데이터베이스 작업은 UI performance가 저하되는 것을 막기위해 Main Thread에서의 작동을 허용하지 않고 있다.

Coroutine, RxJava, Thread 등 여러가지 방법이 있겠다.

Room 쿼리를 Flow<T>로 반환하게 될 경우 자동으로 Background Thread에서 실행되므로 이를 알아봐도 좋다.

 allowMainThreadQueries() 메소드를 통해서 Main Thread 작동을 가능하게 할 수 있으나 권장하지 않는다.

주석으로 남겨둔 이유는 위 방법들을 포스팅에서 설명해줄 수 없기 때문에 모르는데 빨리 사용해야할 사람들을 위해 남겨둔다.

다시 한번 말하지만 Main Thread에서의 작동을 권장하지 않는다.

AppDatabase().getInstace(context).getTodoDao().getTodoContents() 이렇게 사용하면된다 까지 알려줘야 할 것 같다.

 

---

🔗 Dependency

포스팅 작성 당시 최신 Stable 버전은 2.3.0이다. Release 페이지에서 최신 버전을 확인하자.

plugins {
	id 'kotlin-kapt'
}

dependencies {
    def room_version = "2.3.0"

    implementation "androidx.room:room-runtime:$room_version"
    kapt "androidx.room:room-compiler:$room_version"
}

 

---

📕 Reference & 함께하면 좋은 글

- Reference

안드로이드 공식 문서 - Room

Android Codelabs - Room with a View

 

- 함께하면 좋은 글

7 Pro-tips for Room in medium

No more LiveData in Your Repository: There are better options

Java Volatile 의미

 

---

 AAC를 포함한 Jetpack 라이브러리에 대하여 지속적으로 포스팅할 예정이다.

 Github Repository를 통하여 샘플 프로젝트를 라이브러리별로 관리(branch)할 것이므로 관심이 있으면 들려도 좋다. 깃허브 바로가기