Robolectric — 简介、工作原理及 Android 单元测试

什么是 Robolectric

Robolectric 是一个开源框架，创建于 2010 年，用于加速 Android 应用程序的测试。Robolectric 不是在模拟器或设备上运行，而是提供直接在 Java 虚拟机 (JVM) 上运行的 Android SDK 类的 shadow 实现。这使得可以在数秒内执行数千个测试。

Robolectric 解决的问题

传统的 Android 测试需要在模拟器上运行应用程序，构建 APK、安装和启动需要 3-10 分钟。Robolectric 消除了这一步骤：测试作为普通的 Java/Kotlin 测试编译并通过 JUnit 运行。这提供了数秒而非数分钟的反馈循环。

支持的 Android 版本

Robolectric 支持从 API 16（Android 4.1）到最新稳定版的所有 Android 版本。每个版本都提供相应的shadow 对象集，模拟测试应用程序所在平台的确切版本的行为。

架构与 shadow 对象

Robolectric 的架构基于通过替换 classloader 来拦截调用的机制。当测试调用 Android SDK 方法时，Robolectric 拦截该调用并将其导向 shadow 对象。Shadow 对象是一个 Java 类，模拟 Android 组件的真实行为，但在没有原生平台的情况下运行。

Shadow 的工作原理

Shadow 对象实现了原始 Android 类的关键方法。例如，ShadowTextView 模拟 getText()、setText()、getCurrentTextColor() 等方法。当调用 textView.setText(“Hello”) 时，shadow 保存字符串并在调用 getText() 时返回它。这使测试与真实渲染和系统服务隔离开来。

Shadow 层次结构

Robolectric 支持超过200 个 shadow 类，涵盖 Android SDK 的主要组件：Activity、Fragment、TextView、Button、RecyclerView、WebView、LocationManager、ConnectivityManager 等。Shadow 对象遵循与原始 Android 类相同的继承层次结构。

安装与配置 Robolectric

在 Gradle 项目中安装 Robolectric 需要添加依赖 testImplementation “org.robolectric:robolectric:4.x”。还需要在 build.gradle 文件中指定android:sdk配置并添加 android:testInstrumentationRunner。使用 Robolectric 不需要 android-test 插件。

基本 Gradle 配置

添加依赖后，需要为清单、资源和资产配置目录。Robolectric 会自动找到 AndroidManifest.xml，但可能需要通过 @Config 注解或系统属性手动指定路径。对于多模块项目，每个模块单独设置配置。

// build.gradle — Robolectric 配置
android {
    testOptions {
        unitTests.includeAndroidResources = true
        unitTests.all {
            systemProperty 'robolectric.dependency.dir',
                project.rootDir.absolutePath + '/build/intermediates'
        }
    }
}

dependencies {
    testImplementation 'org.robolectric:robolectric:4.13'
    testImplementation 'org.junit.jupiter:junit-jupiter:5.10.0'
}

@Config 注解

@Config 注解允许覆盖测试参数：sdk（API 版本）、manifest（清单路径）、qualifiers（屏幕配置、语言）。这有助于测试应用程序在不同 Android 版本、屏幕方向和本地化下的行为。

使用 Robolectric 编写测试

Robolectric 测试作为普通的单元测试编写，对于 JUnit 4 使用 @RunWith(RobolectricTestRunner.class)，对于 JUnit 5 通过 RobolectricExtension。ActivityController 管理 Activity 的生命周期：create()、start()、resume()、pause()、stop()、destroy()。这允许详细测试每个状态转换。

测试 Activity

测试 Activity 使用 ActivityController，它顺序地经历生命周期阶段。通过 controller.get() 访问 Activity。所有视图组件都像在实际应用程序中一样通过 findViewById 访问。Shadow 对象允许检查文本、可见性、颜色和其他视图属性。

@RunWith(RobolectricTestRunner.class)
@Config(sdk = BuildConfig.SDK_INT)
public class MainActivityTest {

    @Test
    public void testActivityDisplaysGreeting() {
        ActivityController<MainActivity> controller =
            Robolectric.buildActivity(MainActivity.class);
        controller.create().start().resume();

        MainActivity activity = controller.get();
        TextView greeting = activity.findViewById(R.id.greeting);
        ShadowTextView shadow = Shadows.shadowOf(greeting);

        assertEquals("Welcome!", shadow.getText());
    }
}

测试 Intent 和导航

Robolectric 拦截 startActivity() 调用，并允许通过 ShadowActivity 检查发送的 Intent。这提供了测试导航的能力：验证点击按钮时是否发送了具有正确 Action、Data 和 Extra 参数的 Intent。

@Test
public void testNavigationToDetails() {
    controller.create().start().resume();
    MainActivity activity = controller.get();

    activity.findViewById(R.id.detailsButton).performClick();

    ShadowActivity shadowActivity = Shadows.shadowOf(activity);
    Intent intent = shadowActivity.getNextStartedActivity();
    assertEquals(
        DetailsActivity.class.getName(),
        intent.getComponent().getClassName()
    );
}

Robolectric 对比模拟器

Robolectric 和模拟器解决不同的任务。Robolectric 非常适合快速单元测试、检查 UI 逻辑、业务组件和仓库。模拟器对于仪器化测试、API 集成检查、摄像头、传感器和性能测试是必需的。

测试 ViewModel 和 Repository

Robolectric 非常适合测试 ViewModel、Repository 和 UseCase——这些组件使用 Android SDK 但不需要真实 UI。ViewModel 通过带有 RobolectricExtension 的普通 JUnit 测试进行测试，生命周期组件（LiveData、StateFlow）在 shadow 环境中无需模拟即可工作。

测试 LiveData

Robolectric 开箱即用地支持 LiveData：可以在测试中订阅 LiveData，通过 ViewModel 更改状态并检查发出的值。对于异步操作，使用 InstantTaskExecutorRule 或用于协程的 runBlocking。这消除了模拟架构组件的需要。

@RunWith(RobolectricTestRunner::class)
@Config(sdk = [BuildConfig.SDK_INT])
class ProfileViewModelTest {

    private val repository = FakeUserRepository()
    private val viewModel = ProfileViewModel(repository)

    @Test
    fun `loading profile sets state to success`() = runBlocking {
        viewModel.loadProfile("user123")
        val state = viewModel.profileState.getOrAwaitValue()
        Assertions.assertTrue(state is UiState.Success)
    }
}

自定义 Shadow 对象

如果 Robolectric 的标准 shadow 对象未覆盖所需的 Android SDK 类，可以创建自定义 Shadow。为此，创建一个带有 @Implements(ClassName.class) 注解的类，并使用 @Implementation 实现所需的方法。自定义 shadow 通过 @Config(shadows = [CustomShadow::class]) 注册。

测试 ContentProvider 和 Resources

Robolectric 支持通过 Robolectric.buildContentProvider() 测试 ContentProvider。可以检查 CRUD 操作、带 URI 匹配的查询以及访问权限处理。资源（字符串、颜色、尺寸）也可以通过 RuntimeEnvironment.application.resources 访问，从而允许测试依赖资源的代码。

从模拟器迁移到 Robolectric

从仪器化测试转向 Robolectric 需要改变方法。仪器化测试（AndroidJUnit4）检查模拟器上的真实行为，而 Robolectric 检查 shadow 环境中的隔离逻辑。建议用 Robolectric 测试覆盖业务逻辑，并将仪器化测试保留用于集成场景。

调整现有测试

迁移时需要：将 AndroidJUnit4 替换为 RobolectricTestRunner，添加带有目标 SDK 版本的 @Config，将 ActivityTestRule 替换为 ActivityController，并将依赖项从 androidTestImplementation 转移到 testImplementation。模拟（MockK、Mockito）可以在 Robolectric 中无需修改地工作——它们不依赖平台。

迁移时的限制

Robolectric 不支持：测试摄像头（CameraX）、NFC、蓝牙、生物识别、处理真实文件和原生库。对于这些场景，需要在模拟器上进行仪器化测试。Robolectric 也不重现真实渲染——布局测试最好通过 Compose Test Rule 或 Espresso 执行。然而，对于检查业务逻辑、导航和 ViewModel 状态，Robolectric 完全替代模拟器，运行速度提升 10 倍。

与 Java 和 Kotlin 版本的兼容性

Robolectric 需要 JDK 11 或更高版本，并与 AGP（Android Gradle Plugin）从 7.0 到最新稳定版兼容。Robolectric 的 SDK 管理器在首次启动时自动下载所需的 Android API 版本——这是一次性操作。对于 CI 服务器，建议通过 sdkmanager 预先下载 SDK，以避免首次运行测试时的延迟。将 Robolectric 更新到新版本通常不需要修改测试代码，只需更新 build.gradle 中的依赖号。

与 MockK 和 Mockito 的集成

Robolectric 与流行的模拟框架兼容：用于 Kotlin 的 MockK 和用于 Java 的 Mockito。模拟用于隔离依赖项：仓库、API 客户端、SharedPreferences。主要规则——不要模拟 Android SDK 类，shadow 对象用于此目的。仅模拟应用程序层：UseCase、Repository、DataSource 和其他业务逻辑组件。这种 shadow 对象和模拟的组合提供了最大的灵活性，同时最小化编写测试的成本。