Android Room 中的数据库自动迁移、生成临时表功能

2023-03-30 本文已影响0人 JayQiu

在 Android 开发中，数据库的升级往往需要进行手动迁移，这是一件比较繁琐的事情。而在 Android Room 中，提供了自动迁移的功能，大大减轻了开发者的负担。
当我们对数据库的表结构进行了修改，例如添加了新的列和索引，我们需要升级数据库版本以便应用程序能够正确地处理新的数据。在 Android Room 中，我们可以使用 @Database 注解中的 version 属性来指定版本号，然后使用 @Entity 注解中的 indices 和 columns 属性来添加索引和列。

为了让 Room 能够自动迁移数据库，我们需要在 @Database 注解中添加 autoMigrations 属性，并提供一个数组，数组中的每个元素表示一个自动迁移操作。每个自动迁移操作都包含 fromVersion 和 toVersion 两个属性，分别表示起始版本和目标版本。在进行自动迁移时，Room 会自动根据起始版本和目标版本之间的差异来执行相应的操作。

一、自动升级

官方文档地址：

https://developer.android.google.cn/training/data-storage/room/migrating-db-versions?hl=zh-cn

1.引入room的依赖

def room_version = "2.5.0-alpha01"//2.2.5
implementation "androidx.room:room-runtime:$room_version"
annotationProcessor "androidx.room:room-compiler:$room_version"

2.设置room数据库生成表的sql语句，这一步非常重要

defaultConfig {
        javaCompileOptions {
            annotationProcessorOptions {
                arguments += [
                        "room.schemaLocation":"$projectDir/schemas".toString(),
                        "room.incremental":"true",
                        "room.expandProjection":"true"]
            }
        }
    }

3.基本的配置好了以后我们就可以正常的来增加注解来配置数据的库的自动升级了

@Database(entities = {UserBean.class, SchoolsBean.class},
        exportSchema = true,
        version = 8,
        autoMigrations = [
            AutoMigration (from = 1, to = 2)
                ]
)
public abstract class MyDatabase extends RoomDatabase {}

4.如果需要在表里新增一个字段如test字段，只需要增加一个@ColumnInfo注解，并为其赋一个默认值

 @ColumnInfo(defaultValue = "0")

配置完成后，我们的项目中schemas 目录会存在多个json文件，这个是本地数据库各个版本的sql语句，请注意，这些json文件需要保存不能删除，否则下次升级会找不到上个数据库的文件，导致自动升级失败

手动升级数据库

val MIGRATION_1_2 = object : Migration(1, 2) {
    override fun migrate(database: SupportSQLiteDatabase) {
        ...
    }
}

.addMigrations(MIGRATION_1_2)//可以添加多个参数，以便从1->2,2->3,1->3

销毁表创建临时表重建

创建一张符合表结构要求的临时表，
将数据从旧表复制到临时表，
删除旧表，
临时表重命名回原来的表名

异常处理

为了防止升级过程中失败导致应用程序崩溃的情况，可以在创建数据库时加入fallbackToDestructiveMigration()方法。该方法能在数据库升级异常时，重建数据库而不崩溃，但是表中的数据会丢失

val MIGRATION_2_3: Migration = object : Migration(2, 3) {
            override fun migrate(database: SupportSQLiteDatabase) {
                //创建临时表
                database.execSQL(
                    "CREATE TABLE tem_user_info (`uid` INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, `first_name` TEXT, `last_name` TEXT, `sex` INTEGER DEFAULT 0)"
                )
                //将数据导入临时表
                database.execSQL("INSERT INTO tem_user_info (uid,first_name,last_name,sex) SELECT uid,first_name,last_name,sex FROM user_info")
                //删除原表
                database.execSQL("DROP TABLE user_info")
                //临时表改成原表的名字
                database.execSQL("ALTER TABLE tem_user_info RENAME TO user_info")
            }
        }

二、自动迁移

Room 的自动迁移无法检测到数据库上执行的所有可能的变化，因此有时候它们需要一些帮助。举一个常见的例子，Room 没办法检测到一个数据库表或列是否被重命名或者被删除。在这种情况下，Room 会抛出一个编译错误，并要求您实现 AutoMigrationSpec。此类允许您指定做出更改的类型，实现一个 AutoMigrationSpec 并使用以下一项或多项来注解:

@DeleteTable(tableName)
@RenameTable(fromTableName, toTableName)
@DeleteColumn(tableName, columnName)
@RenameColumn(tableName, fromColumnName, toColumnName)

假设我们将 User的数据库表重命名为 Users。Room 无法检测到我们是新建了这个表并删除了 User 表，还是重命名了它以及要保留所有的值。

@Database(version = 2,
        entities = [GoodDoggos.class],
        autoMigrations = [AutoMigration(from = 1,
                to = 2,
                spec = MyDatabase.UsersAutoMigration::class)])
abstract class MyDatabase: RoomDatabase {
    @RenameTable(fromTableName = "User", toTableName = "Users")
    class UsersAutoMigration: AutoMigrationSpec{}
}