使用 Awaitility 测试异步代码

阳光穿透心脏的1/2处 2022-06-17 07:28 98阅读 0赞

对于同步方法的测试很简单，调用完后可立马检查执行状态; 而异步方法，由于我们无法确切的知道何时结束，因此以往的办法是用 `Thread.sleep(500)` 来预估一个执行时间。然后通常我们估计的要长于实际的时间，这就很浪费，况且偶然的超过预估的等待时间也并不意味着代码有问题。还有 `sleep` 方法还抛出一个检测异常 `InterruptedException`, 一般会要对 `Thread.sleep(500)` 作下简单包装。

于是今天要介绍的 [Awaitility][] 就应运而生了，专门针对异步方法的测试。它的官方文档在 [https://github.com/awaitility/awaitility/wiki/Usage][https_github.com_awaitility_awaitility_wiki_Usage]。本文主要关注在 Java 8 环境下用 Lambda 的代码书写方式。Awaitlity 实际运行是以某种轮询的方式来检查是否达到某个运行状态，可设定最多，最少等待时间，或永久等待，或自定义轮询策略，之后就开始进行需要的断言，所以它可以尽可能的节省测试异步方法所需的时长。而不像 `Thread.sleep(500)` 一路等到黑，并且没有回头路。

通常我会在项目中给 JUnit 配上三个最佳伴侣，它们是(按 `mvn dependency:tree` 中的显示方式):

1.  org.awaitility:awaitility:2.0.0:test
2.  org.easytesting:fest-assert:1.4:test
3.  org.mockito:mockito-core:2.7.22:test

当然如果项目中没有异步调用自然是不需要 Awaitility, 在我的项目中是基本不可能的。以上三种都追求 DSL，以流畅的方式进行愉快的测试。

现在来尝试下 Awaitility 的几种基本的用法，先假定有下面的代码 `UserService` [阅读全文 >>][Link 1]

[Awaitility]: http://www.awaitility.org/
[https_github.com_awaitility_awaitility_wiki_Usage]: https://github.com/awaitility/awaitility/wiki/Usage
[Link 1]: https://yanbin.blog/test-asyn-call-with-awaitility/#more-8002