当前位置：首页 > article >正文

Android Room 数据库自动升级与迁移策略

article 2024/11/13 14:46:41

前序

在 Android 应用开发中，Room 是 Google 提供的一个轻量级数据库框架，用于简化与 SQLite 的交互。在应用的迭代过程中，数据库的结构不可避免地会发生变化，因此，我们需要为数据库升级、降级以及数据迁移制定一套合适的策略。

本文将介绍 Room 数据库升级的几种场景和常见的处理方法，包括手动迁移和自动迁移的策略。

何时需要升级数据库版本号？

以下几种情况会导致数据库结构的变更，因此必须升级数据库版本号，并处理相应的迁移逻辑：

新增或删除表：当我们向数据库中添加或删除一张表时，必须升级版本号，并实现相应的迁移处理逻辑，以确保数据的一致性。
新增、删除或修改字段：当对表中的字段进行操作时，例如新增一个列、删除或重命名列，必须升级数据库版本号，同时处理好字段的迁移或初始化逻辑。
修改索引或约束：如果为某些字段添加索引，或者对字段的约束（如非空、唯一等）进行修改，同样需要升级版本号。

Room 数据库迁移策略

Room 提供了多种处理数据库迁移的方式，开发者可以根据项目需求选择合适的迁移策略：

1. `fallbackToDestructiveMigration` 删除数据库并重建

如果应用中的数据不重要，或者我们允许用户丢失数据库中的所有数据，可以使用 fallbackToDestructiveMigration 方法，该方法会在版本号发生变化时直接删除数据库并重建。

private static AppDatabase create(final Context context) {
    return Room.databaseBuilder(
            context,
            AppDatabase.class,
            "AppDatabase.db")
        .fallbackToDestructiveMigration() // 自动删除并重建数据库
        .build();
}

注意：使用这种方式，所有的旧数据都会被删除，因此适合那些对数据持久性要求不高的场景。

2. `addMigrations` 自定义迁移逻辑

当需要保留用户数据时，可以通过自定义 Migration 来处理数据库结构变更。例如，给 user 表新增一个 testId 字段：

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");
    } 
};

在数据库的 Room 实例构建时，将这个迁移添加到数据库构建器中：

private static AppDatabase create(final Context context) {
    return Room.databaseBuilder(
            context,
            AppDatabase.class,
            "AppDatabase.db")
        .addMigrations(MIGRATION_2_3) // 自定义的迁移
        .build();
}

优点：这种方式可以确保在数据库结构变更时，用户的数据不会丢失，数据迁移可以按照开发者定义的逻辑进行。

3. Room 数据库自动迁移

从 Room 2.4 版本开始，支持自动迁移功能，能够根据数据库的 schema 文件自动生成迁移逻辑，简化了跨版本的升级工作。在自动迁移中，Room 会自动处理字段的增加和删除，开发者只需配置好数据库的 schemaLocation。

步骤一：配置 `room.schemaLocation`

在 app/build.gradle 文件中配置注解处理器的参数，以便在编译时生成数据库的 schema 文件：

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

编译时会在配置的目录下生成数据库版本号对应的 json 文件 — 主要信息为数据库相关信息、相关表信息，自动升级会根据这些信息生成 Migration。升级方式类似于手动升级的方式。
所有的使用的版本号对应的 json 文件都不能缺少，否则对应版本的升级会出问题，若中途进行的数据库的自动化升级迁移，可考虑回退版本，编译成对应的 json 拷贝过来。

    app 
    ├── build 
    │   ├── libs 
    │   ├── release 
    │   └── schemas 
    │       └── database.AppDatabase.json 
    │       └── 2.json 
    │       └──.json

步骤二：配置自动迁移

Room 允许开发者定义跨版本的自动迁移，例如从 version 1 直接升级到 version 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 {
}

注意：在自动迁移中，字段的新增需要设置 defaultValue，否则会报错：

@ColumnInfo(defaultValue = "0") 
public int testId;

4. Room 跨版本升级与降级

Room 也支持顺序或跨版本的数据库升级。假设用户下载的是最新版本的应用（版本号为 4），而数据库版本从未升级（还停留在 version 1），Room 会自动依次执行从 version 1 到 version 4 的所有迁移。

如果我们希望加快迁移速度，可以定义一个从 version 1 直接到 version 4 的迁移逻辑，并通过 addMigrations 方法添加：

public static final Migration MIGRATION_1_4 = new Migration(1, 4) { 
    @Override 
    public void migrate(@NonNull SupportSQLiteDatabase database) { 
        // 自定义跨版本迁移逻辑
        database.execSQL("ALTER TABLE user ADD COLUMN testId INTEGER DDEDAQEFAULT 0 NOT NULL");
        database.execSQL("ALTER TABLE user ADD COLUMN test INTEGER DEDAQ 0 NOT NULL");
    } 
};

添加迁移到 Room 实例：

db = Room.databaseBuilder(MyApplication.getInstance(), AppDatabase.class, "AppDatabase.db")
    .addMigrations(MIGRATION_1_2, MIGRATION_2_3, MIGRATION_3_4, MIGRATION_1_4)
    .fallbackToDestructiveMigration() // 防止没有匹配到的迁移时崩溃
    .build();