如何将 Room 数据库从 1 迁移到 2？

Question

我正在尝试将我的 Room 数据库迁移到下一个版本，但我不断收到相同的错误：

java.lang.IllegalStateException: A migration from 1 to 2 was required but not found. Please provide the necessary Migration path via RoomDatabase.Builder.addMigration(Migration ...) or allow for destructive migrations via one of the RoomDatabase.Builder.fallbackToDestructiveMigration* methods.

我的数据库版本之间的唯一区别是我添加了一个新列。迁移是这样处理的：

@Database(
version = 2,
entities = [Note::class],
exportSchema = true)
abstract class AppDatabase : RoomDatabase() {
abstract fun noteDao(): NoteDAO

companion object {
    fun build(context: Context) = Room.databaseBuilder(context, AppDatabase::class.java, "NotesDatabase")
        .addMigrations(MIGRATION_1_2).build()
    }
}

val MIGRATION_1_2 = object : Migration(1, 2) {
override fun migrate(database: SupportSQLiteDatabase) {
    database.execSQL("ALTER TABLE Notes ADD COLUMN image STRING")
    }
}

我不确定我是否正确实现了这一点。该错误告诉我必须以某种方式调用 .build()。我在使用数据库的活动中尝试了这一点，但错误是相同的，因此我删除了该调用。

我该如何解决这个问题？

Answer 1

看来您没有调用构建函数，并且可能有另一种构建数据库的方法（调用databaseBuilder）。

例如，在活动/片段中，您有类似的内容：-

class MainActivity : AppCompatActivity() {
    lateinit var db: AppDatabase
    lateinit var dao: NoteDAO
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        db = Room.databaseBuilder(this,AppDatabase::class.java,"NotesDatabase")
            .allowMainThreadQueries()
            .build()
        dao = db.noteDao()
        dao.getAllNotes()
    }
}

在更改 Note 实体并将版本增加到 2 后会产生结果，例如：-

java.lang.IllegalStateException: A migration from 1 to 2 was required but not found. Please provide the necessary Migration path via RoomDatabase.Builder.addMigration(Migration ...) or allow for destructive migrations via one of the RoomDatabase.Builder.fallbackToDestructiveMigration* methods.

相反，您需要调用 AppDatabase 的构建函数，

因此上面的内容将变为：-

class MainActivity : AppCompatActivity() {
    lateinit var db: AppDatabase
    lateinit var dao: NoteDAO
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        db = AppDatabase.build(this) //<<<<<<<<<< CHANGED
        dao = db.noteDao()
        dao.getAllNotes() // Forces database access/open
    }
}

但是，然后您将收到类似以下内容的预期/发现问题：-

2022-03-21 09:15:20.385 14533-14533/a.a.so71549033kotlinroommigration E/AndroidRuntime: FATAL EXCEPTION: main
    Process: a.a.so71549033kotlinroommigration, PID: 14533
    java.lang.RuntimeException: Unable to start activity ComponentInfo{a.a.so71549033kotlinroommigration/a.a.so71549033kotlinroommigration.MainActivity}: java.lang.IllegalStateException: Migration didn't properly handle: notes(a.a.so71549033kotlinroommigration.Note).
     Expected:
    TableInfo{name='notes', columns={noteText=Column{name='noteText', type='TEXT', affinity='2', notNull=true, primaryKeyPosition=0, defaultValue='null'}, image=Column{name='image', type='TEXT', affinity='2', notNull=true, primaryKeyPosition=0, defaultValue='null'}, noteId=Column{name='noteId', type='INTEGER', affinity='3', notNull=false, primaryKeyPosition=1, defaultValue='null'}}, foreignKeys=[], indices=[]}
     Found:
    TableInfo{name='notes', columns={noteText=Column{name='noteText', type='TEXT', affinity='2', notNull=true, primaryKeyPosition=0, defaultValue='null'}, image=Column{name='image', type='STRING', affinity='1', notNull=false, primaryKeyPosition=0, defaultValue='null'}, noteId=Column{name='noteId', type='INTEGER', affinity='3', notNull=false, primaryKeyPosition=1, defaultValue='null'}}, foreignKeys=[], indices=[]}
        at android.app.ActivityThread.performLaunchActivity(ActivityThread.java:3449)
        at android.app.ActivityThread.handleLaunchActivity(ActivityThread.java:3601)
        at android.app.servertransaction.LaunchActivityItem.execute(LaunchActivityItem.java:85)
        at android.app.servertransaction.TransactionExecutor.executeCallbacks(TransactionExecutor.java:135)
        at android.app.servertransaction.TransactionExecutor.execute(TransactionExecutor.java:95)
        at android.app.ActivityThread$H.handleMessage(ActivityThread.java:2066)
        at android.os.Handler.dispatchMessage(Handler.java:106)
        at android.os.Looper.loop(Looper.java:223)
        at android.app.ActivityThread.main(ActivityThread.java:7656)
        at java.lang.reflect.Method.invoke(Native Method)
        at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:592)
        at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:947)

这是因为就房间而言，STRING 不是有效的列类型。

在上面你可以看到/提取 room 期望的：-

image=Column{name='image', type='TEXT', affinity='2', notNull=true, primaryKeyPosition=0, defaultValue='null'}

BUT Room 找到：-

image=Column{name='image', type='STRING', affinity='1', notNull=false, primaryKeyPosition=0, defaultValue='null'}

Room 只接受 INTEGER、REAL、TEXT 和 BLOB 的列类型（尽管 SQLite 在列类型方面更加灵活） 。

类型取决于变量的类型，此外 Room 对于定义的其他部分也非常具体，例如 NOT NULL 是否应该成为定义的一部分以及 DEFAULT 是否应该成为定义的一部分。

但是，Room 允许您准确确定列定义应该是什么。如果您对实体进行更改并编译项目，则 Room 会生成 java 代码，其中包括用于创建表的 SQL，并且在此 SQL 中是预期的列定义。

从 Android Studio 项目视图中，您将看到 Java（生成），在此下的类/文件中将包含一些类，其中之一是 AppDatabase_Impl。在这个类中将有一个方法createAlltables。此方法中包含所有表的 SQL。

例如：-

• 注意图像列，在本例中，编码为 var image: String
  • String 等于 TEXT 并且 NOT NULL。细绳？不会有 NOT NULL

但是，如果 ALTER 一个表并添加一个 NOT NULL 列，那么 SQLite 要求提供一个不为空的 DEFAULT，按照： - fa NOT NULL 约束被指定，那么该列必须有NULL 以外的默认值。 https://www.sqlite.org/lang_altertable.html

因此，在上面的情况下，如果发现的结果是 room 所期望的，那么 ALTER SQL 应该是：-

ALTER TABLE Notes ADD COLUMN image TEXT NOT NULL DEFAULT 'unknown'

• 'unknown' 可以是任何适合的内容