KotlinのAPI通信でタイムアウト・リトライ設定を行う方法をやさしく解説！初心者向けネットワーク入門

先生と生徒の会話形式で理解しよう

生徒

「アプリでインターネットを使うときに、通信が遅くて固まっちゃうことがあるんですけど、どうにかできないんですか？」

先生

「とても大事なところに気づきましたね。KotlinでAPI通信をする場合、タイムアウトやリトライの設定を行うことで、そういった問題を防ぐことができますよ。」

生徒

「タイムアウトとリトライって何ですか？初心者でもわかるように教えてください！」

先生

「もちろんです。実際の使い方と一緒に、基礎からしっかり説明していきましょう！」

1. タイムアウトとリトライって何？

タイムアウトとは、ネットワーク通信で返事が返ってこないときに「もう待つのをやめる時間」のことです。例えば、自動販売機にお金を入れてもジュースが出てこなければ、しばらくして諦めますよね？それと同じです。

リトライは、「通信が失敗したから、もう一度試してみよう」という再試行の仕組みです。機械が自動で「もう一回！」ってやってくれます。

この2つを組み合わせることで、通信のトラブルが起きたときでも、アプリが賢く対応できるようになります。

2. Kotlinで使うライブラリ「OkHttp」

KotlinでAPI通信を行うときによく使われるのが、OkHttp（オーケー・エイチ・ティー・ティー・ピー）というライブラリです。これを使えば、タイムアウトやリトライの設定も簡単にできます。

まずはbuild.gradleファイルに以下の依存関係を追加して、OkHttpを使えるようにします。


dependencies {
    implementation("com.squareup.okhttp3:okhttp:4.12.0")
}

3. タイムアウトを設定する方法

タイムアウトには次の3種類があります。

接続タイムアウト：サーバーに接続するまでの待ち時間
読み取りタイムアウト：サーバーからの返事を待つ時間
書き込みタイムアウト：データを送るときの制限時間

以下は、各タイムアウトを10秒に設定した例です。


val client = OkHttpClient.Builder()
    .connectTimeout(10, TimeUnit.SECONDS)
    .readTimeout(10, TimeUnit.SECONDS)
    .writeTimeout(10, TimeUnit.SECONDS)
    .build()

この設定により、通信が10秒以内に終わらなければ、自動的に中断されます。

Kotlinを基礎からしっかり学びたい人や、 Java経験を活かしてモダンな言語にステップアップしたい人には、定番の入門書がこちらです。

基礎からわかるKotlinをAmazonで見る

※ Amazon広告リンク

4. リトライを設定する方法

OkHttpでは、retryOnConnectionFailure(true)を使うと、接続に失敗したときに自動で再試行してくれます。


val client = OkHttpClient.Builder()
    .retryOnConnectionFailure(true)
    .build()

ただし、何回リトライするかを細かく設定したい場合や、サーバー側のエラーに対応したい場合は、カスタムインターセプターを作る必要があります。

5. カスタムでリトライ回数を制御する

下のコードでは、最大3回までリトライするように設定した例を紹介します。


class RetryInterceptor(private val maxRetry: Int) : Interceptor {
    override fun intercept(chain: Interceptor.Chain): Response {
        var request = chain.request()
        var response: Response
        var tryCount = 0
        while (true) {
            try {
                response = chain.proceed(request)
                if (response.isSuccessful) return response
            } catch (e: IOException) {
                if (tryCount >= maxRetry) throw e
            }
            tryCount++
        }
    }
}

val client = OkHttpClient.Builder()
    .addInterceptor(RetryInterceptor(3))
    .build()

このようにすることで、「失敗したら最大3回まで自動で再試行する」仕組みを作れます。

6. 実際にAPIリクエストを送ってみよう

最後に、タイムアウトとリトライを設定したOkHttpClientで、実際にAPIリクエストを送る方法を紹介します。


val request = Request.Builder()
    .url("https://api.example.com/data")
    .build()

val response = client.newCall(request).execute()
if (response.isSuccessful) {
    println(response.body?.string())
} else {
    println("通信に失敗しました。")
}

このコードを実行すると、インターネットに接続してデータを取得し、うまくいけば中身を表示してくれます。