Apache EntityUtils.toString读取HttpResponse时线程无限阻塞问题排查

触发原因 #

从jstack输出可以明确看到，线程阻塞在sun.nio.ch.SocketDispatcher.read0原生读取方法上，本质是读取HTTP响应体时发生了无限阻塞。

你之前在HttpRequest层面配置的超时大概率只覆盖了连接建立、从连接池获取连接的阶段（比如connectTimeout、connectionRequestTimeout），但没有配置socketTimeout。这个socketTimeout才是控制socket通信全周期的超时，包括请求发送后的响应体读取阶段。当服务端因网络异常、进程挂起等原因无法完整返回响应体时，客户端会一直卡在流读取步骤，导致线程无限阻塞。

解决方案 #

1. 全局配置HttpClient的Socket超时 #

在构建HttpClient实例时，通过RequestConfig设置socketTimeout，该配置会作用于所有基于此HttpClient的请求，覆盖响应体读取阶段：

// 构建全局请求配置，设置各阶段超时
RequestConfig globalConfig = RequestConfig.custom()
        .setConnectTimeout(5000)    // 连接建立超时（毫秒）
        .setConnectionRequestTimeout(5000) // 从连接池获取连接的超时（毫秒）
        .setSocketTimeout(10000)    // Socket通信超时，包含响应体读取（毫秒）
        .build();

// 初始化HttpClient时绑定全局配置
CloseableHttpClient httpClient = HttpClients.custom()
        .setDefaultRequestConfig(globalConfig)
        .build();

2. 单个请求单独配置超时 #

如果需要针对特定请求设置不同超时，可以在创建HttpGet/HttpPost时单独配置：

HttpGet httpGet = new HttpGet("http://example.com/api");
RequestConfig requestConfig = RequestConfig.custom()
        .setSocketTimeout(15000) // 给当前请求单独设置读取超时
        .build();
httpGet.setConfig(requestConfig);

3. 手动控制响应体读取（可选） #

EntityUtils.toString是便捷方法，但不支持直接设置超时。如果需要更精细控制，可以手动读取响应体，同时依赖HttpClient的socketTimeout控制超时：

public static String stringFromHttpResponse(HttpResponse response) throws IOException {
    if (isStatusOk(response.getStatusLine().getStatusCode())) {
        HttpEntity entity = response.getEntity();
        if (entity != null) {
            try (InputStream is = entity.getContent();
                 BufferedReader reader = new BufferedReader(new InputStreamReader(is))) {
                StringBuilder sb = new StringBuilder();
                String line;
                while ((line = reader.readLine()) != null) {
                    sb.append(line);
                }
                return sb.toString();
            }
        } else {
            throw new IOException("HttpResponse has a null entity");
        }
    } else {
        String err = String.format("HttpResponse status code is not Ok(code=%s, reason=%s)",
                response.getStatusLine().getStatusCode(), response.getStatusLine().getReasonPhrase());
        throw new IOException(err);
    }
}

关键提醒：必须确保socketTimeout被正确配置，这个参数是防止响应体读取阻塞的核心，它会在socket读取数据时，超过指定时间没有新数据到来就抛出SocketTimeoutException，避免线程无限挂起。

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