Apache HttpClient 单元测试指南：避免模拟 CloseableHttpClient 陷阱

2024-03-06 21:24:40

在 Apache HttpClient 中掌握单元测试的技巧：绕过模拟 CloseableHttpClient 的陷阱

作为一名软件开发人员，单元测试是我们武器库中不可或缺的工具，确保代码的质量和可靠性。特别是使用第三方库时，单元测试变得至关重要。本文将指导你如何在 Apache HttpClient 中正确编写单元测试，并揭示一个常见的错误以及如何避免它。

常见错误：直接模拟 CloseableHttpClient

在对 Apache HttpClient 进行单元测试时，一个常见的错误是直接模拟 CloseableHttpClient 对象。乍一看，这似乎很合理，但实际上会带来不必要的存根错误。这是因为 CustomHttpClientImpl 已经利用 Apache 的 HttpClientBuilder 创建了 CloseableHttpClient 对象。

正确的方法：模拟 HttpPost

要编写正确的单元测试，关键在于模拟 HttpPost 对象，而不是 CloseableHttpClient 对象。这是因为 CustomHttpClientImpl 中的 executePost 方法接收 HttpPost 对象作为参数，然后将其传递给 CloseableHttpClient 执行。因此，通过模拟 HttpPost 对象，我们可以独立于 CloseableHttpClient 测试 CustomHttpClientImpl 的逻辑。

优化后的单元测试示例

// Mockito 扩展用于模拟对象
@ExtendWith(MockitoExtension.class)
public class CustomHttpClientImplTest {
    // 注入要测试的类
    @InjectMocks
    private CustomHttpClientImpl customHttpClient;

    @Test
    public void test() throws Exception {
        // 创建一个模拟的 HttpPost 对象
        HttpPost mockHttpPost = new HttpPost("http://example.com");

        // 创建一个模拟的 CloseableHttpResponse 对象
        CloseableHttpResponse mockResponse = Mockito.mock(CloseableHttpResponse.class);

        // 当调用 customHttpClient.executePost(mockHttpPost) 时，返回 mockResponse
        when(customHttpClient.executePost(mockHttpPost)).thenReturn(mockResponse);

        // 调用 executePost 方法，并断言结果不为 null
        CloseableHttpResponse result = customHttpClient.executePost(mockHttpPost);
        assertNotNull(result);
    }
}