Room数据库升级、降级、数据迁移
在 Android 中使用 Room 数据库时,数据库结构的变更可能会导致需要进行数据库升级、降级或数据迁移。
在@Entities类里增加了新字段后,重新运行已创建过DB的demo会发生崩溃。需要手动/自动对数据库表进行升级工作才能正常运行。
1.fallbackToDestructiveMigration 删除数据库并重建
如果数据库的数据不重要全部删除不影响后续所有的业务,可考虑该方法
fallbackToDestructiveMigration方法表示Room启动时将检测version是否发生增加,如果有,那么将找到自定义Migration去执行特定的操作。如果没有自定义Migration, 因为设置了fallbackToDestructiveMigration(),将会删除数据库并重建,所有数据丢失。
2.addMigrations 自定义Migration升级版本
例如:user表 新插入一个字段 testId
AppDatabase中定义Migration,并执行数据库 user表插入新字段的操作
public static final Migration MIGRATION_2_3 = new Migration(2, 3) {
@Override
public void migrate(@NonNull SupportSQLiteDatabase database) {
//执行升级相关操作
database.execSQL("ALTER TABLE user ADD testId INTEGER Default 0 not null");
}
};
新建数据库 AppDatabase ->addMigrations
3.Room 数据库自动升级
1.设置room数据库生成表的sql语句,必须配置
在 app/build.gradle 文件中设置 room.schemaLocation 注释处理器属性:
android {
...
defaultConfig {
...
javaCompileOptions {
annotationProcessorOptions { arguments = ["room.schemaLocation": "$projectDir/schemas".toString()] } }
}
}
编译时会在配置的目录下生成 数据库版本号 对应的json文件---主要信息为数据库相关信息、相关表信息,自动升级会根据这些信息 生成Migration。升级方式类似于手动升级的方式。
所有的使用的版本号对应的json文件都不能缺少,否则对应版本的升级会出问题,若中途进行的数据库的自动化升级迁移,可考虑回退版本,编译成对应的json拷贝过来。
2.版本号设置,以及增加AutoMigration 自动升级注解。支持跨版本自动升级
3.Entity中新增字段,需要设置defaultValue,否则会报错
@ColumnInfo(defaultValue = "0")
public int testId;
4、Room数据库跨版本升级
在用户使用App的过程中数据库的升级并不总是按部就班的从 version: 1->2,2->3,3->4。例如目前App的数据库版本号是1,并且2,3两个版本的app用户并没有更新下载,因此数据库并没有升级,目前最新的App的数据库版本是4,用户直接下载最新的App进行升级,如果我们定义了migrations:version 1 到 2, version 2 到 3, version 3 到 4, Room 会一个接一个的触发所有 migration。
自定义升级
1.定义升级Migration
public static final Migration MIGRATION_1_2 = new Migration(1, 2) {
@Override
public void migrate(@NonNull SupportSQLiteDatabase database) {
//执行升级相关操作
database.execSQL("DROP TABLE IF EXISTS user");
database.execSQL("DROP TABLE IF EXISTS vote_statistics");
database.execSQL("DROP TABLE IF EXISTS count_options");
database.execSQL("DROP TABLE IF EXISTS vote_theme");
}
};
public static final Migration MIGRATION_2_3 = new Migration(2, 3) {
@Override
public void migrate(@NonNull SupportSQLiteDatabase database) {
//执行升级相关操作
database.execSQL("ALTER TABLE user ADD testId INTEGER Default 0 not null");
}
};
public static final Migration MIGRATION_3_4 = new Migration(3, 4) {
@Override
public void migrate(@NonNull SupportSQLiteDatabase database) {
//执行升级相关操作
database.execSQL("ALTER TABLE user ADD test INTEGER Default 0 not null");
}
};
2. 把migration 添加到 Room database builder:
db = Room.databaseBuilder(MyApplication.getInstance(), AppDatabase.class, "voter.db")
.addMigrations(MIGRATION_1_2,MIGRATION_2_3,MIGRATION_3_4)
.build();
以上可完成1->2,2->3,3->4的跨版本升级,当然也可定义1->4的直接升级,并addMigrations,从而提升数据库升级速度。
3.如果没有匹配到对应的升级Migration配置,则app 直接 crash为了防止crash,可添加fallbackToDestructiveMigration方法配置 直接删除所有的表,重新创建表:
db = Room.databaseBuilder(MyApplication.getInstance(), AppDatabase.class, "voter.db")
.addMigrations(MIGRATION_1_2,MIGRATION_2_3,MIGRATION_3_4,MIGRATION_1_4)
.fallbackToDestructiveMigration()// 如果没有匹配到Migration,则直接删除所有的表,重新创建表
.build();
5.跨版本自动升级
可参考数据库自动升级的相关设置,可顺序跨版本升级,也可直接定义1->4的跨版本升级。
@Database(entities = {User.class}, version = 4, autoMigrations = {@AutoMigration(from = 1, to = 2), @AutoMigration(from = 2, to = 3), @AutoMigration(from = 3, to = 4), @AutoMigration(from = 1, to = 4)})
public abstract class AppDatabase extends RoomDatabase {...}