【JetPack】Room中的数据迁移(备份、迁移、删除)

Room 数据库的使用

Room 是一个基于 SQLite 数据库构建的数据库持久性库。Room 是在 SQLite 的基础上提供了一个更高层次的抽象，使得我们可以更容易地访问 SQLite 中的数据。它可以提高数据库的访问速度，还可以帮助我们避免 SQL 注入等问题，Room 的使用方式也相对简单。我们可以通过官方提供的注解 @Entity、@Database、@Dao 表示实体、数据和操作等。

修改数据库现有表的字段数据类型

以上，我们已经了解了 Room 数据库的基础知识，那么如何修改 Room 数据库中已经存在的表的字段数据类型呢？下面是修改 Room 数据库中某个表的某个字段数据类型的详细步骤：

1. 首先，我们需要更新对应表中的实体类，做出需要的数据类型修改。如下，我们需要将 age 字段从 Int 修改为 Long 类型。

   @Entity(tableName = "user")
   data class User(
       @PrimaryKey val uid: Long,
       val name: String,
       val age: Long // 修改为 Long 类型
   )
   

2. 接下来是定义 Migration 对象。该对象定义的是需要进行的升级操作。如下，在代码中我们将 age 字段从 Integer 数据类型更改为 Long 数据类型。

   val migration1To2: Migration = object : Migration(1, 2) {
       override fun migrate(database: SupportSQLiteDatabase) {
           // 创建临时表 user_backup
           database.execSQL("CREATE TABLE user_backup (uid INTEGER PRIMARY KEY NOT NULL, name TEXT, age NUMERIC)")
           // 从 user 复制数据到 user_backup
           database.execSQL("INSERT INTO user_backup (uid, name, age) SELECT uid, name, age FROM user")
           // 删除 user 方法
           database.execSQL("DROP TABLE user")
           // 创建新的 user 表
           database.execSQL("CREATE TABLE user (uid INTEGER PRIMARY KEY NOT NULL, name TEXT, age NUMERIC)")
           // 复制 user_backup 表数据到 user 表
           database.execSQL("INSERT INTO user (uid, name, age) SELECT uid, name, age FROM user_backup")
           // 删除 user_backup 表
           database.execSQL("DROP TABLE user_backup")
       }
   }
   

   在上述代码中，我们完成了以下操作：

   • 创建一个名为 user_backup 的临时表，用于保存旧表中的数据；
   • 从 user 表中复制数据到 user_backup 表中；
   • 删除旧表 user；
   • 创建一个名为 user 的新表，其中 age 字段数据类型已为 NUMERIC；
   • 从 user_backup 表中复制数据到 user 表中；
   • 删除 user_backup 表。

   这些操作就实现了旧表数据的数据类型修改。

3. 最后，我们需要在原有的数据库的 builder 中添加 Migration。

   val appDataBase: AppDataBase = Room.databaseBuilder(
       context,
       AppDataBase::class.java, "test.db"
   )
   .addMigrations(migration1To2)
   .build()
   

至此，Room 数据库中某个表的某个字段数据类型修改就完成了。

修改 Room 原有数据库有数据的情况下的数据类型

但是需要特别注意的是，在数据库中执行这种修改可能会导致数据类型不兼容的问题，因此需要进行数据迁移来保证数据的完整性。下面是一些步骤可以参考：

1. 为了避免 Room 在初始化时出现错误，你需要在升级 Room 数据库之前将原来的 Room 数据库备份。

   private fun backupDatabase(context: Context, dbName: String, backupFolder: File): Boolean {
       val dbFile = context.getDatabasePath(dbName)
       return try {
           if (dbFile.exists()) {
               val backupFile = File(backupFolder, dbName)
               FileUtils.copy(dbFile, backupFile)
               true
           } else {
               false
           }
       } catch (e: IOException) {
           false
       }
   }
   

2. 现在你需要编写一个 Migration 类来完成数据的迁移。在 Migration 类中，你可以使用 SQL 语句来执行任何必要的更改。例如，在下面的示例中，我们把 age 字段从 Integer 数据类型更改为 Long 数据类型：

   val migration_1_2 = object : Migration(1, 2) {
       override fun migrate(database: SupportSQLiteDatabase) {
           // 创建临时表 users_old
           database.execSQL("CREATE TABLE users_old (id INTEGER PRIMARY KEY NOT NULL, name TEXT, age NUMERIC)")
           
           // 将数据从 users 表迁移到 users_old 表
           database.execSQL("INSERT INTO users_old (id, name, age) SELECT id, name, age FROM users")
           
           // 删除旧表 users
           database.execSQL("DROP TABLE users")
           
           // 创建新表 users，age 字段为 NUMERIC 类型
           database.execSQL("CREATE TABLE users (id INTEGER PRIMARY KEY NOT NULL, name TEXT, age NUMERIC)")
           
           // 将数据从 users_old 表迁移到新表 users
           database.execSQL("INSERT INTO users (id, name, age) SELECT id, name, age FROM users_old")
           
           // 删除临时表 users_old
           database.execSQL("DROP TABLE users_old")
       }
   }
   

   在这个 Migration 类中，我们执行了以下步骤：

   • 创建了一个名为 users_old 的临时表，并将原来的 users 表中数据迁移到了 users_old 表中。
   • 删除旧表 users。
   • 创建一个带有新的数据类型的 users 表。
   • 将数据从 users_old 表迁移到新的 users 表中，注意需要将迁移后的 age 字段之前为 Integer 类型，这里迁移到的 age 字段现在是 NUMERIC 类型。
   • 删除临时表 users_old。

3. 通过 RoomDatabase.Builder().addMigrations() 方法注册生成的 Migration 实例，并更新你的数据库版本号，以便 Room 知道需要执行哪个 Migration。

   val db = Room.databaseBuilder(context, AppDatabase::class.java, "app-db")
           .addMigrations(migration_1_2)
           .build()
   

至此，你已经成功地升级了你的 Room 数据库并且迁移了旧的数据。如果你的应用是升级的，那么 Room 数据库会在后台自动执行所有升级任务。否则，在修改 Room 数据库结构时，你应该在应用程序中执行以下过程：

• 备份数据库
• 升级数据库
• 恢复数据库备份
• 将备份删除