如何测试OKHTTP 3异步GET请求？解决测试提前结束问题

碰到异步请求的测试问题太常见了——因为请求在后台线程跑，测试主线程根本不等回调执行完就结束了，自然拿不到想要的结果。我给你两种实用的解决思路，一步步来：

一、用CountDownLatch同步测试线程与回调线程 #

CountDownLatch就像一个“门闩”，能让测试线程暂停执行，等回调逻辑跑完再继续。不过首先得稍微重构下被测方法，让它更易测试：

1. 重构被测方法（让HttpHandler可注入） #

原来的方法里直接new了HttpHandler，测试时没法替换，建议重载一个带参数的版本，既不影响原有业务逻辑，又方便测试：

// 保留原有方法，不改动业务逻辑
protected void methodUnderTest() {
    methodUnderTest(new HttpHandler() {
        @Override
        public void onSuccess(int result) {
            // 原有的业务处理逻辑
        }
        @Override
        public void onError(IOException e) {
        }
    });
}

// 新增重载方法，供测试传入自定义Handler
protected void methodUnderTest(HttpHandler handler) {
    client.get(url, handler);
}

2. 编写测试用例 #

用CountDownLatch等待回调完成，同时用AtomicInteger保存回调里的结果（匿名内部类只能访问final变量，AtomicInteger是个合适的容器）：

@Test
public void testMethodUnderTest_SuccessCase() throws InterruptedException {
    // 初始化门闩，计数1——回调执行完就“解锁”
    CountDownLatch latch = new CountDownLatch(1);
    AtomicInteger capturedResult = new AtomicInteger(-1);

    // 创建被测类实例
    YourClass testedInstance = new YourClass();

    // 传入自定义HttpHandler，捕获结果并触发门闩
    testedInstance.methodUnderTest(new HttpHandler() {
        @Override
        public void onSuccess(int result) {
            capturedResult.set(result);
            latch.countDown(); // 通知测试线程：回调执行完毕
        }

        @Override
        public void onError(IOException e) {
            latch.countDown(); // 出错也要解锁，避免测试无限挂起
            fail("Unexpected error: " + e.getMessage());
        }
    });

    // 最多等待5秒，超时则判定测试失败
    boolean isCallbackCompleted = latch.await(5, TimeUnit.SECONDS);
    assertTrue("Callback didn't finish within timeout", isCallbackCompleted);
    assertEquals(200, capturedResult.get()); // 替换成你期望的result值
}

二、用MockWebServer模拟服务器（更可控的测试） #

如果不想依赖真实服务器，用Square官方的MockWebServer可以完全模拟请求响应，既能控制返回的状态码、内容，还能验证请求是否符合预期。

1. 添加依赖（以Gradle为例） #

确保版本和你的OKHTTP版本对应：

testImplementation 'com.squareup.okhttp3:mockwebserver:4.11.0'

2. 编写测试用例 #

@Test
public void testMethodUnderTest_WithMockServer() throws InterruptedException, IOException {
    // 启动Mock服务器
    MockWebServer mockServer = new MockWebServer();
    mockServer.start();

    // 将被测类的请求URL替换为Mock服务器地址
    YourClass testedInstance = new YourClass();
    testedInstance.setUrl(mockServer.url("/api/test").toString()); // 假设你有设置URL的方法

    // 准备门闩和结果容器
    CountDownLatch latch = new CountDownLatch(1);
    AtomicInteger capturedResult = new AtomicInteger(-1);

    // 模拟服务器返回成功响应
    mockServer.enqueue(new MockResponse()
            .setResponseCode(200)
            .setBody("Mock success response"));

    // 执行被测方法
    testedInstance.methodUnderTest(new HttpHandler() {
        @Override
        public void onSuccess(int result) {
            capturedResult.set(result);
            latch.countDown();
        }

        @Override
        public void onError(IOException e) {
            latch.countDown();
            fail("Request failed: " + e.getMessage());
        }
    });

    // 等待回调完成并验证结果
    assertTrue(latch.await(5, TimeUnit.SECONDS));
    assertEquals(200, capturedResult.get());

    // 额外验证请求的方法、路径是否符合预期
    RecordedRequest request = mockServer.takeRequest();
    assertEquals("GET", request.getMethod());
    assertEquals("/api/test", request.getPath());

    // 关闭Mock服务器
    mockServer.shutdown();
}

小提示 #

如果实在没法重构被测方法（比如是遗留代码），可以考虑用PowerMock替换内部的HttpHandler，但这种方式侵入性强，还是优先推荐重构让代码可测试——毕竟可测试的代码才是更健壮的代码。

内容的提问来源于stack exchange，提问作者Jaime Alcántara Arnela