测试 Compose 布局

测试应用界面，验证 Compose 代码的行为是否正确。这样，您就可以尽早发现错误并提高应用质量。

Compose 提供了一组测试 API，用于查找元素、验证其属性以及执行用户操作。这些 API 还包含时间处理等高级功能。您可以使用这些 API 创建强大的测试，以验证应用的行为。

次观看

如果您使用的是 View 而不是 Compose，请参阅常规的在 Android 平台上测试应用部分。

特别是，最好从自动化界面测试指南开始。它介绍了如何自动执行在设备上运行的测试，包括使用视图进行的测试。

关键概念

以下是测试 Compose 代码的一些关键概念。

  • 语义：Compose 测试使用语义与界面交互，这些语义为界面的各个部分赋予意义，并与界面层次结构一起生成。
  • 测试 API：Compose 提供了用于查找元素、对其状态和属性创建断言以及执行操作来模拟用户互动的测试 API。
  • 同步：默认情况下，Compose 测试会自动与界面同步，等待界面空闲后再进行断言或执行操作。
  • 互操作性：在混合应用中，测试可以与 Compose 和基于 View 的元素无缝交互，并与其他测试框架集成。

测试备忘单

如需简要了解在 Compose 中进行测试的所有关键主题，请参阅测试备忘单。

设置

设置应用，以便测试 Compose 代码。

首先，将以下依赖项添加到包含界面测试的模块的 build.gradle 文件中：

// Test rules and transitive dependencies:
androidTestImplementation("androidx.compose.ui:ui-test-junit4:$compose_version")
// Needed for createComposeRule(), but not for createAndroidComposeRule<YourActivity>():
debugImplementation("androidx.compose.ui:ui-test-manifest:$compose_version")

此模块包含 ComposeTestRule 和一个名为 AndroidComposeTestRule 的 Android 实现。通过此规则，您可以设置 Compose 内容或访问 activity。您可以使用工厂函数（createComposeRule）构建规则；如果需要访问 activity，也可以使用 createAndroidComposeRule。Compose 的典型界面测试如下所示：

// file: app/src/androidTest/java/com/package/MyComposeTest.kt

class MyComposeTest {

    @get:Rule val composeTestRule = createComposeRule()
    // use createAndroidComposeRule<YourActivity>() if you need access to
    // an activity

    @Test
    fun myTest() {
        // Start the app
        composeTestRule.setContent {
            MyAppTheme {
                MainScreen(uiState = fakeUiState, /*...*/)
            }
        }

        composeTestRule.onNodeWithText("Continue").performClick()

        composeTestRule.onNodeWithText("Welcome").assertIsDisplayed()
    }
}

其他资源

  • 在 Android 平台上测试应用：Android 测试主着陆页会为您提供关于测试基础知识和技术的更全面的视图。
  • 测试基础知识：详细了解测试 Android 应用背后的核心概念。
  • 本地测试：您可以在自己的工作站上本地运行一些测试。
  • 插桩测试：最好同时运行插桩测试。也就是说，直接在设备上运行的测试。
  • 持续集成：借助持续集成，您可以将测试集成到部署流水线中。
  • 测试不同的屏幕尺寸：由于用户可使用许多设备，因此您应该针对不同的屏幕尺寸进行测试。
  • Espresso：虽然适用于基于 View 的界面，但掌握 Espresso 对 Compose 测试的某些方面仍然很有帮助。

Codelab

如需了解详情，请参阅 Jetpack Compose 测试 Codelab。

示例