空闲资源表示一种异步操作,其结果会影响界面测试中的后续操作。通过向 Espresso 注册空闲资源,您可以在测试应用时更可靠地验证这些异步操作。
确定何时需要空闲资源
Espresso 提供了一组复杂的同步功能。不过,框架的这一特性仅适用于在 MessageQueue 上发布消息的操作,例如在屏幕上绘制其内容的 View 子类。
由于 Espresso 不知道任何其他异步操作(包括在后台线程上运行的操作),因此在这些情况下,Espresso 无法提供其同步保证。为了让 Espresso 知道应用的长时间运行的操作,您必须将每个操作注册为空闲资源。
如果您在测试应用的异步工作结果时不使用空闲资源,则可能需要使用以下某种不理想的解决方法来提高测试的可靠性:
- 正在向“
Thread.sleep()”添加电话素材资源。如果您在测试中添加人为延迟,测试套件需要更长时间才能完成执行,并且在较慢的设备上执行时,测试有时仍可能会失败。此外,这些延迟无法很好地扩缩,因为您的应用可能必须在未来版本中执行更耗时的异步工作。 - 实现重试封装容器,该容器使用循环来重复检查应用是否仍在执行异步工作,直到发生超时。即使您在测试中指定了重试次数上限,每次重新执行也会消耗系统资源,尤其是 CPU。
- 使用
CountDownLatch的实例,允许一个或多个线程等待,直到在另一个线程中执行的特定数量的操作完成。这些对象要求您指定超时时长;否则,您的应用可能会无限期地被屏蔽。这些闩锁还会给代码增加不必要的复杂性,使维护变得更加困难。
Espresso 允许您从测试中移除这些不可靠的解决方法,改为将应用的异步工作注册为空闲资源。
常见应用场景
在测试中执行类似于以下示例的操作时,请考虑使用空闲资源:
- 从互联网或本地数据源加载数据。
- 与数据库和回调建立连接。
- 管理服务,使用系统服务或
IntentService的实例。 - 执行复杂的业务逻辑,如位图转换。
当这些操作更新测试随后验证的界面时,注册空闲资源尤为重要。
空闲资源实现示例
以下列表介绍了您可以集成到应用中的几种空闲资源实现示例:
CountingIdlingResource- 维护活动任务的计数器。当计数器为零时,关联的资源会被视为空闲。此功能与
Semaphore的功能非常相似。在大多数情况下,此实现足以在测试期间管理应用的异步工作。 UriIdlingResource- 与
CountingIdlingResource类似,但计数器需要在特定时间段内为零,然后资源才会被视为闲置。此额外等待期会考虑连续的网络请求,其中线程中的应用可能会在收到对上一个请求的响应后立即发出新请求。 IdlingThreadPoolExecutorThreadPoolExecutor的自定义实现,用于跟踪所创建线程池中正在运行的任务总数。此类使用CountingIdlingResource来维护活跃任务的计数器。IdlingScheduledThreadPoolExecutorScheduledThreadPoolExecutor的自定义实现。它提供与IdlingThreadPoolExecutor类相同的功能,但它还可以跟踪计划在未来执行或计划定期执行的任务。
创建您自己的空闲资源
在应用的测试中使用空闲资源时,您可能需要提供自定义资源管理或日志记录。在这些情况下,上一部分中列出的实现可能不够。如果是这种情况,您可以扩展其中一个空闲资源实现,也可以创建自己的实现。
如果您实现自己的空闲资源功能,请牢记以下最佳实践,尤其是第一条:
- 在空闲检查之外调用转换到空闲状态。
- 在应用进入空闲状态后,在
isIdleNow()的任何实现之外调用onTransitionToIdle()。这样,Espresso 就不会进行第二次不必要的检查来确定给定的空闲资源是否处于空闲状态。
以下代码段说明了此建议:
fun isIdle() { // DON'T call callback.onTransitionToIdle() here! } fun backgroundWorkDone() { // Background work finished. callback.onTransitionToIdle() // Good. Tells Espresso that the app is idle. // Don't do any post-processing work beyond this point. Espresso now // considers your app to be idle and moves on to the next test action. }
- 在需要之前注册空闲资源。
只有在 Espresso 首次调用该资源的
isIdleNow()方法后,与空闲资源相关的同步优势才会生效。以下列表显示了此属性的几个示例:
- 如果您在带有
@Before注解的方法中注册空闲资源,则该空闲资源会在每个测试的第一行中生效。 - 如果您在测试中注册空闲资源,则该空闲资源会在下一个基于 Espresso 的操作期间生效。即使下一个操作与注册空闲资源的语句位于同一测试中,也会发生此行为。
- 如果您在带有
- 使用完空闲资源后将其取消注册。
为了节省系统资源,您应在不再需要空闲资源时立即将其取消注册。例如,如果您在带有
@Before注解的方法中注册了空闲资源,最好在带有@After注解的相应方法中取消注册此资源。- 使用空闲资源注册表来注册和取消注册空闲资源。
通过将此容器用于应用的空闲资源,您可以根据需要重复注册和取消注册空闲资源,并且仍能观察到一致的行为。
- 在空闲资源内仅维护简单的应用状态。
例如,您实现和注册的空闲资源不应包含对
View对象的引用。
注册空闲资源
Espresso 提供了一个容器类,您可以在其中放置应用的空闲资源。此类名为 IdlingRegistry,是一个自包含工件,对应用造成的开销极小。该类还允许您采取以下步骤来提高应用的可维护性:
- 在应用的测试中,创建对
IdlingRegistry的引用,而不是对其包含的空闲资源的引用。 - 针对每个 build 变体,维护不同的空闲资源集合。
- 在应用的服务中定义空闲资源,而不是在引用这些服务的界面组件中定义。
将空闲资源集成到应用中
虽然您可以通过多种不同的方式向应用添加空闲资源,但有一种方法特别适合为应用保持封装,同时仍允许您指定给定空闲资源所代表的特定操作。
建议的方法
向应用添加空闲资源时,我们强烈建议您将空闲资源逻辑放在应用本身中,并且仅在测试中执行注册和取消注册操作。
虽然您通过遵循此方法在生产代码中创建了使用仅测试接口的异常情况,但您可以将空闲资源封装在您已有的代码周围,从而保持应用的 APK 大小和方法数量。
替代方法
如果您不希望在应用的正式版代码中包含空闲资源逻辑,可以采用其他几种可行的集成策略:
- 创建 build 变体(例如 Gradle 的产品变种),并仅在应用的调试 build 中使用空闲资源。
- 使用 Dagger 等依赖项注入框架将应用的空闲资源依赖项图表注入到测试中。如果您使用的是 Dagger 2,则注入本身应源自子组件。
在应用的测试中实现空闲资源,并公开需要在这些测试中同步的应用实现部分。
注意:虽然此设计决策似乎创建了对空闲资源的自包含引用,但它也会破坏除最简单的应用之外的所有应用中的封装。
其他资源
如需详细了解如何在 Android 测试中使用 Espresso,请参阅以下资源。
示例
- IdlingResourceSample:与后台作业同步。