지난 글에서 to-do 앱을 ViewModel + StateFlow로 정리했다. 근데 todoList는 여전히 앱을 실행할 때마다 코드 안의 고정값(장보기, 운동하기, 책 읽기)으로 다시 채워진다. 앱을 껐다 켜도 할 일이 남아있게 하려면, 메모리가 아니라 디스크에 저장해야 한다. Room을 쓰면 된다.

의존성 추가

Room은 Kotlin Symbol Processing(KSP)으로 코드를 자동 생성한다. 먼저 프로젝트 최상위 build.gradle.kts에 KSP 플러그인을 추가한다.

// 최상위 build.gradle.kts
plugins {
    id("com.google.devtools.ksp") version "2.3.4" apply false
}

그다음 앱 모듈 build.gradle.kts에 플러그인 적용과 의존성을 추가한다.

// app/build.gradle.kts
plugins {
    id("com.google.devtools.ksp")
}

dependencies {
    val roomVersion = "2.8.5"
    implementation("androidx.room:room-runtime:$roomVersion")
    implementation("androidx.room:room-ktx:$roomVersion")
    ksp("androidx.room:room-compiler:$roomVersion")
}

(KSP 플러그인 버전은 쓰는 Kotlin 버전과 맞춰야 해서, 실제로 적용할 때는 KSP 릴리즈 페이지에서 현재 Kotlin 버전에 맞는 걸 확인해야 한다.)

Todo를 테이블로 선언하기

import androidx.room.Entity
import androidx.room.PrimaryKey

@Entity(tableName = "todo")
data class Todo(
    @PrimaryKey(autoGenerate = true) val id: Int = 0,
    val title: String,
    val isDone: Boolean = false
)

지금까지는 nextId를 직접 관리하면서 id를 하나씩 매겼는데, @PrimaryKey(autoGenerate = true)를 쓰면 Room이 새 행을 넣을 때마다 알아서 번호를 매겨준다. 그래서 새로 만들 때는 id = 0으로 두면 된다(Room이 자동 생성 대상이라는 걸 알아보는 값이다).

Dao - 디비에 할 질문과 요청을 정의한다

import androidx.room.Dao
import androidx.room.Delete
import androidx.room.Insert
import androidx.room.Query
import androidx.room.Update
import kotlinx.coroutines.flow.Flow

@Dao
interface TodoDao {
    @Query("SELECT * FROM todo ORDER BY id")
    fun getAll(): Flow<List<Todo>>

    @Insert
    suspend fun insert(todo: Todo)

    @Update
    suspend fun update(todo: Todo)

    @Delete
    suspend fun delete(todo: Todo)
}

getAll()이 Flow<List<Todo>>를 돌려준다는 게 중요하다. 한 번 조회해서 끝나는 게 아니라, 테이블 내용이 바뀔 때마다 Room이 알아서 새 리스트를 흘려보내 준다. insert, update, delete는 디스크에 쓰는 작업이라 시간이 걸릴 수 있어서 suspend로 선언한다.

Database

import androidx.room.Database
import androidx.room.RoomDatabase

@Database(entities = [Todo::class], version = 1)
abstract class TodoDatabase : RoomDatabase() {
    abstract fun todoDao(): TodoDao
}

ViewModel을 Room에 연결하기

import android.app.Application
import androidx.lifecycle.AndroidViewModel
import androidx.lifecycle.viewModelScope
import androidx.room.Room
import kotlinx.coroutines.flow.SharingStarted
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.flow.map
import kotlinx.coroutines.flow.stateIn
import kotlinx.coroutines.launch

class TodoViewModel(application: Application) : AndroidViewModel(application) {
    private val dao = Room.databaseBuilder(application, TodoDatabase::class.java, "todo.db")
        .build()
        .todoDao()

    val uiState: StateFlow<TodoUiState> = dao.getAll()
        .map { todoList -> TodoUiState(todoList = todoList) }
        .stateIn(
            scope = viewModelScope,
            started = SharingStarted.WhileSubscribed(5000),
            initialValue = TodoUiState(isLoading = true)
        )

    fun addTodo(title: String) {
        if (title.isBlank()) return
        viewModelScope.launch { dao.insert(Todo(title = title)) }
    }

    fun toggleDone(todo: Todo) {
        viewModelScope.launch { dao.update(todo.copy(isDone = !todo.isDone)) }
    }

    fun deleteTodo(todo: Todo) {
        viewModelScope.launch { dao.delete(todo) }
    }
}

[이미지: 할 일을 추가한 뒤 앱을 완전히 종료하고 다시 켜도 목록이 남아있는 모습]

ViewModel이 AndroidViewModel로 바뀌었다. Room.databaseBuilder로 DB를 만들려면 Context가 필요한데, AndroidViewModel은 application을 통해 그 Context를 제공해준다. viewModel() 컴포저블 함수는 이런 AndroidViewModel도 알아서 만들어주기 때문에, 호출하는 쪽 코드는 그대로 viewModel()만 쓰면 된다.

dao.getAll()이 주는 Flow를 .map { ... }으로 TodoUiState로 감싸고, .stateIn(...)으로 StateFlow로 바꿨다. SharingStarted.WhileSubscribed(5000)은 "구독하는 화면이 있는 동안, 그리고 마지막 구독자가 사라진 뒤 5초 동안은 계속 디비를 보고 있다가, 그 뒤로 보는 사람이 없으면 멈춘다"는 뜻이다. 화면이 잠깐 꺼졌다가 바로 켜지는 경우에 매번 처음부터 다시 조회하지 않게 해준다.

근데 toggleDone, deleteTodo가 id 대신 todo 객체 전체를 받는다

fun toggleDone(todo: Todo) { ... }  // id: Int가 아니라 todo: Todo

6번 글에서는 화면 이동할 때 "객체를 통째로 넘기지 말고 id만 넘겨라"고 했는데, 지금은 반대로 id가 아니라 객체 전체를 받고 있다. 이유가 다르다. @Update, @Delete는 넘겨받은 객체의 기본키(id)로 "어떤 행인지"를 찾긴 하지만, 나머지 칼럼 값도 그 객체에 있는 값으로 통째로 덮어쓴다. id만 던져주면 Room은 제목이 뭐였는지, 완료 상태가 뭐였는지 알 방법이 없다. 그래서 toggle 같은 "일부만 바꾸는" 작업도, 결국 전체 객체를 가져와서 그 중 한 필드만 copy()로 바꾼 다음 통째로 다시 넘겨야 한다.

반면 화면 이동(navigate)은 그 화면이 알아서 최신 데이터를 다시 조회하게 만드는 게 목적이라 id만 넘기는 게 맞았다. 상황에 따라 "열쇠만 넘기는 게 맞을 때"와 "전체를 넘겨야 할 때"가 다르다는 것만 기억하면 된다.

이 변경에 맞춰 TodoListScreen, TodoDetailScreen의 onToggleDone, onDelete 콜백 타입도 (Int) -> Unit에서 (Todo) -> Unit으로, 호출부도 onToggleDone(todo.id)에서 onToggleDone(todo)로 바뀐다. 나머지 코드 구조는 그대로다.

정리

• Flow<List<Todo>>를 돌려주는 Dao를 만들면, 테이블이 바뀔 때마다 자동으로 새 리스트가 흘러나온다
• .stateIn()으로 이 Flow를 StateFlow로 바꿔서 ViewModel에 노출한다
• @Update/@Delete는 객체 전체가 필요해서, 콜백도 id 대신 Todo 객체를 받는 쪽으로 바뀐다

다음 글에서는 다크 모드 같은 "값 하나짜리 설정"을 저장할 때 Room보다 더 가벼운 DataStore를 다뤄보겠다.