[안드로이드] Jetpack의 Room DB이란? (사용법 예제)

Room DB란?

Room은 안드로이드 앱의 내장 DB에 데이터를 저장하기 위해 사용된다.

Jetpack 라이브러리 중 하나로 DB 데이터를 Java/Kotlin으로 변환하는 ORM 라이브러리이다.

Room은 SQLite의 추상 레이어 위에 제공하고 있으며, SQLite의 모든 기능을 제공하여 편한 데이터베이스 접근을 허용한다.

LiveData나 RxJava와 같이 Observation 형태도 지원하므로 아키텍쳐 패턴에도 적용이 매우 쉽다.

 

SharedPreferences와 차이

SharedPreferences도 앱의 로컬에 데이터를 저장할 수 있지만, 가벼운 데이터를저장할 목적으로 로컬 DB를 사용한다.

• 예를들어,
  서버와 통신할 때 쓸 String형 access_token을 저장할 때

  Room DB는 큰 사이즈의 데이터를 저장할 목적으로 사용한다.

 

Room 사용이 권장되는 이유

1. Room은 LiveData와 RxJava를 위한Observation으로 생성하여 동작할 수 있지만 SQLite는 그렇지 않다.
2. Room은 SQLite을 포함하고 있기 때문에 SQLite를 활용하여 데이터 접근이 편리하고 유지보수가 용이하며 마이그레이션도 간단하다.
3. SQLite와 달리 컴파일 타임에 쿼리의 적합성을 확인할 수 있다. 즉, SQLite보다 편리한 DB라고 생각하면 된다.

SQLite에 대한 더 자세한 내용은 아래 링크 참고

https://jay-din.tistory.com/4

[안드로이드] Local DB SQLite 이란? (사용법 예제)

 

Room의 3가지 구성요소    

반응형

Entity

• DB에서 Table을 나타낸다.
• @Entity로 선언한다.

Dao (Data Access Objects)

• 데이터에 Access 할 수 있는 Interface
• @Dao로 선언한다.

Room DataBase

• abstract class로 선언하고 Room Database를 상속 받는다.
• @Database로 선언한다.
• DB에서 사용될 테이블의 정보(entitiy)가 필요하고, version 정보가 필요하다.

@Database(entities = [TextEntity::class], version = 1)

• App이 업데이트 되어서 DB가 변경될 경우 이전 DB와구분이 필요하므로 version 에 int 값을 넣어서 관리한다.

 

사용 예제 

Build.gradle

id 'kotlin-kapt'

// ROOM
def roomVersion = "2.4.0"

implementation("androidx.room:room-runtime:$roomVersion")
annotationProcessor("androidx.room:room-compiler:$roomVersion")

// To use Kotlin annotation processing tool (kapt)
kapt("androidx.room:room-compiler:$roomVersion")

// Coroutine
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:1.6.0")

TextEntity.kt

• Entity는 실체(객체)이다. 흔히 데이터베이스에서 개념 스키마를 뜻하며 쉽게 테이블이라고 생각하면 된다. 
• data class를 정의하고 @Entity 어노테이션을 표시한다.
• Entity에는 하나 이상의 기본키를 설정해야 하며, @PrimaryKey로 선언된 변수가 기본키다.
• 기본키는 복합키로 이루어질 수 있으며 아래와 같이 어노테이션에서 설정해주면 된다.

@Entity(primaryKeys = arrayOf("firstName", "lastName"))

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

// 테이블 이름 설정
@Entity(tableName = "text_table")
data class TextEntity(

    @PrimaryKey(autoGenerate = true)
    // @CcolumnInfo
    // 기본적으로 변수 이름이 열 이름이 된다. 만약 별도로 열 이름을 설정하고 싶다면 name 속성을 주면 된다
    @ColumnInfo(name = "id")
    var id: Int,
    @ColumnInfo(name = "text")
    var text: String

)

TextDao.kt

• DAO 를 통해 쿼리문을 사용하여 데이터베이스의 데이터에 접근할 수 있다.
• DAO 로 정의하기 위해선 @Dao라는 어노테이션이 필요하며, 인터페이스로 작성된다.
• @Query 를 통해 직접 SQL을 작성할 수 있다. 그 외에도 @Insert @Delete @Update 등으로 간편하게 구현할 수 있는 기능을 제공한다.
• 활용 방법이 많으니 자세한건 안드로이드 개발자 문서를 찾아보는 것을 추천한다.

import androidx.room.Dao
import androidx.room.Insert
import androidx.room.OnConflictStrategy
import androidx.room.Query

@Dao
interface TextDao {

    @Query("SELECT * FROM text_table")
    fun getAllData(): List<TextEntity>

    @Insert(onConflict = OnConflictStrategy.IGNORE)
    fun insert(text: TextEntity)

    @Query("DELETE FROM text_table")
    fun deleteAllData()

}

TextDatabase.kt   

Room 에서 데이터베이스를 정의하기 위해서는 @Database 를 사용하며 클래스는 추상 클래스로 작성되어야 한다.

추상 클래스는 RoomDatabse() 를 상속해야 하며 매개 변수가 없는 추상 메서드를 포함해야 한다.

어노테이션에는 데이터베이스와 연결된 항목의 목록과 버전을 포함해야 한다. 

import android.content.Context
import androidx.room.Database
import androidx.room.Room
import androidx.room.RoomDatabase

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

    abstract fun textDao() : TextDao

    companion object{
        @Volatile
        private var INSTANCE : TextDatabase? = null

        fun getDatabase(
            context : Context
        ) : TextDatabase{
            return INSTANCE ?: synchronized(this){
                val instance = Room.databaseBuilder(
                    context.applicationContext,
                    TextDatabase::class.java,
                    "text_database"
                )
                    .fallbackToDestructiveMigration()
                    .build()
                INSTANCE = instance
                instance
            }
        }
    }
}

반응형

 

MainActivity.kt

여기서 코루틴을 사용하는 이유는 보다시피 동작을 할 때마다 로그를 통해 데이터를 가져오고 있다.

이 때 코루틴을 사용하지 않으면 아래와 같은 오류를  만나게 된다.

 java.lang.IllegalStateException: Cannot access database on the main thread since it may potentially lock the UI for a long period of time.

원인은 안드로이드데이터베이스 쿼리가 메인 스레드를 점유할 것을 염려하여 메인 스레드가 아닌 다른 스레드에서 쿼리를 실행할 것을 강요하는 것이다.

따라서 쿼리를 CoroutineScope 내부에서 실행하면 코루틴은 IO 스레드를 사용하기 때문에 에러를 피할 수 있다.

import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import android.util.Log
import android.widget.Button
import android.widget.EditText
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.launch

class  MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        val db = TextDatabase.getDatabase(this)

        val inputArea = findViewById<EditText>(R.id.textInputArea)
        val insertBtn = findViewById<Button>(R.id.insert)
        val getAllBtn = findViewById<Button>(R.id.getData)
        val deleteBtn = findViewById<Button>(R.id.delete)

		// 데이터 삽입
        insertBtn.setOnClickListener {
            CoroutineScope(Dispatchers.IO).launch {
                db.textDao().insert(TextEntity(0, inputArea.text.toString()))
                Log.d("MainActivity", db.textDao().getAllData().toString())
                inputArea.setText("")
            }

        }

		// 데이터 모두 가져오기
        getAllBtn.setOnClickListener {
            CoroutineScope(Dispatchers.IO).launch {
                Log.d("MainActivity", db.textDao().getAllData().toString())
            }
        }

		// 데이터 모두 삭제
        deleteBtn.setOnClickListener {
            CoroutineScope(Dispatchers.IO).launch {
                db.textDao().deleteAllData()
                Log.d("MainActivity", db.textDao().getAllData().toString())
            }
        }

    }

}

실행 결과

1. EditText에 hihi 입력하고 삽입한다.

2. hihi 를 한 번 더 삽입한다.

3. hello 를 삽입한다.

4. 데이터를  불러오기 버튼을 누르면 다음과 같이 출력된다.

[TextEntity(id=1, text=hihi), TextEntity(id=2, text=hihi), TextEntity(id=3, text=hello)]

5. 데이터 삭제를 누르면 다음과 같이 출력되어 결과를 알 수 있다.

[ ]

---

참고

https://velog.io/@limsaehyun/Android-Kotlin-Room-DB%EC%9D%98-%EC%82%AC%EC%9A%A9%EB%B2%95%EA%B3%BC-%EC%98%88%EC%A0%9C

Android Kotlin | Room DB의 사용법과 예제

https://kong-droid.com/41

[Kotlin/Android] Room 사용하기

https://latte-is-horse.tistory.com/155

[Kotlin] Room 사용법 (Android에서 로컬 데이터베이스 사용하기)

https://hydroponicglass.tistory.com/entry/Android-Kotlin-Cannot-access-database-on-the-main-thread-since-it-may-potentially-lock-the-UI-for-a-long-period-of-time