如何在Android Room数据库更新/迁移时保留用户收藏数据？

问题背景 #

我的产品数据库包含name、price字段，通过createFromAsset初始化，额外有一个Favorite字段标记产品收藏状态。
初始资产数据库数据：

需求：更新数据库时，修改已有产品价格、添加新产品，同时保留用户设置的Favorite值。比如用户标记Product B为收藏后，更新后的数据应为：

现有方案存在的问题：

• 使用fallbackToDestructiveMigration会重置所有用户的收藏状态
• 使用AutoMigration无法同步资产库中的新产品和价格更新

解决方案 #

方案一：自定义迁移合并资产库数据（不拆分数据库） #

无需拆分数据库，通过自定义Migration实现资产库最新数据与现有用户数据的合并：

1. 准备更新后的资产库文件：将Product C加入、修改Product B价格，生成products_v2.db并存放在assets/database/目录下。

2. 编写自定义Migration类：在版本升级时，临时加载资产库数据，与现有数据库合并：

val MIGRATION_1_2 = object : Migration(1, 2) {
    override fun migrate(database: SupportSQLiteDatabase) {
        // 创建临时表存储资产库的最新产品数据
        database.execSQL("CREATE TABLE temp_products (name TEXT PRIMARY KEY, price TEXT, favorite INTEGER DEFAULT 0)")
        
        // 从assets加载新的产品数据库，导入临时表
        val context = ContextProvider.getApplicationContext() // 需实现全局Context获取逻辑
        val inputStream = context.assets.open("database/products_v2.db")
        val tempDbFile = File(context.cacheDir, "temp_products.db")
        inputStream.use { input ->
            FileOutputStream(tempDbFile).use { output ->
                input.copyTo(output)
            }
        }
        val tempDb = SQLiteDatabase.openDatabase(tempDbFile.path, null, SQLiteDatabase.OPEN_READONLY)
        
        // 合并数据：更新现有产品价格，插入新产品，保留用户的收藏状态
        database.execSQL("""
            INSERT OR REPLACE INTO products (name, price, favorite)
            SELECT tp.name, tp.price, COALESCE(p.favorite, tp.favorite)
            FROM temp_products tp
            LEFT JOIN products p ON tp.name = p.name
        """)
        
        // 清理临时资源
        tempDb.close()
        tempDbFile.delete()
        database.execSQL("DROP TABLE temp_products")
    }
}

3. 修改数据库构建代码：移除fallbackToDestructiveMigration，添加自定义迁移：

@Database(
    entities = [Product::class],
    version = 2,
    exportSchema = true
)
abstract class ProductDatabase : RoomDatabase() {
    abstract fun productDao(): ProductDao

    companion object {
        @Volatile
        private var INSTANCE: ProductDatabase? = null

        fun getDatabase(context: Context, scope: CoroutineScope): ProductDatabase {
            return INSTANCE ?: synchronized(this) {
                val instance = Room.databaseBuilder(
                    context.applicationContext,
                    ProductDatabase::class.java,
                    "product_database"
                )
                .addMigrations(MIGRATION_1_2)
                .build()
                INSTANCE = instance
                instance
            }
        }
    }
}

注意：需确保Product实体的favorite字段设置默认值（比如defaultValue = "0"或false），避免合并时出现空值问题。

方案二：拆分收藏数据到独立表 #

如果觉得迁移逻辑复杂，可将用户收藏状态与基础产品数据分离：

1. 创建独立的收藏表：

@Entity(tableName = "favorites")
data class Favorite(
    @PrimaryKey val productName: String,
    val isFavorite: Boolean
)

2. 产品表仅存储基础数据：移除favorite字段，产品表仅包含name和price，通过createFromAsset初始化。

3. 查询时关联两张表：在Dao中通过JOIN获取产品的完整状态：

@Query("""
    SELECT p.name, p.price, COALESCE(f.isFavorite, false) as favorite
    FROM products p
    LEFT JOIN favorites f ON p.name = f.productName
""")
fun getAllProductsWithFavorite(): Flow<List<ProductWithFavorite>>

data class ProductWithFavorite(
    val name: String,
    val price: String,
    val favorite: Boolean
)

这种方式下，更新产品数据库时，直接替换资产库文件并升级版本即可，用户的收藏数据因存储在独立表中不会被影响。

总结 #

• 方案一适合不想拆分数据的场景，通过自定义迁移精准合并数据，完全保留用户收藏状态
• 方案二更简洁，将用户自定义数据与基础产品数据分离，后续产品数据更新更省心

内容的提问来源于stack exchange，提问作者Lexusminds