Java - HttpClient에 Timeout 적용

By JS | Last updated: November 28, 2021

javatips

HttpClient로 Restful server의 데이터를 가져올 때, 간혹 서버 문제로 응답이 없을 수 있습니다. 처음부터 서버에 문제가 있다면 HttpHostConnectException 등의 예외가 발생하여 예외처리를 할 수 있지만, 연결이 느려지는 등의 문제가 발생할 때 오랜 시간동안 대기하게 됩니다. 기본적으로 Timeout이 적용되어있지 않기 때문에 오랜 시간 기다리게 됩니다.

다음과 같은 코드로 HttpClient에 Timeout을 설정할 수 있습니다. RequestConfig 생성 및 Timeout 시간을 설정하고 setConfig()로 request에 적용합니다. 이 Request를 사용할 때 Timeout이 발생하면 ConnectTimeoutException이 발생하여 예외 처리를 할 수 있습니다.

final String URL = "http://localhost:3000/root";
final HttpGet request = new HttpGet(URL);

// Apply timeout for the request
RequestConfig requestConfig = RequestConfig.custom()
        .setSocketTimeout(1 * 1000)
        .setConnectTimeout(1 * 1000)
        .setConnectionRequestTimeout(1 * 1000)
        .build();

request.setConfig(requestConfig);

1. Example : Timeout이 적용되지 않은 코드

다음은 단순히 Restful server에서 데이터를 가져오는 코드입니다. Timeout이 적용되지 않았기 때문에 서버 연결에 문제가 있을 때 오랜 시간 대기할 수 있습니다.

import org.apache.http.HttpEntity;
import org.apache.http.client.config.RequestConfig;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

import java.io.IOException;

public class RestApiExample {

    public static void main(String[] args) {

        final String URL = "http://localhost:3000/root";
        final HttpGet request = new HttpGet(URL);
        final CloseableHttpClient httpClient = HttpClients.createDefault();

        try (CloseableHttpResponse response = httpClient.execute(request)) {
            HttpEntity entity = response.getEntity();
            String result = EntityUtils.toString(entity);
            System.out.println(result);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

2. Example : Timeout이 적용된 코드

다음은 위의 예제에서 Timeout을 1초로 적용한 코드입니다.

import org.apache.http.HttpEntity;
import org.apache.http.client.config.RequestConfig;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

import java.io.IOException;

public class RestApiExample {

    public static void main(String[] args) {

        final String URL = "http://localhost:3000/root";
        final HttpGet request = new HttpGet(URL);
        final CloseableHttpClient httpClient = HttpClients.createDefault();

        // Apply timeout for the request
        RequestConfig requestConfig = RequestConfig.custom()
                .setSocketTimeout(1 * 1000)
                .setConnectTimeout(1 * 1000)
                .setConnectionRequestTimeout(1 * 1000)
                .build();
        request.setConfig(requestConfig);

        try (CloseableHttpResponse response = httpClient.execute(request)) {
            HttpEntity entity = response.getEntity();
            String result = EntityUtils.toString(entity);
            System.out.println(result);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

Timeout 발생 시, 다음과 같이 ConnectTimeoutException가 발생할 수 있습니다. 이 예외에 대해서 처리해주시면 됩니다.

org.apache.http.conn.ConnectTimeoutException: Connect to localhost:3000 [localhost/127.0.0.1, localhost/0:0:0:0:0:0:0:1] failed: connect timed out
	at org.apache.http.impl.conn.DefaultHttpClientConnectionOperator.connect(DefaultHttpClientConnectionOperator.java:151)
	at org.apache.http.impl.conn.PoolingHttpClientConnectionManager.connect(PoolingHttpClientConnectionManager.java:374)
	at org.apache.http.impl.execchain.MainClientExec.establishRoute(MainClientExec.java:393)
	at org.apache.http.impl.execchain.MainClientExec.execute(MainClientExec.java:236)
	at org.apache.http.impl.execchain.ProtocolExec.execute(ProtocolExec.java:186)
	at org.apache.http.impl.execchain.RetryExec.execute(RetryExec.java:89)
	at org.apache.http.impl.execchain.RedirectExec.execute(RedirectExec.java:110)
	at org.apache.http.impl.client.InternalHttpClient.doExecute(InternalHttpClient.java:185)
	at org.apache.http.impl.client.CloseableHttpClient.execute(CloseableHttpClient.java:83)
	at org.apache.http.impl.client.CloseableHttpClient.execute(CloseableHttpClient.java:108)
	at RestApiExample.main(RestApiExample.java:30)

Restful server에 문제가 있을 때, 아래와 같이 HttpHostConnectException 예외가 발생할 수 있습니다. 이 예외가 발생하는 경우, 대기하지 않아서 다음 작업을 수행할 수 있지만, 이 예외가 발생하지 않으면 계속 대기할 수 있기 때문에 Timeout을 적용하는 것을 고려해볼만 합니다.

org.apache.http.conn.HttpHostConnectException: Connect to localhost:3000 [localhost/127.0.0.1, localhost/0:0:0:0:0:0:0:1] failed: Connection refused: connect
	at org.apache.http.impl.conn.DefaultHttpClientConnectionOperator.connect(DefaultHttpClientConnectionOperator.java:156)
	at org.apache.http.impl.conn.PoolingHttpClientConnectionManager.connect(PoolingHttpClientConnectionManager.java:374)
	at org.apache.http.impl.execchain.MainClientExec.establishRoute(MainClientExec.java:393)
	at org.apache.http.impl.execchain.MainClientExec.execute(MainClientExec.java:236)
	at org.apache.http.impl.execchain.ProtocolExec.execute(ProtocolExec.java:186)
javajava-example
Loading script...
codechachaCopyright ©2019 codechacha