前序

在 Android 應用開發(fā)中，Room 是 Google 提供的一個輕量級數據庫框架，用于簡化與 SQLite 的交互。在應用的迭代過程中，數據庫的結構不可避免地會發(fā)生變化，因此，我們需要為數據庫升級、降級以及數據遷移制定一套合適的策略。

本文將介紹 Room 數據庫升級的幾種場景和常見的處理方法，包括手動遷移和自動遷移的策略。

何時需要升級數據庫版本號？

以下幾種情況會導致數據庫結構的變更，因此必須升級數據庫版本號，并處理相應的遷移邏輯：

1. 新增或刪除表：當我們向數據庫中添加或刪除一張表時，必須升級版本號，并實現相應的遷移處理邏輯，以確保數據的一致性。

2. 新增、刪除或修改字段：當對表中的字段進行操作時，例如新增一個列、刪除或重命名列，必須升級數據庫版本號，同時處理好字段的遷移或初始化邏輯。

3. 修改索引或約束：如果為某些字段添加索引，或者對字段的約束（如非空、唯一等）進行修改，同樣需要升級版本號。

Room 數據庫遷移策略

Room 提供了多種處理數據庫遷移的方式，開發(fā)者可以根據項目需求選擇合適的遷移策略：

1. fallbackToDestructiveMigration 刪除數據庫并重建

如果應用中的數據不重要，或者我們允許用戶丟失數據庫中的所有數據，可以使用 fallbackToDestructiveMigration 方法，該方法會在版本號發(fā)生變化時直接刪除數據庫并重建。

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

優(yōu)點：這種方式可以確保在數據庫結構變更時，用戶的數據不會丟失，數據遷移可以按照開發(fā)者定義的邏輯進行。

3. Room 數據庫自動遷移

從 Room 2.4 版本開始，支持自動遷移功能，能夠根據數據庫的 schema 文件自動生成遷移邏輯，簡化了跨版本的升級工作。在自動遷移中，Room 會自動處理字段的增加和刪除，開發(fā)者只需配置好數據庫的 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 允許開發(fā)者定義跨版本的自動遷移，例如從 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 會自動依次執(zhí)行從 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();

通過這種方式，用戶可以直接從 version 1 升級到 version 4，避免了逐個版本的遷移。

總結

在 Android 應用的開發(fā)中，數據庫的升級與遷移是不可避免的工作。Room 提供了靈活的數據庫遷移機制，可以通過手動定義遷移、自動生成遷移，或在必要時重建數據庫。開發(fā)者應根據應用的實際需求選擇合適的升級方案，以確保用戶數據的完整性和系統(tǒng)的穩(wěn)定性。

• 自動遷移：適用于簡單字段的增加、刪除等結構變化。
• 自定義遷移：適合復雜的數據庫操作，能夠靈活應對各種數據庫結構調整。
• 重建數據庫：適用于數據不重要或者允許丟失數據的場景。

通過合理的遷移策略，確保數據庫的穩(wěn)定升級，是提高應用質量的重要一環(huán)。

以上就是Android Room數據庫自動升級與遷移的策略的詳細內容，更多關于Android Room自動升級與遷移的資料請關注腳本之家其它相關文章！

最新評論