测试RxJava
xiaomi
8年前
<h2>关键要点：</h2> <ul> <li> <p>RxJava含有内建的、测试友好的解决方案。</p> </li> <li> <p>使用TestSubscriber去验证Observable。</p> </li> <li> <p>使用TestScheduler可实现对时间的严格控制。</p> </li> <li> <p>Awaitility库提供了对测试环境进一步的控制。</p> </li> </ul> <p>你已经阅读过RxJava的相关内容，也已经在互联网上体验过像“RxJava by Example”中的那些示例，现在打算在自己的代码中探索一下响应式编程了。但是，现在却一直困扰着如何测试那些可能会在代码库中发现的新功能呢？</p> <p>使用响应式编程，就必须转变对给定问题的推理方式，因为我们要聚焦于作为事件流的流动数据，而非个别数据项。事件通常是被不同的线程所产生和消费，因此在编写测试时必须要对并发问题有着清晰的认识。幸运的是，RxJava提供了测试Observable和Subscription的内建支持，并且是直接构建于RxJava的核心依赖中。</p> <h2><strong>第一步</strong></h2> <p>让我们回顾一下在“RxJava by Example”一文中所给出的那个词汇的例子，看一下如何对该例子作测试。让我们从基础测试工具的设置开始。在我们的测试架构中，使用了JUnit作为测试工具。</p> <pre> <code class="language-java">import rx.Observable; import rx.observers.TestSubscriber; import rx.plugins.RxJavaHooks; import rx.schedulers.Schedulers; import java.util.*; import static java.util.concurrent.TimeUnit.SECONDS; import static org.awaitility.Awaitility.await; import static org.hamcrest.Matchers.*; import org.junit.Test; import static org.junit.Assert.assertThat; public class RxJavaTest { private static final List<String> WORDS = Arrays.asList( "the", "quick", "brown", "fox", "jumped", "over", "the", "lazy", "dog" ); }</code></pre> <p>事实上在没有给定调度器（Scheduler）的情况下，Subscription将默认运行于调用线程上。因此我们将在首个测试中使用原生的方法。这意味着我们可实现一个Subscription接口的对象，在Subscription发生后就立刻对其状态做断言（assert）。</p> <pre> <code class="language-java">@Test public void testInSameThread() { // given: List<String> results = new ArrayList<>(); Observable<String> observable = Observable .from(WORDS) .zipWith(Observable.range(1, Integer.MAX_VALUE), (string, index) -> String.format("%2d. %s", index, string)); // when: observable.subscribe(results::add); // then: assertThat(results, notNullValue()); assertThat(results, hasSize(9)); assertThat(results, hasItem(" 4. fox")); }</code></pre> <p>注意这里使用了显式的List<String>容器，与实际订阅者一起累计结果。由于给定的测试很简单，所以可能会使你认为这种显式累加器的方法已经足够好了。但是切记产品级的Observable中可能封装了错误或可能产生意外的事件。例子中的Subscriber与累加器的简单组合并不足以覆盖这种情况。但不用为此烦恼，RxJava提供的TestSubscriber类型就是用于处理这种情况的。下面我们使用TestSubscriber类型重构上面的测试。</p> <pre> <code class="language-java">@Test public void testUsingTestSubscriber() { // given: TestSubscriber<String> subscriber = new TestSubscriber<>(); Observable<String> observable = Observable .from(WORDS) .zipWith(Observable.range(1, Integer.MAX_VALUE), (string, index) -> String.format("%2d. %s", index, string)); // when: observable.subscribe(subscriber); // then: subscriber.assertCompleted(); subscriber.assertNoErrors(); subscriber.assertValueCount(9); assertThat(subscriber.getOnNextEvents(), hasItem(" 4. fox")); }</code></pre> <p>TestSubscriber不仅可替代用户累加器，还另给出了一些行为。例如它能够给出接收到的消息和每个事件相关数据的规模，它也可对Subscription被完成且在Observable消费期间没有错误出现的状态做断言。虽然当前测试中的Observable并未生成任何的错误，但是回到“RxJava by Example”一文，我们从中得知了Observable将例外与数据事件等同对待。我们可通过如下的方式通过连接例外事件而模拟错误：</p> <pre> <code class="language-java">@Test public void testFailure() { // given: TestSubscriber<String> subscriber = new TestSubscriber<>(); Exception exception = new RuntimeException("boom!"); Observable<String> observable = Observable .from(WORDS) .zipWith(Observable.range(1, Integer.MAX_VALUE), (string, index) -> String.format("%2d. %s", index, string)) .concatWith(Observable.error(exception)); // when: observable.subscribe(subscriber); // then: subscriber.assertError(exception); subscriber.assertNotCompleted(); }</code></pre> <p>在我们所给出的有限用例中，所有的机制运行良好。但是实际的产品代码可能会完全不同于例子。因此在下文中，我们将考虑一些更加复杂的产品实例。</p> <h2><strong>定制调度器（Scheduler）</strong></h2> <p>在产品代码中，很多用例中的Observable都是在特定的线程上执行，这种线程在响应式编程环境中被称为“调度器（Scheduler）”。很多Observable操作将可选的调度器参数作为附加参数使用。RxJava定义了一系列任何时候都可用的命名调度器，包括IO调度器（io)、计算调度器（computation，为共享线程）和新线程调度器（newThread）。开发人员也可去实现个人定制的调度器。让我们通过指定计算调度器来修改Observable的代码吧。</p> <pre> <code class="language-java">@Test public void testUsingComputationScheduler() { // given: TestSubscriber<String> subscriber = new TestSubscriber<>(); Observable<String> observable = Observable .from(WORDS) .zipWith(Observable.range(1, Integer.MAX_VALUE), (string, index) -> String.format("%2d. %s", index, string)); // when: observable .subscribeOn(Schedulers.computation()) .subscribe(subscriber); // then: subscriber.assertCompleted(); subscriber.assertNoErrors(); assertThat(subscriber.getOnNextEvents(), hasItem(" 4. fox")); }</code></pre> <p>当运行时就会立刻发现该代码是存在问题的。Subscriber在测试线程上执行其断言，但是Observable在后台线程（计算线程）上生成值。这意味着执行Subscriber断言可能先于Observable生成所有相关事件，因而导致测试的失败。</p> <p>为使测试顺利执行，有如下的一些策略可选：</p> <ul> <li> <p>将Observable转化为阻塞式的。</p> </li> <li> <p>强制测试等待，直至给定的条件被满足。</p> </li> <li> <p>将计算调度器转换为即刻（Schedulers.immediate()）调度器。</p> </li> </ul> <p>我们将对每个策略做展开介绍，但将从“将Observable转化为阻塞式”开始，因为实现该策略所需做的技术工作最少，这些工作与所使用的调度器无关。我们假设数据在后台线程中生成，这将导致Subscriber从同一后台线程得到通知。</p> <p>我们要做的是强制生成所有的事件，并在下一个声明被执行前就在测试中完成Observable。这是通过在Observable自身上调用toBlocking()方法实现的。</p> <pre> <code class="language-java">@Test public void testUsingBlockingCall() { // given: Observable<String> observable = Observable.from(WORDS) .zipWith(Observable.range(1, Integer.MAX_VALUE), (string, index) -> String.format("%2d. %s", index, string)); // when: Iterable<String> results = observable .subscribeOn(Schedulers.computation()) .toBlocking() .toIterable(); // then: assertThat(results, notNullValue()); assertThat(results, iterableWithSize(9)); assertThat(results, hasItem(" 4. fox")); }</code></pre> <p>该方法虽然适用于我们所给出的简单代码，但可能并不适用于实际的产品代码。如果生产者生成所有的数据需要很长的时间，那将会产生什么后果？这将使测试变得非常慢，并增加了编译时间，还可能会有其它的性能问题。这里我推荐一个便利的程序库，就是 Awaitility 。简单地说，Awaitility是一个以精确、简单易读的方式对异步系统相关期望进行表述的DSL。在项目中可以用Maven添加Awaitility的依赖关系。</p> <pre> <code class="language-java"><dependency> <groupId>org.awaitility</groupId> <artifactId>awaitility</artifactId> <version>2.0.0</version> <scope>test</scope> </dependency></code></pre> <p>或是使用Gradle：</p> <pre> <code class="language-java">testCompile 'org.awaitility:awaitility:2.0.0'</code></pre> <p>Awaitility DSL的接入点是org.awaitility.Awaitility.await()方法（参见下面例子中的第13和14行代码）。可以使用Awaitility定义使测试继续所必须达成的条件，也可在条件中加入超时或其它的时序约束，例如最小、最大或持续范围。对于上面的例子，下面的代码给出了如何在结果中使用Awaitility：</p> <pre> <code class="language-java">@Test public void testUsingComputationScheduler() { // given: TestSubscriber<String> subscriber = new TestSubscriber<>(); Observable<String> observable = Observable.from(WORDS) .zipWith(Observable.range(1, Integer.MAX_VALUE), (string, index) -> String.format("%2d. %s", index, string)); // when: observable.subscribeOn(Schedulers.computation()) .subscribe(subscriber); await().timeout(2, SECONDS) .until(subscriber::getValueCount, equalTo(9)); // then: subscriber.assertCompleted(); subscriber.assertNoErrors(); assertThat(subscriber.getOnNextEvents(), hasItem(" 4. fox")); }</code></pre> <p>此版本测试并未以任何方式改变Observable的本质，这使得你做测试时不必对产品代码做任何改动。该版本测试使用最多2秒的等待时间通过检查Subscriber状态使Observable执行其作业。如果一切进行顺利，在2秒内就可将Subscriber的状态释放给所有的9个事件。</p> <p>Awaitility具有和Hamcrest的匹配符、Java 8的lambda表达式和方法引用等的良好协作，从而给出精确的和可读的测试条件。Awaitility还提供了预制扩展，用于那些被广泛使用的JVM语言，其中包括Groovy和Scala。</p> <p>我们要给出最后一个策略中使用了RxJava的扩展机制，该扩展是以RxJava API的组成部分发布的。RxJava中定义了一系列的扩展点，允许对几乎任何默认的RxJava行为进行微调。这种扩展机制使我们可以针对特定的RxJava特性提供修改过的值。利用该机制，在无需关心生成代码中所指定的调度器的情况下，我们可在测试中注入选定的调度器。这正是我们所寻找的方法，该方法被封装在RxJavaHooks类中。假设产品代码依赖于计算调度器，我们将覆盖它的默认值，返回一个调度器，它作为被调用的代码使事件处理发生，这是即刻调度器（Schedulers.immediate()）。下面给出测试的代码：</p> <pre> <code class="language-java">@Test public void testUsingRxJavaHooksWithImmediateScheduler() { // given: RxJavaHooks.setOnComputationScheduler(scheduler -> Schedulers.immediate()); TestSubscriber<String> subscriber = new TestSubscriber<>(); Observable<String> observable = Observable.from(WORDS) .zipWith(Observable.range(1, Integer.MAX_VALUE), (string, index) -> String.format("%2d. %s", index, string)); try { // when: observable.subscribeOn(Schedulers.computation()) .subscribe(subscriber); // then: subscriber.assertCompleted(); subscriber.assertNoErrors(); subscriber.assertValueCount(9); assertThat(subscriber.getOnNextEvents(), hasItem(" 4. fox")); } finally { RxJavaHooks.reset(); } }</code></pre> <p>在测试中，产品代码察觉不到计算调度器是即刻的。请注意钩子函数必须被重置，否则即刻调度器的设置可能会发生泄漏，导致在各处的测试被破坏。使用try/finall代码块会在一定程度上模糊了测试的目的，但是幸运的是我们可以使用JUnit规则重构该行为，使测试更加精炼，结果更可读。下面给出使用上述规则的一种可能的实现代码：</p> <pre> <code class="language-java">public class ImmediateSchedulersRule implements TestRule { @Override public Statement apply(final Statement base, Description description) { return new Statement() { @Override public void evaluate() throws Throwable { RxJavaHooks .setOnIOScheduler(scheduler -> Schedulers.immediate()); RxJavaHooks .setOnComputationScheduler(scheduler -> Schedulers.immediate()); RxJavaHooks .setOnNewThreadScheduler(scheduler -> Schedulers.immediate()); try { base.evaluate(); } finally { RxJavaHooks.reset(); } } }; } }</code></pre> <p>此外，我们还对另外两个调度器的生成方法做了重写。该规则对此后其它的测试目标更为通用。在新的测试用例类中，该规则的使用方法很直接，只需简单地定义一个域，并将其中新类型标注为@Rule即可。示例代码如下：</p> <pre> <code class="language-java">@Rule public final ImmediateSchedulersRule schedulers = new ImmediateSchedulersRule(); @Test public void testUsingImmediateSchedulersRule() { // given: TestSubscriber<String> subscriber = new TestSubscriber<>(); Observable<String> observable = Observable.from(WORDS) .zipWith(Observable.range(1, Integer.MAX_VALUE), (string, index) -> String.format("%2d. %s", index, string)); // when: observable.subscribeOn(Schedulers.computation()) .subscribe(subscriber); // then: subscriber.assertNoErrors(); subscriber.assertCompleted(); subscriber.assertValueCount(9); assertThat(subscriber.getOnNextEvents(), hasItem(" 4. fox")); }</code></pre> <p>最终我们可得到与前面测试一样的行为，却没有像前面测试那样的杂乱。下面用一些篇幅来回顾一下我们目前已经做到的事情：</p> <ul> <li>Subscribers将在同一线程中处理数据，只要没有使用特定的调度器。这意味着在Subscriber向Observable做订阅后，我们就可在该Subscriber上做断言。</li> <li>TestSubscriber可累计事件，并给出自身状态的追加断言。</li> <li>任何Observable都可转换为阻塞式的，这使得无论Observable使用何种调度器，我们都可以同步等待事件的生成。</li> <li>RxJava提供了扩展机制，允许开发人员重写其默认方法，并以适当的方式注入到产品代码中。</li> <li>并发代码可使用Awaitility DSL测试。</li> </ul> <p>上述的每个技术都作用于不同的场景中，但是所有技术都是通过“共同的线程”（译者注：作者在原文中指出common thread是作为双关语使用的，其另一个意思是“类似的思路”）相关联：在对Subscriber状态做断言之前，测试代码需等待Observable完成。考虑到Observable的行为会生成数据，是否有方法对该行为进行检查呢？换句话说，是否可以用编程的方式做Observable的现场调试？我们将在后文中给出这样的技术。</p> <h2><strong>操控时间</strong></h2> <p>到目前为止我们已用黑箱方式测试了Observable和Subscription。下面我们将考虑另外一种操控时间的技术，该技术使我们可以在Observable依然处于活动状态时，打开引擎盖去查看Subscriber状态。换句话说，我们将使用采用了RxJava的TestScheduler类白箱测试技术，这可以说是RxJava再一次来救场。这种特定的调度器可精确地设定时间的内部使用方式，例如可将时间提前半秒，或是使时间跳跃5秒。我们将首先给出这种新调度器实例的创建方法，然后再讨论代码的测试。</p> <pre> <code class="language-java">@Test public void testUsingTestScheduler() { // given: TestScheduler scheduler = new TestScheduler(); TestSubscriber<String> subscriber = new TestSubscriber<>(); Observable<Long> tick = Observable.interval(1, SECONDS, scheduler); Observable<String> observable = Observable.from(WORDS) .zipWith(tick, (string, index) -> String.format("%2d. %s", index, string)); observable.subscribeOn(scheduler) .subscribe(subscriber); // expect: subscriber.assertNoValues(); subscriber.assertNotCompleted(); // when: scheduler.advanceTimeBy(1, SECONDS); // then: subscriber.assertNoErrors(); subscriber.assertValueCount(1); subscriber.assertValues(" 0. the"); // when: scheduler.advanceTimeTo(9, SECONDS); subscriber.assertCompleted(); subscriber.assertNoErrors(); subscriber.assertValueCount(9); }</code></pre> <p>该“产品”代码有了略微的改变，这是由于我们使用了绑定到调度器时隙（interval()）的方法生成计数（第6行），而非生成一个计数的范围。但这样做具有一个副作用，就是计数是从零开始生成的，而非从1开始。一旦配置了Observable和测试调度器，我们立刻做出这样的断言，即假定Subscriber不具有值（第15行）且没有被完成或生成任何的错误（第16行）。这是一个完整性测试，因为此时调度器并没有被移动，因而没有任何值被Observable产生或是被Subscriber接收到。</p> <p>下面将时间向前调1整秒（第19行），该操作将会导致Observable生成第一个值，这正是随后的断言集所要检查的（第22到24行）。</p> <p>下面将时间从当前时间调到9秒。需要注意的是，这意味着将时间准确地调整为调度器启动后的第9秒（并非是向前调1秒后再向前调9秒，即调度器检查启动后的第10秒）。换句话说，advanceTimeBy()方法将调度器的时间调整为相对于当前位置的时间，而advanceTimeTo()以绝对的方式调整时间。此后我们做出下一轮的断言（第28到20行），用于确保所有的数据由Observable生成且被Subscriber消费。另一件需要说明的事情就是使用TestScheduler时，真实的时间是立刻发生调整的，这着意味着测试并不用实际等待9秒才去完成。</p> <p>正如你所看到的，该调度器的使用是非常便利的，仅需将该调度器提供给正在测试的Observable即可。但是对使用了指定类型调度器的Observable，该调度器并不能很好地适用。但是稍等一下，之前我们看到的是如何使用RxJavaHooks切换一个不影响生产代码的调度器，而这一次是提供一个代替即刻调度器的TestScheduler（第13到15行）。我们甚至可以apply定制JUnit规则同样的技术，使之前的代码可以用更重用的方式予以重写。首先该新规则为：</p> <pre> <code class="language-java">public class TestSchedulerRule implements TestRule { private final TestScheduler testScheduler = new TestScheduler(); public TestScheduler getTestScheduler() { return testScheduler; } @Override public Statement apply(final Statement base, Description description) { return new Statement() { @Override public void evaluate() throws Throwable { RxJavaHooks.setOnIOScheduler(scheduler -> testScheduler); RxJavaHooks.setOnComputationScheduler(scheduler -> testScheduler); RxJavaHooks.setOnNewThreadScheduler(scheduler -> testScheduler); try { base.evaluate(); } finally { RxJavaHooks.reset(); } } }; } }</code></pre> <p>紧接着是实际的测试代码（在一个新的测试用例类中），去使用我们的测试规则：</p> <pre> <code class="language-java">@Rule public final TestSchedulerRule testSchedulerRule = new TestSchedulerRule(); @Test public void testUsingTestSchedulersRule() { // given: TestSubscriber<String> subscriber = new TestSubscriber<>(); Observable<String> observable = Observable.from(WORDS) .zipWith(Observable.interval(1, SECONDS), (string, index) -> String.format("%2d. %s", index, string)); observable.subscribeOn(Schedulers.computation()) .subscribe(subscriber); // expect subscriber.assertNoValues(); subscriber.assertNotCompleted(); // when: testSchedulerRule.getTestScheduler().advanceTimeBy(1, SECONDS); // then: subscriber.assertNoErrors(); subscriber.assertValueCount(1); subscriber.assertValues(" 0. the"); // when: testSchedulerRule.getTestScheduler().advanceTimeTo(9, SECONDS); subscriber.assertCompleted(); subscriber.assertNoErrors(); subscriber.assertValueCount(9); }</code></pre> <p>这样你就成功地实现了它。使用经由RxJavaHooks注入TestScheduler的方法，可在无需更改原始Observable组合的情况下编写测试代码，此外它给出了一种在observable自身执行期间改变时间、并在特定点上做断言的方法。在本文中给出的所有这些技术，应该足够你选择用来测试RxJava的代码了。</p> <h2><strong>未来</strong></h2> <p>RxJava是最先为Java提供响应式编程能力的程序库之一。为了使RxJava API更好地符合 Reactive Streams 规范，即将推出的2.0版将会是重新设计的。Reactive Streams规范以Java和JavaScript运行时为目标，提供了使用非阻塞背压机制（back pressure）的异步流处理标准。这意味着下一版的RxJava中将会出现一些API改进。</p> <p>对于测试而言，这些核心类型（Observable、Maybe和Single）现在都给出了便利易用的test()方法，实现现场创建TestSubscriber实例。也可在TestSubscriber上链接方法调用，对这类用法也有一些新的断言方法。</p> <p> </p> <p> </p> <p>来自：http://www.infoq.com/cn/articles/Testing-RxJava</p> <p> </p>