测试和调试数据库

在使用 Room 持久性库创建数据库时,您应验证应用的数据库以及用户的数据是否稳定。本页介绍了如何测试数据库和执行调试步骤,以帮助您通过测试。

测试您的数据库

您可以通过以下两种方式测试数据库:

  • 在搭载 Android 的设备上
  • 在主机开发机器上

如需了解专门针对数据库迁移的测试,请参阅测试迁移

在搭载 Android 的设备上测试

如需测试数据库实现,建议您编写在搭载 Android 的设备上运行的 JUnit 测试。由于这些测试不需要 activity,因此它们的运行速度比界面测试快。

在设置测试时,您应创建内存版本的数据库以使测试更加封闭,如以下示例所示:

import kotlinx.coroutines.test.runTest

@RunWith(AndroidJUnit4::class)
class SimpleEntityReadWriteTest {
    private lateinit var userDao: UserDao
    private lateinit var db: TestDatabase

    @Before
    fun createDb() {
        val context = ApplicationProvider.getApplicationContext<Context>()
        db = Room.inMemoryDatabaseBuilder<TestDatabase>(context)
                .setDriver(BundledSQLiteDriver())
                .build()
        userDao = db.userDao()
    }

    @After
    fun closeDb() {
        db.close()
    }

    @Test
    fun writeUserAndReadInList() = runTest {
        val user = User(3, "george")
        userDao.insert(user)
        val byName = userDao.findUsersByName("george")
        assertEquals(byName.single(), user)
    }
}

在宿主机 (JVM) 上测试

借助 Room KMP,您可以使用本地 JVM JUnit 测试在主机开发机器上运行数据库测试。此设置可消除 Android 模拟器或设备的开销,从而加快测试运行速度。

为帮助保持一致性,请使用 BundledSQLiteDriver。此驱动程序包含从源代码编译的 SQLite,可在宿主机、Android 设备和 iOS 设备上使用完全相同的 SQLite 版本。使用此驱动程序可消除版本不一致问题。

如需设置 JVM 测试,请在测试数据库构建器中配置 BundledSQLiteDriver

val db = Room.inMemoryDatabaseBuilder<TestDatabase>()
    .setDriver(BundledSQLiteDriver())
    .build()

测试迁移

Room 支持增量数据库迁移,以便在应用更新更改数据库架构时保留现有应用数据。不过,如果迁移定义有误,可能会导致应用崩溃。请务必测试 Room 数据库迁移

调试数据库

您可以使用多种工具和流程来调试数据库。

使用 Database Inspector

在 Android Studio 4.1 及更高版本中,您可以利用数据库检查器在应用运行时检查、查询和修改应用的数据库。数据库检查器与 Android 捆绑版本的 SQLite 兼容,并且包含与 Room 搭配使用的特殊功能:

  • 使用边线操作从 DAO 类中运行查询。
  • 当正在运行的应用更改数据时,您可以在数据库检查器中立即看到实时更新。

如需详细了解数据库检查器,请参阅使用数据库检查器调试数据库

通过命令行转储数据

Android SDK 包含一个 sqlite3 数据库工具,可用于检查应用的数据库。它包含用于输出表格内容的 .dump 以及用于输出现有表格的 SQL CREATE 语句的 .schema 等命令。

您也可以从命令行执行 SQLite 命令,如以下代码段所示:

adb -s emulator-5554 shell sqlite3
/data/data/your-app-package/databases/rssitems.db

如需了解详情,请参阅 SQLite 网站上提供的 sqlite3 命令行文档

其他资源

如需详细了解如何测试和调试 Room 数据库,请参阅下面列出的其他资源:

博文

视频