假设，我有一个简单的 Room 数据库:

@Database(entities = {User.class}, version = 1)
abstract class AppDatabase extends RoomDatabase {
    public abstract Dao getDao();
}

现在，我要添加一个新实体:Pet 并将版本升级到 2:

@Database(entities = {User.class, Pet.class}, version = 2)
abstract class AppDatabase extends RoomDatabase {
    public abstract Dao getDao();
}

当然Room会抛出异常:java.lang.IllegalStateException: A migration from 1 to 2 is necessary.

假设，我没有更改 User 类(所以所有数据都是安全的)，我必须提供迁移，它只是创建一个新表。因此，我正在研究 Room 生成的类，搜索生成的查询以创建我的新表，将其复制并粘贴到迁移中:

final Migration MIGRATION_1_2 =
        new Migration(1, 2) {
            @Override
            public void migrate(@NonNull final SupportSQLiteDatabase database) {
                database.execSQL("CREATE TABLE IF NOT EXISTS `Pet` (`name` TEXT NOT NULL, PRIMARY KEY(`name`))");
            }
        };

但是我发现手动操作很不方便。 有没有办法告诉 Room:我没有碰任何现有的表，所以数据是安全的。请为我创建迁移？

最佳答案

Room没有有一个好的迁移系统，至少在 2.1.0-alpha03 之前没有。

因此，在我们拥有更好的迁移系统之前，有一些解决方法可以在房间内轻松迁移。

由于没有 @Database(createNewTables = true) 或 MigrationSystem.createTable(User::class) 这样的方法，应该有一个，唯一可能的方法是运行

CREATE TABLE IF NOT EXISTS `User` (`id` INTEGER, PRIMARY KEY(`id`))

在您的 migrate 方法中。

val MIGRATION_1_2 = object : Migration(1, 2){
    override fun migrate(database: SupportSQLiteDatabase) {
        database.execSQL("CREATE TABLE IF NOT EXISTS `User` (`id` INTEGER, PRIMARY KEY(`id`))")
    }
}

为了获得上述SQL脚本，你有4种方法

1。自己写

基本上，您必须编写与 Room 生成的脚本匹配的上述脚本。这种方式可行，不可行。 (假设您有 50 个字段)

2。导出架构

如果您在 @Database 注释中包含 exportSchema = true，Room 将在项目文件夹的/schemas 中生成数据库架构。用法是

@Database(entities = [User::class], version = 2, exportSchema = true)
abstract class AppDatabase : RoomDatabase {
   //...
}

确保您在应用模块的 build.grade 中包含以下行

kapt {
    arguments {
        arg("room.schemaLocation", "$projectDir/schemas".toString())
    }
} 

当您运行或构建项目时，您将获得一个 JSON 文件 2.json，其中包含 Room 数据库中的所有查询。

  "formatVersion": 1,
  "database": {
    "version": 2,
    "identityHash": "325bd539353db508c5248423a1c88c03",
    "entities": [
      {
        "tableName": "User",
        "createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`id` INTEGER NOT NULL, PRIMARY KEY(`id`))",
        "fields": [
          {
            "fieldPath": "id",
            "columnName": "id",
            "affinity": "INTEGER",
            "notNull": true
          },

因此，您可以在 migrate 方法中包含上述 createSql。

3。从 AppDatabase_Impl 获取查询

如果您不想导出架构，您仍然可以通过运行或构建将生成 AppDatabase_Impl.java 文件的项目来获取查询。并在您可以拥有的指定文件中。

@Override
public void createAllTables(SupportSQLiteDatabase _db) {
  _db.execSQL("CREATE TABLE IF NOT EXISTS `User` (`id` INTEGER, PRIMARY KEY(`id`))");

在createAllTables 方法中，会有所有实体的创建脚本。您可以获取它并将其包含在您的 migrate 方法中。

4。注释处理。

您可能已经猜到，Room 会在编译时间内生成上述所有 schema 和 AppDatabase_Impl 文件，并使用您添加的注释处理

kapt "androidx.room:room-compiler:$room_version"

这意味着您也可以这样做并制作自己的注释处理库，为您生成所有必要的创建查询。

想法是为@Entity和@Database的Room注解做一个注解处理库。以使用 @Entity 注释的类为例。这些是您必须遵循的步骤

1. 创建一个新的 StringBuilder 并附加“CREATE TABLE IF NOT EXISTS”
2. 从 class.simplename 或 @Entity 的 tableName 字段获取表名。将其添加到您的 StringBuilder
3. 然后为类的每个字段创建 SQL 列。通过字段本身或 @ColumnInfo 注释获取字段的名称、类型、可空性。 对于每个字段，您必须将列的 id INTEGER NOT NULL 样式添加到您的 StringBuilder。
4. 通过@PrimaryKey
添加主键
5. 添加 ForeignKey 和 Indices(如果存在)。
6. 完成将其转换为字符串并将其保存在您要使用的某个新类中。例如，如下所示保存

public final class UserSqlUtils {
  public String createTable = "CREATE TABLE IF NOT EXISTS User (id INTEGER, PRIMARY KEY(id))";
}

然后，你可以把它当作

val MIGRATION_1_2 = object : Migration(1, 2){
    override fun migrate(database: SupportSQLiteDatabase) {
        database.execSQL(UserSqlUtils().createTable)
    }
}

我为自己制作了这样一个库，您可以查看它，甚至可以在您的项目中使用它。请注意，我创建的库并不完整，它只是满足我创建表的要求。

RoomExtension for better Migration

Application that uses RoomExtension

希望有用。

更新

在撰写此答案时，房间版本为 2.1.0-alpha03，当我通过电子邮件发送给开发人员时，我收到了回复

It is expected to have better Migration System in 2.2.0

不幸的是，我们仍然缺乏更好的迁移系统。

关于java - 仅添加新表时的房间数据库迁移，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/48399852/