Java中CompletableFuture异步方法JUnit测试Jacoco覆盖缺失问题

我实现了一个sendMessageAsync方法，逻辑是通过CompletableFuture调用ServiceA的publish接口，并用whenCompleteAsync处理异步回调：当ServiceA调用异常时，会降级调用ServiceB的sendMessage方法。

但在JUnit测试中，我模拟了ServiceA调用失败的CompletableFuture，执行测试后Jacoco代码覆盖工具没有统计到m_serviceBClient.sendMessage(request.getMessage())这一行的覆盖。我推测是因为回调逻辑执行时，JUnit测试已经结束，导致Jacoco无法检测到该语句的执行。

whenCompleteAsync默认使用ForkJoinPool的线程执行回调逻辑，而JUnit测试主线程会在测试方法执行完毕后直接结束，不会等待异步线程中的回调代码执行完成。Jacoco基于类加载插桩、运行时收集执行数据，主线程结束后JVM可能直接退出，异步线程的执行数据没来得及被收集，所以这行代码的覆盖没被统计到。

下面是几种可行的解决方式：

• 手动等待异步任务完成
  在测试方法末尾，通过CompletableFuture的join()或get()方法阻塞主线程，等待所有异步逻辑执行完毕：

  // 假设sendMessageAsync返回CompletableFuture<Void>
  CompletableFuture<Void> future = sendMessageAsync(request);
  future.join(); // 等待异步回调执行完成
  

  若使用get()，需要处理InterruptedException和ExecutionException异常。

• 自定义Executor控制线程
  在whenCompleteAsync中指定测试代码可控的线程池，测试结束前手动关闭线程池并等待任务执行完毕：

  // 测试类中定义专属线程池
  private ExecutorService testExecutor = Executors.newSingleThreadExecutor();
  
  // 业务方法传入自定义Executor
  public CompletableFuture<Void> sendMessageAsync(Request request) {
      return serviceA.publish(request)
          .whenCompleteAsync((result, throwable) -> {
              if (throwable != null) {
                  m_serviceBClient.sendMessage(request.getMessage());
              }
          }, testExecutor);
  }
  
  // 测试后清理线程池
  @After
  public void tearDown() {
      testExecutor.shutdown();
      try {
          // 设置超时时间，避免无限阻塞
          testExecutor.awaitTermination(5, TimeUnit.SECONDS);
      } catch (InterruptedException e) {
          Thread.currentThread().interrupt();
      }
  }
  

• 用CountDownLatch同步线程
  在测试中设置CountDownLatch，回调逻辑执行完成后调用countDown()，主线程等待latch归零：

  @Test
  public void testSendMessageAsyncFallback() {
      CountDownLatch latch = new CountDownLatch(1);
      // 模拟ServiceA调用失败
      when(serviceA.publish(any(Request.class)))
          .thenReturn(CompletableFuture.failedFuture(new RuntimeException("ServiceA failed")));
  
      sendMessageAsync(new Request("test"))
          .whenComplete((result, throwable) -> latch.countDown());
  
      try {
          latch.await(5, TimeUnit.SECONDS);
      } catch (InterruptedException e) {
          Thread.currentThread().interrupt();
      }
  
      // 同时可以验证ServiceB的方法是否被调用
      verify(m_serviceBClient).sendMessage("test");
  }
  

• 所有方案的核心都是让JUnit主线程等待异步回调逻辑执行完毕，确保Jacoco能收集到这部分代码的执行数据。
• 必须设置合理的超时时间，避免测试因异步任务异常而无限期阻塞。

内容的提问来源于stack exchange，提问作者alchems