[Retrofit2] Retrofit2에서 타임아웃 및 리트라이 설정

출처

ChatGPT

---

Retrofit2에서 타임아웃 및 리트라이 설정

1. OkHttpClient로 타임아웃 설정하기

OkHttpClient는 세 가지 종류의 타임아웃을 설정할 수 있다.

 

• 연결 타임아웃(connect timeout): 서버에 연결하는 데 걸리는 최대 시간.
• 읽기 타임아웃(read timeout): 서버에서 응답 데이터를 읽는 데 걸리는 최대 시간.
• 쓰기 타임아웃(write timeout): 서버에 요청 데이터를 쓰는 데 걸리는 최대 시간.

각각의 타임아웃은 특정 요구 사항에 따라 개별적으로 설정할 수 있다.

import okhttp3.OkHttpClient;
import retrofit2.Retrofit;
import retrofit2.converter.gson.GsonConverterFactory;

import java.util.concurrent.TimeUnit;

public class ApiClient {

    private static final String BASE_URL = "https://api.example.com/";
    private static Retrofit retrofit = null;

    public static Retrofit getClient() {
        if (retrofit == null) {
            // OkHttpClient 설정
            OkHttpClient client = new OkHttpClient.Builder()
                    .connectTimeout(30, TimeUnit.SECONDS) // 연결 타임아웃: 30초
                    .readTimeout(30, TimeUnit.SECONDS)    // 읽기 타임아웃: 30초
                    .writeTimeout(30, TimeUnit.SECONDS)   // 쓰기 타임아웃: 30초
                    .build();

            // Retrofit 설정
            retrofit = new Retrofit.Builder()
                    .baseUrl(BASE_URL)
                    .client(client)
                    .addConverterFactory(GsonConverterFactory.create())
                    .build();
        }
        return retrofit;
    }
}

 

 

설명

 

• connectTimeout: 서버에 연결할 때의 타임아웃을 설정한다.
• readTimeout: 서버로부터 데이터를 읽을 때의 타임아웃을 설정한다.
• writeTimeout: 서버로 데이터를 보낼 때의 타임아웃을 설정한다.
• TimeUnit.SECONDS: 타임아웃 시간의 단위를 설정한다. (TimeUnit.MILLISECONDS 등 다른 단위도 사용 가능)

코틀린 예제

import okhttp3.OkHttpClient
import retrofit2.Retrofit
import retrofit2.converter.gson.GsonConverterFactory
import java.util.concurrent.TimeUnit

object ApiClient {

    private const val BASE_URL = "https://api.example.com/"
    private var retrofit: Retrofit? = null

    fun getClient(): Retrofit {
        if (retrofit == null) {
            // OkHttpClient 설정
            val client = OkHttpClient.Builder()
                .connectTimeout(30, TimeUnit.SECONDS)  // 연결 타임아웃: 30초
                .readTimeout(30, TimeUnit.SECONDS)     // 읽기 타임아웃: 30초
                .writeTimeout(30, TimeUnit.SECONDS)    // 쓰기 타임아웃: 30초
                .build()

            // Retrofit 설정
            retrofit = Retrofit.Builder()
                .baseUrl(BASE_URL)
                .client(client)
                .addConverterFactory(GsonConverterFactory.create())
                .build()
        }
        return retrofit!!
    }
}

 

2. 리트라이 횟수 설정

OkHttpClient는 기본적으로 자동으로 재시도를 지원하지 않지만, 이를 구현할 수 있다. 리트라이 기능은 Interceptor를 사용해 구현할 수 있다.

 

리트라이 인터셉터 구현

import okhttp3.Interceptor;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import retrofit2.Retrofit;
import retrofit2.converter.gson.GsonConverterFactory;

import java.io.IOException;
import java.util.concurrent.TimeUnit;

public class ApiClient {

    private static final String BASE_URL = "https://api.example.com/";
    private static Retrofit retrofit = null;

    public static Retrofit getClient() {
        if (retrofit == null) {
            // 리트라이 인터셉터 구현
            Interceptor retryInterceptor = new Interceptor() {
                private int maxRetry = 3;  // 최대 리트라이 횟수 설정
                private int retryCount = 0;

                @Override
                public Response intercept(Chain chain) throws IOException {
                    Request request = chain.request();
                    Response response = null;
                    boolean responseOK = false;

                    while (!responseOK && retryCount < maxRetry) {
                        try {
                            response = chain.proceed(request);
                            responseOK = response.isSuccessful();
                        } catch (Exception e) {
                            retryCount++;
                            if (retryCount >= maxRetry) {
                                throw e;  // 최대 리트라이 횟수를 초과하면 예외 발생
                            }
                        }
                    }
                    return response;
                }
            };

            // OkHttpClient 설정
            OkHttpClient client = new OkHttpClient.Builder()
                    .connectTimeout(30, TimeUnit.SECONDS)
                    .readTimeout(30, TimeUnit.SECONDS)
                    .writeTimeout(30, TimeUnit.SECONDS)
                    .addInterceptor(retryInterceptor)  // 리트라이 인터셉터 추가
                    .build();

            // Retrofit 설정
            retrofit = new Retrofit.Builder()
                    .baseUrl(BASE_URL)
                    .client(client)
                    .addConverterFactory(GsonConverterFactory.create())
                    .build();
        }
        return retrofit;
    }
}

 

 

설명

 

• maxRetry: 최대 리트라이 횟수를 설정합니다.
• retryCount: 현재 리트라이 횟수를 추적합니다.
• response.isSuccessful(): 응답이 성공적인지 확인합니다. 성공적이지 않으면 재시도를 계속합니다.
• chain.proceed(request): 요청을 처리합니다. 요청이 실패하면 예외가 발생할 수 있습니다.
• throw e: 최대 리트라이 횟수를 초과하면 예외를 발생시킵니다.

코틀린 예제

import okhttp3.Interceptor
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.Response
import retrofit2.Retrofit
import retrofit2.converter.gson.GsonConverterFactory
import java.io.IOException
import java.util.concurrent.TimeUnit

object ApiClient {

    private const val BASE_URL = "https://api.example.com/"
    private var retrofit: Retrofit? = null

    fun getClient(): Retrofit {
        if (retrofit == null) {
            // 리트라이 인터셉터 구현
            val retryInterceptor = Interceptor { chain ->
                val request = chain.request()
                var response: Response? = null
                var responseOK = false
                var tryCount = 0
                val maxRetry = 3  // 최대 리트라이 횟수 설정

                while (!responseOK && tryCount < maxRetry) {
                    try {
                        response = chain.proceed(request)
                        responseOK = response.isSuccessful
                    } catch (e: IOException) {
                        tryCount++
                        if (tryCount >= maxRetry) {
                            throw e  // 최대 리트라이 횟수를 초과하면 예외 발생
                        }
                    }
                }
                response!!
            }

            // OkHttpClient 설정
            val client = OkHttpClient.Builder()
                .connectTimeout(30, TimeUnit.SECONDS)
                .readTimeout(30, TimeUnit.SECONDS)
                .writeTimeout(30, TimeUnit.SECONDS)
                .addInterceptor(retryInterceptor)  // 리트라이 인터셉터 추가
                .build()

            // Retrofit 설정
            retrofit = Retrofit.Builder()
                .baseUrl(BASE_URL)
                .client(client)
                .addConverterFactory(GsonConverterFactory.create())
                .build()
        }
        return retrofit!!
    }
}

3. 사용자 지정 OKHttpClient 사용하기

Retrofit2를 구성할 때,OkHttpClient를 커스터마이징해 타임아웃과 리트라이 설정을 보다 세부적으로 관리할 수 있다.

import okhttp3.Interceptor;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import retrofit2.Retrofit;
import retrofit2.converter.gson.GsonConverterFactory;

import java.io.IOException;
import java.util.concurrent.TimeUnit;

public class ApiClient {

    private static final String BASE_URL = "https://api.example.com/";
    private static Retrofit retrofit = null;

    public static Retrofit getClient() {
        if (retrofit == null) {
            // 사용자 지정 OkHttpClient
            OkHttpClient client = new OkHttpClient.Builder()
                    .connectTimeout(30, TimeUnit.SECONDS)
                    .readTimeout(30, TimeUnit.SECONDS)
                    .writeTimeout(30, TimeUnit.SECONDS)
                    .retryOnConnectionFailure(true)  // 연결 실패 시 자동 재시도
                    .build();

            retrofit = new Retrofit.Builder()
                    .baseUrl(BASE_URL)
                    .client(client)
                    .addConverterFactory(GsonConverterFactory.create())
                    .build();
        }
        return retrofit;
    }
}

 

 

코틀린 예제

import okhttp3.OkHttpClient
import retrofit2.Retrofit
import retrofit2.converter.gson.GsonConverterFactory
import java.util.concurrent.TimeUnit

object ApiClient {

    private const val BASE_URL = "https://api.example.com/"
    private var retrofit: Retrofit? = null

    fun getClient(): Retrofit {
        if (retrofit == null) {
            // 사용자 지정 OkHttpClient
            val client = OkHttpClient.Builder()
                .connectTimeout(30, TimeUnit.SECONDS)
                .readTimeout(30, TimeUnit.SECONDS)
                .writeTimeout(30, TimeUnit.SECONDS)
                .retryOnConnectionFailure(true)  // 연결 실패 시 자동 재시도
                .build()

            // Retrofit 설정
            retrofit = Retrofit.Builder()
                .baseUrl(BASE_URL)
                .client(client)
                .addConverterFactory(GsonConverterFactory.create())
                .build()
        }
        return retrofit!!
    }
}

 

설명

 

• retryOnConnectionFailure(true): 연결 실패 시 자동으로 재시도를 수행합니다.
• OkHttpClient.Builder(): 사용자 지정 OkHttpClient 빌더를 사용하여 세부 설정을 합니다.

 

결론

 

• 타임아웃 설정: 연결, 읽기, 쓰기 타임아웃을 각각 설정하여 다양한 네트워크 상황에 대처할 수 있다. OkHttpClient를 사용한다.
• 리트라이 설정: Interceptor를 사용하여 자동 리트라이 기능을 구현할 수 있으며, 필요한 경우 사용자 지정 로직을 추가할 수 있다.