Room数据库自动迁移功能的原理

前言

Room数据有有自动升级迁移数据库版本的功能,我们研究下它是怎么实现的

正文

手动升级

//手动从version2升到3
private val MIGRATION_2_3 = object : Migration(2, 3) {
    override fun migrate(database: SupportSQLiteDatabase) {
        database.execSQL("your sql")
    }
}

//构建AppDataBase时添加
            Room.databaseBuilder(
                ...
            ).addMigrations(
                MIGRATION_1_2,
                MIGRATION_2_3,//这里添加手动升级数据库版本的Migration
                ...
            ).allowMainThreadQueries()
                .build()

可以看到,需要手动写代码,如果数据库版本很高了,则需要写很多代码

并且从低版本升级到高版本也不太好测试,很容易出问题

尝试设计自动升级功能

如果我们来设计数据库自动升级表的功能的话其实也简单

首先我们可以对比低版本和高版本的表结构(当前数据库表,和Entity Bean),然后根据差异来创建,删除表,增加,删除字段等

但是Room的版本升级是依次升级的,比如先从1到2,再从2到3,所以我们还需要记录一下当前版本的数据库表的结构(Entity Bean),所以我们需要一个设置来将每个版本的数据库表结构记录下来

@Database(
    entities = [
        ...
    ],
    version = 7,
    exportSchema = true,//打开数据库表结构记录
)

然后配置一下数据库表结构存储文件的位置

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

然后build后配置的位置就会出现 [version].json的文件,这样就可以根据这些文件来动态生成自动升级的代码了

@Database(
    entities = [
        ...
    ],
    version = 7,
    exportSchema = true,//打开数据库表结构记录
    autoMigrations = [
        AutoMigration(from = 7, to = 8),//声明自动升级的版本
    ],
)

 这时就可以了,然后我们build后可以找到一些自动生成的代码,观察后发现和我们手动写的数据库升级代码是一样的:

class AppDataBase_AutoMigration_1_2_Impl extends Migration {
  public AppDataBase_AutoMigration_1_2_Impl() {
    super(1, 2);
  }

  @Override
  public void migrate(@NonNull SupportSQLiteDatabase database) {
    database.execSQL("sql");
  }
}

适配数据库降级

            Room.databaseBuilder(
                ...
            ).addMigrations(
                ...
            ).allowMainThreadQueries()
                .fallbackToDestructiveMigrationOnDowngrade()//如果出现了降级的情况,就直接删除旧数据库
                .build()

 

对Kotlin或KMP感兴趣的同学可以进Q群 101786950

如果这篇文章对您有帮助的话

可以扫码请我喝瓶饮料或咖啡(如果对什么比较感兴趣可以在备注里写出来)