Hilt 测试指南

使用 Hilt 等依赖项注入框架的优点之一是，它能让您的代码测试变得更轻松。

单元测试

Hilt 对于单元测试并非必需，因为在测试使用构造函数注入的类时，您无需使用 Hilt 来实例化该类。相反，您可以直接调用类构造函数，传入虚假依赖项或模拟依赖项，就像构造函数未加注解一样。

Kotlin

@ActivityScoped
class AnalyticsAdapter @Inject constructor(
  private val service: AnalyticsService
) { ... }

class AnalyticsAdapterTest {

  @Test
  fun `Happy path`() {
    // You don't need Hilt to create an instance of AnalyticsAdapter.
    // You can pass a fake or mock AnalyticsService.
    val adapter = AnalyticsAdapter(fakeAnalyticsService)
    assertEquals(...)
  }
}

Java

@ActivityScope
public class AnalyticsAdapter {

  private final AnalyticsService analyticsService;

  @Inject
  AnalyticsAdapter(AnalyticsService analyticsService) {
    this.analyticsService = analyticsService;
  }
}

public final class AnalyticsAdapterTest {

  @Test
  public void happyPath() {
    // You don't need Hilt to create an instance of AnalyticsAdapter.
    // You can pass a fake or mock AnalyticsService.
    AnalyticsAdapter adapter = new AnalyticsAdapter(fakeAnalyticsService);
    assertEquals(...);
  }
}

端到端测试

对于集成测试，Hilt 会像在生产代码中一样注入依赖项。使用 Hilt 进行测试无需维护，因为 Hilt 会为每个测试自动生成一组新的组件。

添加测试依赖项

若要在测试中使用 Hilt，请在项目中添加 hilt-android-testing 依赖项

Groovy

dependencies {
    // For Robolectric tests.
    testImplementation 'com.google.dagger:hilt-android-testing:2.56.2'
    // ...with Kotlin.
    kaptTest 'com.google.dagger:hilt-android-compiler:2.56.2'
    // ...with Java.
    testAnnotationProcessor 'com.google.dagger:hilt-android-compiler:2.56.2'


    // For instrumented tests.
    androidTestImplementation 'com.google.dagger:hilt-android-testing:2.56.2'
    // ...with Kotlin.
    kaptAndroidTest 'com.google.dagger:hilt-android-compiler:2.56.2'
    // ...with Java.
    androidTestAnnotationProcessor 'com.google.dagger:hilt-android-compiler:2.56.2'
}

Kotlin

dependencies {
    // For Robolectric tests.
    testImplementation("com.google.dagger:hilt-android-testing:2.56.2")
    // ...with Kotlin.
    kaptTest("com.google.dagger:hilt-android-compiler:2.56.2")
    // ...with Java.
    testAnnotationProcessor("com.google.dagger:hilt-android-compiler:2.56.2")


    // For instrumented tests.
    androidTestImplementation("com.google.dagger:hilt-android-testing:2.56.2")
    // ...with Kotlin.
    kaptAndroidTest("com.google.dagger:hilt-android-compiler:2.56.2")
    // ...with Java.
    androidTestAnnotationProcessor("com.google.dagger:hilt-android-compiler:2.56.2")
}

UI 测试设置

您必须使用 @HiltAndroidTest 为使用 Hilt 的任何 UI 测试添加注解。此注解负责为每个测试生成 Hilt 组件。

此外，您还需要将 HiltAndroidRule 添加到测试类。它管理组件的状态，用于在测试中执行注入。

Kotlin

@HiltAndroidTest
class SettingsActivityTest {

  @get:Rule
  var hiltRule = HiltAndroidRule(this)

  // UI tests here.
}

Java

@HiltAndroidTest
public final class SettingsActivityTest {

  @Rule
  public HiltAndroidRule hiltRule = new HiltAndroidRule(this);

  // UI tests here.
}

接下来，您的测试需要知道 Hilt 为您自动生成的 Application 类。

测试应用

您必须在支持 Hilt 的 Application 对象中执行使用 Hilt 的衡量测试。该库提供 HiltTestApplication 供测试使用。如果您的测试需要不同的基本应用，请参阅自定义测试应用。

您必须将测试应用设置为在您的衡量测试或Robolectric 测试中运行。以下说明并非 Hilt 专属，而是关于如何指定在测试中运行自定义应用的一般指南。

在衡量测试中设置测试应用

若要在衡量测试中使用 Hilt 测试应用，您需要配置新的测试运行程序。这使得 Hilt 适用于项目中的所有衡量测试。执行以下步骤

在 androidTest 文件夹中创建一个扩展 AndroidJUnitRunner 的自定义类。
覆盖 newApplication 函数，并传入生成的 Hilt 测试应用的名称。

Kotlin

// A custom runner to set up the instrumented application class for tests.
class CustomTestRunner : AndroidJUnitRunner() {

    override fun newApplication(cl: ClassLoader?, name: String?, context: Context?): Application {
        return super.newApplication(cl, HiltTestApplication::class.java.name, context)
    }
}

Java

// A custom runner to set up the instrumented application class for tests.
public final class CustomTestRunner extends AndroidJUnitRunner {

  @Override
  public Application newApplication(ClassLoader cl, String className, Context context)
      throws ClassNotFoundException, IllegalAccessException, InstantiationException {
    return super.newApplication(cl, HiltTestApplication.class.getName(), context);
  }
}

接下来，按照衡量单元测试指南中的说明，在 Gradle 文件中配置此测试运行程序。确保使用完整的类路径。

Groovy

android {
    defaultConfig {
        // Replace com.example.android.dagger with your class path.
        testInstrumentationRunner "com.example.android.dagger.CustomTestRunner"
    }
}

Kotlin

android {
    defaultConfig {
        // Replace com.example.android.dagger with your class path.
        testInstrumentationRunner = "com.example.android.dagger.CustomTestRunner"
    }
}

在 Robolectric 测试中设置测试应用

如果您使用 Robolectric 测试 UI 层，可以在 robolectric.properties 文件中指定要使用的应用。

application = dagger.hilt.android.testing.HiltTestApplication

此外，您还可以使用 Robolectric 的 @Config 注解在每个测试中单独配置应用。

Kotlin

@HiltAndroidTest
@Config(application = HiltTestApplication::class)
class SettingsActivityTest {

  @get:Rule
  var hiltRule = HiltAndroidRule(this)

  // Robolectric tests here.
}

Java

@HiltAndroidTest
@Config(application = HiltTestApplication.class)
class SettingsActivityTest {

  @Rule public HiltAndroidRule hiltRule = new HiltAndroidRule(this);

  // Robolectric tests here.
}

如果您使用的 Android Gradle Plugin 版本低于 4.2，请通过在模块的 build.gradle 文件中应用以下配置，启用在本地单元测试中转换 @AndroidEntryPoint 类。

Groovy

hilt {
    enableTransformForLocalTests = true
}

Kotlin

hilt {
    enableTransformForLocalTests = true
}

有关 enableTransformForLocalTests 的更多信息，请参阅Hilt 文档。

测试功能

一旦 Hilt 准备好在测试中使用，您就可以使用多种功能来自定义测试流程。

在测试中注入类型

若要将类型注入测试中，请使用 @Inject 进行字段注入。若要指示 Hilt 填充 @Inject 字段，请调用 hiltRule.inject()。

请看衡量测试的以下示例：

Kotlin

@HiltAndroidTest
class SettingsActivityTest {

  @get:Rule
  var hiltRule = HiltAndroidRule(this)

  @Inject
  lateinit var analyticsAdapter: AnalyticsAdapter

  @Before
  fun init() {
    hiltRule.inject()
  }

  @Test
  fun `happy path`() {
    // Can already use analyticsAdapter here.
  }
}

Java

@HiltAndroidTest
public final class SettingsActivityTest {

  @Rule public HiltAndroidRule hiltRule = new HiltAndroidRule(this);

  @Inject AnalyticsAdapter analyticsAdapter;

  @Before
  public void init() {
    hiltRule.inject();
  }

  @Test
  public void happyPath() {
    // Can already use analyticsAdapter here.
  }
}

替换绑定

如果需要注入依赖项的虚假实例或模拟实例，您需要告知 Hilt 不要使用生产代码中使用的绑定，而是使用其他绑定。若要替换绑定，您需要将包含该绑定的模块替换为包含您要在测试中使用的绑定的测试模块。

例如，假设您的生产代码声明了 AnalyticsService 的绑定，如下所示：

Kotlin

@Module
@InstallIn(SingletonComponent::class)
abstract class AnalyticsModule {

  @Singleton
  @Binds
  abstract fun bindAnalyticsService(
    analyticsServiceImpl: AnalyticsServiceImpl
  ): AnalyticsService
}

Java

@Module
@InstallIn(SingletonComponent.class)
public abstract class AnalyticsModule {

  @Singleton
  @Binds
  public abstract AnalyticsService bindAnalyticsService(
    AnalyticsServiceImpl analyticsServiceImpl
  );
}

若要在测试中替换 AnalyticsService 绑定，请在 test 或 androidTest 文件夹中创建一个新的 Hilt 模块，其中包含虚假依赖项，并使用 @TestInstallIn 为其添加注解。该文件夹中的所有测试都将改为注入虚假依赖项。

Kotlin

@Module
@TestInstallIn(
    components = [SingletonComponent::class],
    replaces = [AnalyticsModule::class]
)
abstract class FakeAnalyticsModule {

  @Singleton
  @Binds
  abstract fun bindAnalyticsService(
    fakeAnalyticsService: FakeAnalyticsService
  ): AnalyticsService
}

Java

@Module
@TestInstallIn(
    components = SingletonComponent.class,
    replaces = AnalyticsModule.class
)
public abstract class FakeAnalyticsModule {

  @Singleton
  @Binds
  public abstract AnalyticsService bindAnalyticsService(
    FakeAnalyticsService fakeAnalyticsService
  );
}

在单个测试中替换绑定

若要在单个测试而非所有测试中替换绑定，请使用 @UninstallModules 注解从测试中卸载 Hilt 模块，并在测试内部创建一个新的测试模块。

沿用 AnalyticsService 示例，首先使用测试类中的 @UninstallModules 注解指示 Hilt 忽略生产模块。

Kotlin

@UninstallModules(AnalyticsModule::class)
@HiltAndroidTest
class SettingsActivityTest { ... }

Java

@UninstallModules(AnalyticsModule.class)
@HiltAndroidTest
public final class SettingsActivityTest { ... }

接下来，您必须替换绑定。在测试类中创建一个定义测试绑定的新模块。

Kotlin

@UninstallModules(AnalyticsModule::class)
@HiltAndroidTest
class SettingsActivityTest {

  @Module
  @InstallIn(SingletonComponent::class)
  abstract class TestModule {

    @Singleton
    @Binds
    abstract fun bindAnalyticsService(
      fakeAnalyticsService: FakeAnalyticsService
    ): AnalyticsService
  }

  ...
}

Java

@UninstallModules(AnalyticsModule.class)
@HiltAndroidTest
public final class SettingsActivityTest {

  @Module
  @InstallIn(SingletonComponent.class)
  public abstract class TestModule {

    @Singleton
    @Binds
    public abstract AnalyticsService bindAnalyticsService(
      FakeAnalyticsService fakeAnalyticsService
    );
  }
  ...
}

这只会替换单个测试类的绑定。如果要替换所有测试类的绑定，请使用上文中的 @TestInstallIn 注解。此外，您还可以将测试绑定放入 Robolectric 测试的 test 模块，或放入衡量测试的 androidTest 模块中。建议尽可能使用 @TestInstallIn。

绑定新值

使用 @BindValue 注解可轻松将测试中的字段绑定到 Hilt 依赖项图中。使用 @BindValue 为字段添加注解后，该字段将绑定到声明的字段类型下，并带上该字段的任何限定符。

在 AnalyticsService 示例中，您可以通过使用 @BindValue 将 AnalyticsService 替换为虚假值。

Kotlin

@UninstallModules(AnalyticsModule::class)
@HiltAndroidTest
class SettingsActivityTest {

  @BindValue @JvmField
  val analyticsService: AnalyticsService = FakeAnalyticsService()

  ...
}

Java

@UninstallModules(AnalyticsModule.class)
@HiltAndroidTest
class SettingsActivityTest {

  @BindValue AnalyticsService analyticsService = FakeAnalyticsService();

  ...
}

这允许您同时进行绑定替换和绑定引用，从而简化了测试中的操作。

@BindValue 与限定符和其他测试注解配合使用。例如，如果您使用 Mockito 等测试库，则可以在 Robolectric 测试中按以下方式使用它：

Kotlin

...
class SettingsActivityTest {
  ...

  @BindValue @ExampleQualifier @Mock
  lateinit var qualifiedVariable: ExampleCustomType

  // Robolectric tests here
}

Java

...
class SettingsActivityTest {
  ...
  @BindValue @ExampleQualifier @Mock ExampleCustomType qualifiedVariable;

  // Robolectric tests here
}

如果您需要添加多重绑定，您可以使用 @BindValueIntoSet 和 @BindValueIntoMap 注解来代替 @BindValue。@BindValueIntoMap 要求您还使用映射键注解来注解该字段。

特殊情况

Hilt 还提供了一些功能来支持非标准用例。

自定义测试应用

如果您不能使用 HiltTestApplication（因为您的测试应用需要扩展另一个应用），请使用 @CustomTestApplication 注解新的类或接口，并传入您希望生成的 Hilt 应用扩展的基本类的值。

@CustomTestApplication 将生成一个 Application 类，该类可用于 Hilt 测试，并扩展您作为参数传入的应用。

Kotlin

@CustomTestApplication(BaseApplication::class)
interface HiltTestApplication

Java

@CustomTestApplication(BaseApplication.class)
interface HiltTestApplication { }

在示例中，Hilt 生成了一个名为 HiltTestApplication_Application 的 Application 类，它扩展了 BaseApplication 类。通常，生成的应用的名称是加注解的类名后附加 _Application。您必须将生成的 Hilt 测试应用设置为在您的衡量测试或Robolectric 测试中运行，如测试应用中所述。

衡量测试中的多个 TestRule 对象

如果您的测试中还有其他 TestRule 对象，则有多种方法可以确保所有规则协同工作。

您可以按如下方式将这些规则打包在一起：

Kotlin

@HiltAndroidTest
class SettingsActivityTest {

  @get:Rule
  var rule = RuleChain.outerRule(HiltAndroidRule(this)).
        around(SettingsActivityTestRule(...))

  // UI tests here.
}

Java

@HiltAndroidTest
public final class SettingsActivityTest {

  @Rule public RuleChain rule = RuleChain.outerRule(new HiltAndroidRule(this))
        .around(new SettingsActivityTestRule(...));

  // UI tests here.
}

此外，只要 HiltAndroidRule 先执行，您也可以在同一级别使用这两个规则。使用 @Rule 注解中的 order 属性指定执行顺序。这仅适用于 JUnit 4.13 或更高版本。

Kotlin

@HiltAndroidTest
class SettingsActivityTest {

  @get:Rule(order = 0)
  var hiltRule = HiltAndroidRule(this)

  @get:Rule(order = 1)
  var settingsActivityTestRule = SettingsActivityTestRule(...)

  // UI tests here.
}

Java

@HiltAndroidTest
public final class SettingsActivityTest {

  @Rule(order = 0)
  public HiltAndroidRule hiltRule = new HiltAndroidRule(this);

  @Rule(order = 1)
  public SettingsActivityTestRule settingsActivityTestRule = new SettingsActivityTestRule(...);

  // UI tests here.
}

launchFragmentInContainer

无法使用 androidx.fragment:fragment-testing 库中的 launchFragmentInContainer 与 Hilt 结合使用，因为它依赖于未用 @AndroidEntryPoint 注解的 Activity。

请改用 launchFragmentInHiltContainer GitHub 代码库中的 architecture-samples 代码。

在单例组件可用之前使用入口点

@EarlyEntryPoint 注解提供了一个逃生舱，可在 Hilt 测试中需要创建 Hilt 入口点而单例组件尚未可用时使用。

有关 @EarlyEntryPoint 的更多信息，请参阅Hilt 文档。

Hilt 测试指南 使用收藏夹保持井然有序 根据您的偏好保存和分类内容。

单元测试

Kotlin

Java

端到端测试

添加测试依赖项

Groovy

Kotlin

UI 测试设置

Kotlin

Java

测试应用

在衡量测试中设置测试应用

Kotlin

Java

Groovy

Kotlin

在 Robolectric 测试中设置测试应用

Kotlin

Java

Groovy

Kotlin

测试功能

在测试中注入类型

Kotlin

Java

替换绑定

Kotlin

Java

Kotlin

Java

在单个测试中替换绑定

Kotlin

Java

Kotlin

Java

绑定新值

Kotlin

Java

Kotlin

Java

特殊情况

自定义测试应用

Kotlin

Java

衡量测试中的多个 TestRule 对象

Kotlin

Java

Kotlin

Java

launchFragmentInContainer

在单例组件可用之前使用入口点

Hilt 测试指南