如何让Room适配Schema不同的预打包数据库？

一、让Room忽略未预期列的方案 #

Room默认会严格校验预打包数据库的Schema与实体类是否完全匹配，多余列会直接触发报错。要绕开这个校验，你可以自定义SupportSQLiteOpenHelper，修改它的Schema校验逻辑：

1. 实现自定义的SupportSQLiteOpenHelper.Factory，重写create方法，跳过Room默认的Schema校验步骤：

val customFactory = SupportSQLiteOpenHelper.Factory { configuration ->
    object : FrameworkSQLiteOpenHelper(configuration.context, configuration.name, configuration.callback) {
        override fun onCreate(db: SQLiteDatabase) {
            // 预打包数据库无需执行创建逻辑
        }

        override fun onUpgrade(db: SQLiteDatabase, oldVersion: Int, newVersion: Int) {
            // 旧版本APP不处理数据库升级，保留原有逻辑即可
        }

        override fun onOpen(db: SQLiteDatabase) {
            super.onOpen(db)
            // 可添加自定义初始化操作
        }
    }
}

2. 在Room数据库构建时使用这个自定义Factory：

val db = Room.databaseBuilder(context, AppDatabase::class.java, "location.db")
    .openHelperFactory(customFactory)
    .createFromFile(File(...))
    .build()

这种方式会让Room放松Schema校验，只映射实体类中定义的列，多余列会被自动忽略，完全不影响现有查询逻辑。

二、自动移除多余列的方案 #

如果不想在数据库中保留多余列，可以在加载预打包数据库后自动清理旧版本不需要的列，无需手动枚举所有表和列：

1. 编写通用的列清理方法，通过反射获取实体类的列名，再对比数据库表的实际列名，删除多余字段：

fun cleanExtraColumns(db: SupportSQLiteDatabase, entityClass: Class<*>, tableName: String) {
    // 获取实体类中定义的所有列名（含@ColumnInfo指定的名称）
    val entityColumns = entityClass.declaredFields
        .filter { it.isAnnotationPresent(ColumnInfo::class.java) }
        .map { it.getAnnotation(ColumnInfo::class.java).name ?: it.name }
        .toSet()

    // 查询数据库表的实际列名
    val cursor = db.query("PRAGMA table_info($tableName)")
    val dbColumns = mutableListOf<String>()
    while (cursor.moveToNext()) {
        val columnName = cursor.getString(cursor.getColumnIndex("name"))
        dbColumns.add(columnName)
    }
    cursor.close()

    // 删除不在实体类中的列
    dbColumns.forEach { column ->
        if (!entityColumns.contains(column)) {
            db.execSQL("ALTER TABLE $tableName DROP COLUMN $column")
        }
    }
}

2. 在Room的Callback中调用该方法，完成数据库加载后的清理：

val dbCallback = object : RoomDatabase.Callback() {
    override fun onCreate(db: SupportSQLiteDatabase) {
        super.onCreate(db)
        cleanExtraColumns(db, City::class.java, "city")
        cleanExtraColumns(db, Location::class.java, "location")
    }
}

val db = Room.databaseBuilder(context, AppDatabase::class.java, "location.db")
    .addCallback(dbCallback)
    .createFromFile(File(...))
    .build()

这个方法会自动适配实体类的字段，无需手动维护列名列表，适合表结构较多的场景。

三、优雅提示用户升级 #

不管采用哪种方案，都可以在处理数据库时检测是否存在多余列，以此判断服务器数据库已更新，然后提示用户升级APP：

fun hasExtraColumns(db: SupportSQLiteDatabase, entityClass: Class<*>, tableName: String): Boolean {
    val entityColumns = entityClass.declaredFields
        .filter { it.isAnnotationPresent(ColumnInfo::class.java) }
        .map { it.getAnnotation(ColumnInfo::class.java).name ?: it.name }
        .toSet()
    val cursor = db.query("PRAGMA table_info($tableName)")
    val dbColumns = mutableListOf<String>()
    while (cursor.moveToNext()) {
        dbColumns.add(cursor.getString(cursor.getColumnIndex("name")))
    }
    cursor.close()
    return dbColumns.any { !entityColumns.contains(it) }
}

// 在Callback的onOpen方法中调用检测逻辑
override fun onOpen(db: SupportSQLiteDatabase) {
    super.onOpen(db)
    val needUpgrade = hasExtraColumns(db, City::class.java, "city") || 
                      hasExtraColumns(db, Location::class.java, "location")
    if (needUpgrade) {
        Toast.makeText(context, "发现新版本，建议升级以获取完整功能", Toast.LENGTH_LONG).show()
    }
}

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