【Jetpack】使用 Room 中的 Migration 升级数据库 ( 修改 Entity 实体类 | 创建 Migration 迁移类 | 修改数据库版本 )

最新推荐文章于 2025-05-13 15:36:06 发布

原创

最新推荐文章于 2025-05-13 15:36:06 发布 · 516 阅读

标签

#数据库 #android #java

在Android开发中，当使用Room数据库且需要修改实体类的数据模型时，可以使用Migration进行数据库升级。创建Migration类需要指定当前和目标版本号，并实现migrate函数以执行SQL命令更新表结构。在数据库构建器中添加Migration实例以应用迁移。确保正确处理数据库版本以防止数据丢失。

在进行 Android 开发时，我们经常会使用到本地数据库来存储数据。在应用程序的发展过程中，很可能需要修改我们的实体类，这意味着我们需要升级数据库以反映这些更改。在使用 Room 数据库时，我们可以使用 Migration 来实现数据库升级。

当我们需要修改实体类(Eentity) 的数据模型时，如何创建 Migration 迁移类，以及如何修改数据库版本来反映这些更改。

修改 Entity 实体类

在使用 Room 数据库时，我们定义的实体类用于映射表的结构。当我们需要修改实体类的数据模型时，我们需要创建 Migration 迁移类来实现数据库升级，以便合并这些更改。

例如，假设我们有以下 User 实体类：

@Entity(tableName = "user")
data class User(
    @PrimaryKey(autoGenerate = true) val id: Int,
    val name: String,
    val age: Int
)

现在，我们需要向 User 实体类中添加一些属性，如下所示：

@Entity(tableName = "user")
data class User(
    @PrimaryKey(autoGenerate = true) val id: Int,
    val name: String,
    val age: Int,
    val email: String,
    val phone: String
)

由于我们已经在应用程序中使用了 User 实体类，因此我们不能简单地修改它，而是需要创建一个 Migration 迁移类以实现数据库升级。

创建 Migration 迁移类

为了使数据库升级流程更加灵活和可靠，我们使用 Room 数据库提供的 Migration 类来定义数据库升级。我们可以使用 Migration 类来追踪数据库结构的更改，并对数据库的新版本执行迁移操作。从 Room 2.2.0 版本起，我们还可以将迁移代码嵌入在 @Database 注解中的 fallbackToDestructiveMigration 属性中，但是这种方法将从底层重新创建数据库，所有数据都将丢失，因此我们仅在遇到无法执行迁移操作的情况下使用这种方法。

为了创建 Migration 迁移类，我们需要扩展 Room 的 Migration 类。在创建 Migration 迁移类时，我们需要指定当前版本号和升级后的版本号，并实现 migrate 函数，该函数用于指定数据库升级时要执行的操作。在本例中，我们需要为 User 实体类添加 email 和 phone 属性，因此我们将在迁移类中添加这些属性。