Go の Heimdall について学習します。

Heimdall - Golang learning step 8-1

<a href="https://roadmap.sh/" rel="noopener noreferrer" target="_blank">roadmap.sh</a> > <a href="https://roadmap.sh/golang" rel="noopener noreferrer" target="_blank">Go</a> > API Clients > REST > Heimdall の学習を進めていきます。
<div class="img_wrap"><amp-img layout="responsive" src="/images/posts/307/01.png" width="1576" height="1146" alt="学習箇所"></div>
※ 学習メモとしての記録ですが、後にこのセクションを学ぶ道しるべとなるよう、ですます調で記載しています。
<h2 id="contents">contents</h2>
<ol>
<li><a href="#%E9%96%8B%E7%99%BA%E7%92%B0%E5%A2%83">開発環境</a></li>
<li><a href="#%E5%8F%82%E8%80%83-url">参考 URL</a></li>
<li><a href="#heimdall">Heimdall</a>
<ol>
<li><a href="#heimdall-%E3%81%AE%E7%89%B9%E5%BE%B4">Heimdall の特徴</a></li>
</ol>
</li>
<li><a href="#heimdall-%E3%81%AE%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB">Heimdall のインストール</a></li>
<li><a href="#%E5%9F%BA%E6%9C%AC%E7%9A%84%E3%81%AA%E4%BD%BF%E3%81%84%E6%96%B9">基本的な使い方</a>
<ol>
<li><a href="#1-get-%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E3%81%AE%E9%80%81%E4%BF%A1%E4%BE%8B">1. GET リクエストの送信例</a></li>
<li><a href="#post-%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E3%81%AE%E9%80%81%E4%BF%A1%E4%BE%8B">POST リクエストの送信例</a></li>
</ol>
</li>
<li><a href="#%E3%83%90%E3%83%83%E3%82%AF%E3%82%AA%E3%83%95%E3%82%92%E4%BD%BF%E3%81%A3%E3%81%9F%E3%83%AA%E3%83%88%E3%83%A9%E3%82%A4">バックオフを使ったリトライ</a>
<ol>
<li><a href="#%E5%9B%BA%E5%AE%9A%E3%83%90%E3%83%83%E3%82%AF%E3%82%AA%E3%83%95%E3%82%92%E4%BD%BF%E3%81%A3%E3%81%9F%E3%83%AA%E3%83%88%E3%83%A9%E3%82%A4">固定バックオフを使ったリトライ</a></li>
<li><a href="#%E6%8C%87%E6%95%B0%E3%83%90%E3%83%83%E3%82%AF%E3%82%AA%E3%83%95%E3%82%92%E4%BD%BF%E3%81%A3%E3%81%9F%E3%83%AA%E3%83%88%E3%83%A9%E3%82%A4">指数バックオフを使ったリトライ</a></li>
</ol>
</li>
</ol>
<h2 id="開発環境">開発環境</h2>
<ul>
<li>チップ: Apple M2 Pro</li>
<li>OS: macOS Sonoma</li>
<li>go version: go1.23.2 darwin/arm64</li>
</ul>
<h2 id="参考-url">参考 URL</h2>
<ul>
<li><a href="https://github.com/gojek/heimdall" rel="noopener noreferrer" target="_blank">[OpenSource] Heimdall</a></li>
</ul>
<h2 id="heimdall">Heimdall</h2>
Heimdall は、Go で堅牢な HTTP クライアントを構築するためのライブラリです。リトライ機能やカスタムバックオフ戦略などをサポートしており、信頼性の高い API 呼び出しを簡単に実現できます。ここでは Heimdall の基本的な使い方を解説します。
<h3 id="heimdall-の特徴">Heimdall の特徴</h3>
Heimdall は以下のような機能を提供します。
<ol>
<li>リトライ機能：失敗した HTTP リクエストを指定回数再試行します。</li>
<li>バックオフ戦略：リトライ時の待機時間を制御できます（例: 固定、指数、Jitter）。</li>
<li>タイムアウトの設定：HTTP リクエストにタイムアウトを設定できます。</li>
<li>カスタマイズ可能：独自のバックオフ戦略や HTTP クライアントを実装可能です。</li>
</ol>
<h2 id="heimdall-のインストール">Heimdall のインストール</h2>
Heimdall をプロジェクトに追加するには、以下のコマンドを実行します：
<pre><code class="hljs language-console">go get -u github.com/gojek/heimdall/v7
</code></pre>
<h2 id="基本的な使い方">基本的な使い方</h2>
以下に Heimdall を使ったシンプルな例を示します。
<h3 id="1-get-リクエストの送信例">1. GET リクエストの送信例</h3>
GET リクエストは最も基本的な HTTP リクエストで、サーバーからデータを取得するために使用されます。Heimdall を使用すると、リトライやタイムアウトを簡単に設定できます。
<pre><code class="hljs language-go">package main

import (
 "fmt"
 "io"
 "log"
 "time"

 "github.com/gojek/heimdall/v7/httpclient"
)

func main() {
 // Heimdall HTTP クライアントを作成
 client := httpclient.NewClient(
 httpclient.WithHTTPTimeout(10*time.Second), // 10秒のタイムアウトを設定
 httpclient.WithRetryCount(3), // リトライ回数を3回に設定
 )

 // GET リクエストを送信
 resp, err := client.Get("https://httpbin.org/get", nil)
 if err != nil {
 log.Fatalf("リクエスト失敗: %v", err)
 }
 defer resp.Body.Close()

 // レスポンスの内容を出力
 body, _ := io.ReadAll(resp.Body)
 fmt.Printf("ステータスコード: %d\n", resp.StatusCode)
 fmt.Printf("レスポンスボディ: %s\n", string(body))
}
</code></pre>
実行結果:
<pre><code class="hljs language-console">ステータスコード: 200
レスポンスボディ: {
 "args": {}, 
 "headers": {
 "Accept-Encoding": "gzip", 
 "Host": "httpbin.org", 
 "User-Agent": "Go-http-client/2.0", 
 "X-Amzn-Trace-Id": "Root=1-67849d2b-4d02c15a4caca51b640a9756"
 }, 
 "origin": "124.215.81.43", 
 "url": "https://httpbin.org/get"
}
</code></pre>
<h3 id="post-リクエストの送信例">POST リクエストの送信例</h3>
POST リクエストは、データをサーバーに送信するために使用されます。例えば、JSON データをサーバーに送信する際に使用します。
<pre><code class="hljs language-go">package main

import (
 "bytes"
 "fmt"
 "io"
 "log"
 "net/http"
 "time"

 "github.com/gojek/heimdall/v7/httpclient"
)

func main() {
 // Heimdall HTTP クライアントを作成
 client := httpclient.NewClient(
 httpclient.WithHTTPTimeout(10*time.Second), // 10秒のタイムアウトを設定
 httpclient.WithRetryCount(3), // リトライ回数を3回に設定
 )

 // JSON データを送信
 data := []byte(`{"message": "Hello, Heimdall!"}`)
 headers := http.Header{
 "Content-Type": []string{"application/json"},
 }

 // POST リクエストを送信
 resp, err := client.Post("https://httpbin.org/post", bytes.NewBuffer(data), headers)
 if err != nil {
 log.Fatalf("リクエスト失敗: %v", err)
 }
 defer resp.Body.Close()

 // レスポンスの内容を出力
 body, err := io.ReadAll(resp.Body)
 if err != nil {
 log.Fatalf("レスポンス読み取り失敗: %v", err)
 }

 fmt.Printf("ステータスコード: %d\n", resp.StatusCode)
 fmt.Printf("レスポンスボディ: %s\n", string(body))
}
</code></pre>
実行結果:
<pre><code class="hljs language-console">ステータスコード: 200
レスポンスボディ: {
 "args": {}, 
 "data": "{\"message\": \"Hello, Heimdall!\"}", 
 "files": {}, 
 "form": {}, 
 "headers": {
 "Accept-Encoding": "gzip", 
 "Content-Length": "31", 
 "Content-Type": "application/json", 
 "Host": "httpbin.org", 
 "User-Agent": "Go-http-client/2.0", 
 "X-Amzn-Trace-Id": "Root=1-67849d7f-3764380445ce957652576dd5"
 }, 
 "json": {
 "message": "Hello, Heimdall!"
 }, 
 "origin": "124.215.81.43", 
 "url": "https://httpbin.org/post"
}
</code></pre>
<h2 id="バックオフを使ったリトライ">バックオフを使ったリトライ</h2>
<h3 id="固定バックオフを使ったリトライ">固定バックオフを使ったリトライ</h3>
固定バックオフとは、リトライ間隔を一定時間に設定する戦略です。たとえば、失敗したリクエストを 2 秒間隔で再試行するといった設定が可能です。この戦略はリトライ間隔が一定で予測可能であるため、シンプルなケースで効果的です。
以下は、固定バックオフを利用してリトライを実装するコード例です。この例では、2 秒間隔でリトライを行い、HTTP リクエストにタイムアウトを設定しています。
<pre><code class="hljs language-go">package main

import (
 "fmt"
 "net/http"
 "time"

 "github.com/gojek/heimdall/v7/httpclient"
 "github.com/gojek/heimdall/v7/plugins"
)

func main() {
 // 固定バックオフを設定（リトライ間隔: 2秒）
 backoff := heimdall.NewConstantBackoff(2*time.Second, 1*time.Second)

 // HTTP クライアントを作成
 client := httpclient.NewClient(
 httpclient.WithHTTPTimeout(10*time.Second), // タイムアウトを10秒に設定
 httpclient.WithRetrier(heimdall.NewRetrier(backoff)), // リトライ機能を設定
 )

 // リクエストを実行
 response, err := client.Get("https://example.com", nil)
 if err != nil {
 fmt.Printf("リクエスト失敗: %v\n", err)
 return
 }

 fmt.Printf("レスポンスコード: %d\n", response.StatusCode)
}
</code></pre>
<ol>
<li>固定バックオフの設定
<ul>
<li><code>heimdall.NewConstantBackoff</code> を使用して固定バックオフを作成しています。2 秒の間隔と 1 秒の jitter を設定しており、リトライ間隔にランダムな要素を加えることで、全リクエストが同時に再試行される「スパイク」を回避できます。</li>
</ul>
</li>
<li>タイムアウトの設定
<ul>
<li><code>httpclient.WithHTTPTimeout</code> を使い、リクエストが 10 秒を超えた場合にタイムアウトするよう設定しています。これにより、無限に待機することを防ぎます。</li>
</ul>
</li>
<li>リトライの実行
<ul>
<li>HTTP クライアントの Get メソッドを使用してリクエストを送信しています。失敗した場合は、指定した固定バックオフの設定に基づいて再試行されます。</li>
</ul>
</li>
</ol>
<h3 id="指数バックオフを使ったリトライ">指数バックオフを使ったリトライ</h3>
指数バックオフは、リトライ間隔を段階的に増やす戦略です。たとえば、最初は 500 ミリ秒後に再試行し、次は 1 秒、次は 2 秒というように、間隔を倍増させていきます。この戦略は、リソースへの負荷を抑えつつ、再試行による成功の可能性を高めたい場合に有効です。
以下は、指数バックオフを利用してリトライを実装するコード例です。この例では、初期間隔 500 ミリ秒から最大 5 秒間隔まで、リトライを繰り返す設定になっています。
<pre><code class="hljs language-go">package main

import (
 "fmt"
 "net/http"
 "time"

 "github.com/gojek/heimdall/v7/httpclient"
)

func main() {
 // 指数バックオフを設定
 backoff := heimdall.NewExponentialBackoff(
 500*time.Millisecond, // 初期待機時間（リトライの最初の間隔）
 5*time.Second, // 最大待機時間（リトライ間隔の上限）
 float64(15*time.Second), // 最大経過時間（リトライ全体の制限時間）
 2.0, // 指数増加率（リトライ間隔を倍々に増加）
 )

 // HTTP クライアントを作成
 client := httpclient.NewClient(
 httpclient.WithHTTPTimeout(10*time.Second), // タイムアウトを 10 秒に設定
 httpclient.WithRetrier(heimdall.NewRetrier(backoff)), // リトライ機能を設定
 )

 // GET リクエストを実行
 response, err := client.Get("https://example.com", nil)
 if err != nil {
 fmt.Printf("リクエスト失敗: %v\n", err)
 return
 }

 // レスポンスコードを出力
 fmt.Printf("レスポンスコード: %d\n", response.StatusCode)
}
</code></pre>
<ol>
<li>指数バックオフの設定
<ul>
<li><code>heimdall.NewExponentialBackoff</code> を使用して、初期の待機時間を 500 ミリ秒、最大待機時間を 5 秒、最大リトライ時間を 15 秒に設定しています。リトライごとに待機時間が増加するため、短時間での連続的なリトライを防ぎ、サーバー負荷の軽減に役立ちます。</li>
</ul>
</li>
<li>リトライの管理
<ul>
<li><code>heimdall.NewRetrier</code> を使って、バックオフ戦略を持つリトライ機能を HTTP クライアントに設定しています。これにより、サーバーの過負荷やネットワークエラーが原因の失敗時に適切な再試行が行われます。</li>
</ul>
</li>
<li>タイムアウトの設定
<ul>
<li><code>httpclient.WithHTTPTimeout</code> により、10 秒を超えるリクエストは失敗として処理されます。これにより、長いリトライ待機による無限ループを防止します。</li>
</ul>
</li>
</ol>
<h2 id="まとめ">まとめ</h2>
<ul>
<li>Heimdall は Go 言語向けの堅牢な HTTP クライアントライブラリ</li>
<li>リトライ機能やバックオフ戦略を簡単に実装可能</li>
<li>固定バックオフや指数バックオフを活用した信頼性の高い API 呼び出しの実現</li>
<li>HTTP クライアントのタイムアウトやカスタム設定の柔軟性</li>
<li>初心者でも理解しやすい API デザインと豊富な拡張性</li>
</ul>
<hr>
<hr>
[Next] <a href="/posts/308">Step 8-2: Grequests</a>
[Prev] <a href="/posts/306">Step 7-1: Melody</a>

<a href="https://roadmap.sh/" rel="noopener noreferrer" target="_blank">roadmap.sh</a> > <a href="https://roadmap.sh/golang" rel="noopener noreferrer" target="_blank">Go</a> > API Clients > REST > Heimdall の学習を進めていきます。
<div class="img_wrap"><img src="/images/posts/307/01.png" width="1576" height="1146" alt="学習箇所"></div>
※ 学習メモとしての記録ですが、後にこのセクションを学ぶ道しるべとなるよう、ですます調で記載しています。
<h2 id="contents">contents</h2>
<ol>
<li><a href="#%E9%96%8B%E7%99%BA%E7%92%B0%E5%A2%83">開発環境</a></li>
<li><a href="#%E5%8F%82%E8%80%83-url">参考 URL</a></li>
<li><a href="#heimdall">Heimdall</a>
<ol>
<li><a href="#heimdall-%E3%81%AE%E7%89%B9%E5%BE%B4">Heimdall の特徴</a></li>
</ol>
</li>
<li><a href="#heimdall-%E3%81%AE%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB">Heimdall のインストール</a></li>
<li><a href="#%E5%9F%BA%E6%9C%AC%E7%9A%84%E3%81%AA%E4%BD%BF%E3%81%84%E6%96%B9">基本的な使い方</a>
<ol>
<li><a href="#1-get-%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E3%81%AE%E9%80%81%E4%BF%A1%E4%BE%8B">1. GET リクエストの送信例</a></li>
<li><a href="#post-%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E3%81%AE%E9%80%81%E4%BF%A1%E4%BE%8B">POST リクエストの送信例</a></li>
</ol>
</li>
<li><a href="#%E3%83%90%E3%83%83%E3%82%AF%E3%82%AA%E3%83%95%E3%82%92%E4%BD%BF%E3%81%A3%E3%81%9F%E3%83%AA%E3%83%88%E3%83%A9%E3%82%A4">バックオフを使ったリトライ</a>
<ol>
<li><a href="#%E5%9B%BA%E5%AE%9A%E3%83%90%E3%83%83%E3%82%AF%E3%82%AA%E3%83%95%E3%82%92%E4%BD%BF%E3%81%A3%E3%81%9F%E3%83%AA%E3%83%88%E3%83%A9%E3%82%A4">固定バックオフを使ったリトライ</a></li>
<li><a href="#%E6%8C%87%E6%95%B0%E3%83%90%E3%83%83%E3%82%AF%E3%82%AA%E3%83%95%E3%82%92%E4%BD%BF%E3%81%A3%E3%81%9F%E3%83%AA%E3%83%88%E3%83%A9%E3%82%A4">指数バックオフを使ったリトライ</a></li>
</ol>
</li>
</ol>
<h2 id="開発環境">開発環境</h2>
<ul>
<li>チップ: Apple M2 Pro</li>
<li>OS: macOS Sonoma</li>
<li>go version: go1.23.2 darwin/arm64</li>
</ul>
<h2 id="参考-url">参考 URL</h2>
<ul>
<li><a href="https://github.com/gojek/heimdall" rel="noopener noreferrer" target="_blank">[OpenSource] Heimdall</a></li>
</ul>
<h2 id="heimdall">Heimdall</h2>
Heimdall は、Go で堅牢な HTTP クライアントを構築するためのライブラリです。リトライ機能やカスタムバックオフ戦略などをサポートしており、信頼性の高い API 呼び出しを簡単に実現できます。ここでは Heimdall の基本的な使い方を解説します。
<h3 id="heimdall-の特徴">Heimdall の特徴</h3>
Heimdall は以下のような機能を提供します。
<ol>
<li>リトライ機能：失敗した HTTP リクエストを指定回数再試行します。</li>
<li>バックオフ戦略：リトライ時の待機時間を制御できます（例: 固定、指数、Jitter）。</li>
<li>タイムアウトの設定：HTTP リクエストにタイムアウトを設定できます。</li>
<li>カスタマイズ可能：独自のバックオフ戦略や HTTP クライアントを実装可能です。</li>
</ol>
<h2 id="heimdall-のインストール">Heimdall のインストール</h2>
Heimdall をプロジェクトに追加するには、以下のコマンドを実行します：
<pre><code class="hljs language-console">go get -u github.com/gojek/heimdall/v7
</code></pre>
<h2 id="基本的な使い方">基本的な使い方</h2>
以下に Heimdall を使ったシンプルな例を示します。
<h3 id="1-get-リクエストの送信例">1. GET リクエストの送信例</h3>
GET リクエストは最も基本的な HTTP リクエストで、サーバーからデータを取得するために使用されます。Heimdall を使用すると、リトライやタイムアウトを簡単に設定できます。
<pre><code class="hljs language-go">package main

import (
 "fmt"
 "io"
 "log"
 "time"

 "github.com/gojek/heimdall/v7/httpclient"
)

func main() {
 // Heimdall HTTP クライアントを作成
 client := httpclient.NewClient(
 httpclient.WithHTTPTimeout(10*time.Second), // 10秒のタイムアウトを設定
 httpclient.WithRetryCount(3), // リトライ回数を3回に設定
 )

 // GET リクエストを送信
 resp, err := client.Get("https://httpbin.org/get", nil)
 if err != nil {
 log.Fatalf("リクエスト失敗: %v", err)
 }
 defer resp.Body.Close()

 // レスポンスの内容を出力
 body, _ := io.ReadAll(resp.Body)
 fmt.Printf("ステータスコード: %d\n", resp.StatusCode)
 fmt.Printf("レスポンスボディ: %s\n", string(body))
}
</code></pre>
実行結果:
<pre><code class="hljs language-console">ステータスコード: 200
レスポンスボディ: {
 "args": {}, 
 "headers": {
 "Accept-Encoding": "gzip", 
 "Host": "httpbin.org", 
 "User-Agent": "Go-http-client/2.0", 
 "X-Amzn-Trace-Id": "Root=1-67849d2b-4d02c15a4caca51b640a9756"
 }, 
 "origin": "124.215.81.43", 
 "url": "https://httpbin.org/get"
}
</code></pre>
<h3 id="post-リクエストの送信例">POST リクエストの送信例</h3>
POST リクエストは、データをサーバーに送信するために使用されます。例えば、JSON データをサーバーに送信する際に使用します。
<pre><code class="hljs language-go">package main

import (
 "bytes"
 "fmt"
 "io"
 "log"
 "net/http"
 "time"

 "github.com/gojek/heimdall/v7/httpclient"
)

func main() {
 // Heimdall HTTP クライアントを作成
 client := httpclient.NewClient(
 httpclient.WithHTTPTimeout(10*time.Second), // 10秒のタイムアウトを設定
 httpclient.WithRetryCount(3), // リトライ回数を3回に設定
 )

 // JSON データを送信
 data := []byte(`{"message": "Hello, Heimdall!"}`)
 headers := http.Header{
 "Content-Type": []string{"application/json"},
 }

 // POST リクエストを送信
 resp, err := client.Post("https://httpbin.org/post", bytes.NewBuffer(data), headers)
 if err != nil {
 log.Fatalf("リクエスト失敗: %v", err)
 }
 defer resp.Body.Close()

 // レスポンスの内容を出力
 body, err := io.ReadAll(resp.Body)
 if err != nil {
 log.Fatalf("レスポンス読み取り失敗: %v", err)
 }

 fmt.Printf("ステータスコード: %d\n", resp.StatusCode)
 fmt.Printf("レスポンスボディ: %s\n", string(body))
}
</code></pre>
実行結果:
<pre><code class="hljs language-console">ステータスコード: 200
レスポンスボディ: {
 "args": {}, 
 "data": "{\"message\": \"Hello, Heimdall!\"}", 
 "files": {}, 
 "form": {}, 
 "headers": {
 "Accept-Encoding": "gzip", 
 "Content-Length": "31", 
 "Content-Type": "application/json", 
 "Host": "httpbin.org", 
 "User-Agent": "Go-http-client/2.0", 
 "X-Amzn-Trace-Id": "Root=1-67849d7f-3764380445ce957652576dd5"
 }, 
 "json": {
 "message": "Hello, Heimdall!"
 }, 
 "origin": "124.215.81.43", 
 "url": "https://httpbin.org/post"
}
</code></pre>
<h2 id="バックオフを使ったリトライ">バックオフを使ったリトライ</h2>
<h3 id="固定バックオフを使ったリトライ">固定バックオフを使ったリトライ</h3>
固定バックオフとは、リトライ間隔を一定時間に設定する戦略です。たとえば、失敗したリクエストを 2 秒間隔で再試行するといった設定が可能です。この戦略はリトライ間隔が一定で予測可能であるため、シンプルなケースで効果的です。
以下は、固定バックオフを利用してリトライを実装するコード例です。この例では、2 秒間隔でリトライを行い、HTTP リクエストにタイムアウトを設定しています。
<pre><code class="hljs language-go">package main

import (
 "fmt"
 "net/http"
 "time"

 "github.com/gojek/heimdall/v7/httpclient"
 "github.com/gojek/heimdall/v7/plugins"
)

func main() {
 // 固定バックオフを設定（リトライ間隔: 2秒）
 backoff := heimdall.NewConstantBackoff(2*time.Second, 1*time.Second)

 // HTTP クライアントを作成
 client := httpclient.NewClient(
 httpclient.WithHTTPTimeout(10*time.Second), // タイムアウトを10秒に設定
 httpclient.WithRetrier(heimdall.NewRetrier(backoff)), // リトライ機能を設定
 )

 // リクエストを実行
 response, err := client.Get("https://example.com", nil)
 if err != nil {
 fmt.Printf("リクエスト失敗: %v\n", err)
 return
 }

 fmt.Printf("レスポンスコード: %d\n", response.StatusCode)
}
</code></pre>
<ol>
<li>固定バックオフの設定
<ul>
<li><code>heimdall.NewConstantBackoff</code> を使用して固定バックオフを作成しています。2 秒の間隔と 1 秒の jitter を設定しており、リトライ間隔にランダムな要素を加えることで、全リクエストが同時に再試行される「スパイク」を回避できます。</li>
</ul>
</li>
<li>タイムアウトの設定
<ul>
<li><code>httpclient.WithHTTPTimeout</code> を使い、リクエストが 10 秒を超えた場合にタイムアウトするよう設定しています。これにより、無限に待機することを防ぎます。</li>
</ul>
</li>
<li>リトライの実行
<ul>
<li>HTTP クライアントの Get メソッドを使用してリクエストを送信しています。失敗した場合は、指定した固定バックオフの設定に基づいて再試行されます。</li>
</ul>
</li>
</ol>
<h3 id="指数バックオフを使ったリトライ">指数バックオフを使ったリトライ</h3>
指数バックオフは、リトライ間隔を段階的に増やす戦略です。たとえば、最初は 500 ミリ秒後に再試行し、次は 1 秒、次は 2 秒というように、間隔を倍増させていきます。この戦略は、リソースへの負荷を抑えつつ、再試行による成功の可能性を高めたい場合に有効です。
以下は、指数バックオフを利用してリトライを実装するコード例です。この例では、初期間隔 500 ミリ秒から最大 5 秒間隔まで、リトライを繰り返す設定になっています。
<pre><code class="hljs language-go">package main

import (
 "fmt"
 "net/http"
 "time"

 "github.com/gojek/heimdall/v7/httpclient"
)

func main() {
 // 指数バックオフを設定
 backoff := heimdall.NewExponentialBackoff(
 500*time.Millisecond, // 初期待機時間（リトライの最初の間隔）
 5*time.Second, // 最大待機時間（リトライ間隔の上限）
 float64(15*time.Second), // 最大経過時間（リトライ全体の制限時間）
 2.0, // 指数増加率（リトライ間隔を倍々に増加）
 )

 // HTTP クライアントを作成
 client := httpclient.NewClient(
 httpclient.WithHTTPTimeout(10*time.Second), // タイムアウトを 10 秒に設定
 httpclient.WithRetrier(heimdall.NewRetrier(backoff)), // リトライ機能を設定
 )

 // GET リクエストを実行
 response, err := client.Get("https://example.com", nil)
 if err != nil {
 fmt.Printf("リクエスト失敗: %v\n", err)
 return
 }

 // レスポンスコードを出力
 fmt.Printf("レスポンスコード: %d\n", response.StatusCode)
}
</code></pre>
<ol>
<li>指数バックオフの設定
<ul>
<li><code>heimdall.NewExponentialBackoff</code> を使用して、初期の待機時間を 500 ミリ秒、最大待機時間を 5 秒、最大リトライ時間を 15 秒に設定しています。リトライごとに待機時間が増加するため、短時間での連続的なリトライを防ぎ、サーバー負荷の軽減に役立ちます。</li>
</ul>
</li>
<li>リトライの管理
<ul>
<li><code>heimdall.NewRetrier</code> を使って、バックオフ戦略を持つリトライ機能を HTTP クライアントに設定しています。これにより、サーバーの過負荷やネットワークエラーが原因の失敗時に適切な再試行が行われます。</li>
</ul>
</li>
<li>タイムアウトの設定
<ul>
<li><code>httpclient.WithHTTPTimeout</code> により、10 秒を超えるリクエストは失敗として処理されます。これにより、長いリトライ待機による無限ループを防止します。</li>
</ul>
</li>
</ol>
<h2 id="まとめ">まとめ</h2>
<ul>
<li>Heimdall は Go 言語向けの堅牢な HTTP クライアントライブラリ</li>
<li>リトライ機能やバックオフ戦略を簡単に実装可能</li>
<li>固定バックオフや指数バックオフを活用した信頼性の高い API 呼び出しの実現</li>
<li>HTTP クライアントのタイムアウトやカスタム設定の柔軟性</li>
<li>初心者でも理解しやすい API デザインと豊富な拡張性</li>
</ul>
<hr>
<hr>
[Next] <a href="/posts/308">Step 8-2: Grequests</a>
[Prev] <a href="/posts/306">Step 7-1: Melody</a>

Author