📖 영구적 데이터 저장 방법 3가지

1. SharedPreferences

2. DB

3. 파일 형태

📖 Room

Room 말고 SQL 종류 중 하나인 SQLite가 있음
PC용 프로그램이 아니라 좀 가볍지만 SQLite를 쓰려면 복잡하다.
그래서 나온 게 Room이라는 라이브러리

SQLite를 쉽게 사용할 수 있는 DB 객체 매핑 라이브러리
Query를 직접 작성하지 않아도 됨
Query 결과를 LiveData로 하여 DB가 변경될 때마다 쉽게 UI를 변경할 수 있음
안드로이드에서 SQLite보다 Room을 사용할 것을 권장

📝 Room 주요 3요소

1. @Database

RoomDatabase를 상속받은 데이터베이스 클래스에 추가해야 하는 어노테이션

2. @Entity

Database 안 테이블을 만들기 위해 스키마로 지정하는 어노테이션

3. @Dao

클래스를 DAO로 지정하는 어노테이션
기본적인 insert, delete, update SQL은 자동으로 만들어주며 복잡한 SQL은 직접 만들 수 있음

📝 Room 사용하기

1. gradle 파일 설정

plugins {
    ...
    
    id("kotlin-kapt")
}

dependencies{

	....
    implementation("androidx.room:room-runtime:2.6.1")
    annotationProcessor("androidx.room:room-compiler:2.6.1")
    kapt("androidx.room:room-compiler:2.6.1")
    // optional - Kotlin Extensions and Coroutines support for Room
    implementation("androidx.room:room-ktx:2.6.1")
    // optional - Test helpers
    testImplementation("androidx.room:room-testing:2.6.1")
    

2. Database

Entity들과 데이터베이스 버전을 @Database 어노테이션에 지정함
기존 버전의 Database와의 동기화를 위해 버전을 맞춰주는 게 중요함
기존에 저장되어 있는 Database보다 버전이 높으면 Database를 open할 때 migration을 수행하게 됨
Migration을 통해 테이블을 추가하거나 변경함
Migration 수행 방법은 RoomDatabase 객체의 addmigration() 메소드를 통해 알려줌

3. Entity 생성

모든 DB는 테이블을 가지고 있고 그 테이블이 어떤 컬럼을 가지고 있는지 정의한 것이 스키마
Entity는 테이블 스키마 정의

4. DAO 생성

DAO는 interface나 abstract class로 정의되어야 함
Annotation에 SQL 쿼리를 정의하고 그 쿼리를 위한 메소드를 선언

가능한 annotation : @Insert, @Update, @Delete, @Query

@Insert, @Update, @Delete는 SQL 쿼리를 작성하지 않아도 컴파일러가 자동으로 생성함

➡Room을 쓰는 이유 중 하나

만약 @Insert, @Update 시 값이 중복됐을 때 처리할 옵션은 아래와 같음

• OnConflictStrategy.ABORT: key 충돌시 종료
• OnConflictStrategy.IGNORE: key 충돌 무시
• OnConflictStrategy.REPLACE: key 충돌시 새로운 데이터로 변경
• @Update나 @Delete는 primary key에 해당되는 튜플을 찾아서 변경/삭제 함

@Query로 리턴되는 데이터의 타입을 LiveData<>로 하면, 나중에 이 데이터가 업데이트될 때 Observer를 통해 할 수 있음

@Query에 SQL을 정의할 때 메소드의 인자를 사용할 수 있음

LiveData는 비동기적으로 동작하기 때문에 coroutine으로 할 필요가 없음

5. Migration

어느 버전에서 어느 버전으로 바뀔 때 어떤 동작을 할 지 정해줌

6. UI와 연결

RoomDatabase 객체에서 DAO 객체를 받아오고 이 DAO 객체의 메소드를 호출하여 데이터베이스를 접근함
UI 스레드에서 네트워크나 DB를 호출할 수 없기 때문에 coroutine을 쓰고runBlocking을 걸어놓음

7. UI와 연결-LiveData

LiveData<> 타입으로 리턴되는 DAO 메소드 경우
observe() 메소드를 이용해 Observer를 지정하고 데이터가 변경될 때마다 자동으로 호출됨

📝 Room 예제

1. Database 생성

RoomDatabase 상속받음

2. DAO 생성

쿼리 날릴 때 사용

3. MyEntity 생성

Student 클래스가 들어있음
student_id란 컬럼명으로

4. MainActivity

binding.queryStudent.setOnClickListener {
    val name = binding.editStudentName.text.toString()
    CoroutineScope(Dispatchers.IO).launch {

        val results = myDao.getStudentByName(name)

        if (results.isNotEmpty()) {
            val str = StringBuilder().apply {
                results.forEach { student ->
                    append(student.id)
                    append("-")
                    append(student.name)
                }
            }
            withContext(Dispatchers.Main) {
                binding.textQueryStudent.text = str
            }
        } else {
            withContext(Dispatchers.Main) {
                binding.textQueryStudent.text = ""
            }
        }
    }
}

withContext(Dispatchers.Main)으로 쌓여있는 이유
➡DB의 결과에 따라서 도는 루틴 자체가 Main UiThread가 아닌 별도의 Thread에서 동작하는 것이기 때문에 UI 업데이트를 MainThread에서 하기 위해서 withContext 사용

📌정리

RoomData를 쓰려면

Database 클래스 만들고
쿼리하는 Dao,
테이블 들어가는 Entity 만들어서

MainActivity에서 Database 인스턴스 생성하고
Dao 통해서 쿼리하고
결과를 받는다