Room：从 SQLite 数据库迁移的指南

2023-09-08 21:21:01

介绍

Room 是一个用于 Android 的持久层库，它可以简化数据库操作并提高应用程序的性能。Room 提供了一个简单的 API，使您可以轻松地创建、查询和更新数据库表。此外，Room 还提供了许多高级功能，如数据绑定、LiveData 和 RxJava 支持，使您可以轻松地将数据集成到您的应用程序中。

逐步迁移到 Room

第一步：添加 Room 依赖项

在您的应用程序的 build.gradle 文件中添加以下依赖项：

implementation "androidx.room:room-runtime:2.4.3"
annotationProcessor "androidx.room:room-compiler:2.4.3"

第二步：创建数据库类

创建一个新的类来表示您的数据库。这个类必须继承自 RoomDatabase 类。在该类中，您需要定义数据库的版本号和要包含的表。

@Database(entities = [Note::class], version = 1)
abstract class AppDatabase : RoomDatabase() {
    abstract fun noteDao(): NoteDao
}

第三步：创建数据访问对象 (DAO)

为每个要访问的表创建一个 DAO 类。DAO 类包含用于查询、插入、更新和删除数据的函数。

@Dao
interface NoteDao {
    @Query("SELECT * FROM note")
    fun getAll(): List<Note>

    @Insert
    fun insert(note: Note)

    @Update
    fun update(note: Note)

    @Delete
    fun delete(note: Note)
}

第四步：创建实体类

为每个要存储在数据库中的表创建一个实体类。实体类必须包含表的列名和类型。

@Entity
data class Note(
    @PrimaryKey(autoGenerate = true) val id: Int,
    val title: String,
    val content: String
)

第五步：迁移现有数据

如果您已经存在一个 SQLite 数据库，您可以使用 Room 的 @UpdateSchema 注释将数据迁移到 Room 数据库。

@Database(entities = [Note::class], version = 2)
@UpdateSchema(from = 1, to = 2)
abstract class AppDatabase : RoomDatabase() {
    abstract fun noteDao(): NoteDao
}

第六步：使用 Room

现在您已经完成了 Room 的迁移，就可以开始使用 Room 来管理您的数据了。您可以使用 RoomDatabase.query()、RoomDatabase.insert()、RoomDatabase.update() 和 RoomDatabase.delete() 方法来查询、插入、更新和删除数据。

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

val noteDao = db.noteDao()

val notes = noteDao.getAll()

val newNote = Note(0, "New Note", "This is a new note.")
noteDao.insert(newNote)