SQLite에서 Room으로 이전

Room 지속성 라이브러리를 사용하면 SQLite API를 직접 사용하는 것보다 여러 가지 이점이 있습니다.

  • SQL 쿼리의 컴파일 시간 확인
  • 반복적이고 오류가 발생하기 쉬운 상용구 코드를 최소화하는 편의 주석
  • 간소화된 데이터베이스 이전 경로

앱에서 현재 Room이 아닌 SQLite 구현을 사용한다면 이 페이지에서 Room을 사용하도록 앱을 이전하는 방법을 알아보세요. 앱에서 사용하는 첫 번째 SQLite 구현이 Room이라면 기본 사용법 정보는 Room을 사용하여 로컬 데이터베이스에 데이터 저장을 참고하세요.

이전 단계

다음 단계를 따라 SQLite 구현을 Room으로 이전하세요. SQLite 구현에서 대규모 데이터베이스나 복잡한 쿼리를 사용한다면 점진적으로 Room으로 이전하는 것이 좋습니다. 증분 이전 전략은 증분 이전을 참고하세요.

종속 항목 업데이트

앱에서 Room을 사용하려면 적절한 종속 항목을 앱의 build.gradle 파일에 포함해야 합니다. 최신 Room 종속 항목은 설정을 참고하세요.

모델 클래스를 데이터 항목으로 업데이트

Room은 데이터 항목을 사용하여 데이터베이스의 테이블을 나타냅니다. 각 항목 클래스는 테이블 하나를 나타내며 해당 테이블의 열을 의미하는 필드가 있습니다. 다음 단계를 따라 기존 모델 클래스를 Room 항목으로 업데이트하세요.

  1. 클래스 선언에 @Entity 주석을 달아 Room 항목임을 표시합니다. 선택적으로 tableName 속성을 사용하여 결과 테이블의 이름이 클래스 이름과 달라야 한다고 표시할 수 있습니다.
  2. 기본 키 필드에 @PrimaryKey 주석을 답니다.
  3. 결과 테이블의 열 중 하나라도 이름이 상응하는 필드의 이름과 달라야 한다면 해당 필드에 @ColumnInfo 주석을 달고 name 속성을 올바른 열 이름으로 설정합니다.
  4. 데이터베이스에 유지하지 않으려는 필드가 클래스에 있다면 해당 필드에 @Ignore 주석을 달아 Room이 상응하는 테이블에 관련 열을 만들지 않도록 표시해 줍니다.
  5. 클래스에 생성자 메서드가 2개 이상 있으면 나머지 생성자에 모두 @Ignore 주석을 달아 Room이 사용해야 하는 생성자를 표시합니다.

Kotlin

@Entity(tableName = "users")
data class User(
  @PrimaryKey
  @ColumnInfo(name = "userid") val mId: String,
  @ColumnInfo(name = "username") val mUserName: String?,
  @ColumnInfo(name = "last_update") val mDate: Date?,
)

Java

@Entity(tableName = "users")
public class User {

  @PrimaryKey
  @ColumnInfo(name = "userid")
  private String mId;

  @ColumnInfo(name = "username")
  private String mUserName;

  @ColumnInfo(name = "last_update")
  private Date mDate;

  @Ignore
  public User(String userName) {
    mId = UUID.randomUUID().toString();
    mUserName = userName;
    mDate = new Date(System.currentTimeMillis());
  }

  public User(String id, String userName, Date date) {
    this.mId = id;
    this.mUserName = userName;
    this.mDate = date;
  }

}

DAO 만들기

Room은 데이터 액세스 객체(DAO)를 사용하여 데이터베이스에 액세스하는 메서드를 정의합니다. Room DAO를 사용하여 데이터 액세스에 설명된 안내에 따라 기존 쿼리 메서드를 DAO로 바꿉니다.

데이터베이스 클래스 만들기

Room 구현에서는 데이터베이스 클래스를 사용하여 데이터베이스 인스턴스를 관리합니다. 데이터베이스 클래스는 RoomDatabase를 확장하고 개발자가 정의한 항목과 DAO를 모두 참조해야 합니다.

Kotlin

@Database(entities = [User::class], version = 2)
@TypeConverters(DateConverter::class)
abstract class UsersDatabase : RoomDatabase() {
    abstract fun userDao(): UserDao
}

Java

@Database(entities = {User.class}, version = 2)
@TypeConverters(DateConverter.class)
public abstract class UsersDatabase extends RoomDatabase {
  public abstract UserDao userDao();
}

이전 경로 정의

데이터베이스 버전 번호가 변경되므로 Room에서 데이터베이스에 기존 데이터를 유지하도록 Migration 객체를 정의하여 이전 경로를 표시해야 합니다. 데이터베이스 스키마가 변경되지 않는 한 이 구현은 빈 구현일 수 있습니다.

Kotlin

val MIGRATION_1_2 = object : Migration(1, 2) {
  override fun migrate(database: SupportSQLiteDatabase) {
    // Empty implementation, because the schema isn't changing.
  }
}

Java

static final Migration MIGRATION_1_2 = new Migration(1, 2) {
  @Override
  public void migrate(SupportSQLiteDatabase database) {
    // Empty implementation, because the schema isn't changing.
  }
};

Room의 데이터베이스 이전 경로에 관한 자세한 내용은 데이터베이스 이전을 참고하세요.

데이터베이스 인스턴스화 업데이트

데이터베이스 클래스와 이전 경로를 정의한 후 Room.databaseBuilder를 사용하여 이전 경로가 적용된 데이터베이스 인스턴스를 만들 수 있습니다.

Kotlin

val db = Room.databaseBuilder(
          applicationContext,
          AppDatabase::class.java, "database-name"
        )
          .addMigrations(MIGRATION_1_2).build()

Java

db = Room.databaseBuilder(
          context.getApplicationContext(),
          UsersDatabase.class, "database-name"
        )
          .addMigrations(MIGRATION_1_2).build();

구현 테스트

다음과 같이 새 Room 구현을 테스트해야 합니다.

증분 이전

복잡한 대규모 데이터베이스를 사용하는 앱은 한 번에 Room으로 이전하지 못할 수도 있습니다. 대신 첫 단계에서 데이터 항목과 Room 데이터베이스를 선택적으로 구현하고 나중에 쿼리 메서드를 DAO로 이전할 수 있습니다. 맞춤 데이터베이스 도우미 클래스를 RoomDatabase.getOpenHelper()에서 받은 SupportSQLiteOpenHelper 객체로 바꾸면 됩니다.

추가 리소스

SQLite에서 Room으로 이전하는 방법에 관한 자세한 내용은 다음 추가 리소스를 참고하세요.

블로그