Go Context の使用法

Context を最初のパラメータとする

Context を使う関数では、これを最初のパラメータとして受け取るべきです:

func F(ctx context.Context, /* other arguments */) error
func ProcessRequest(ctx context.Context, req *Request) (*Response, error)

これは Go の強力な慣例で、context のフローを目に見える形で一貫性を持たせて コードベース全体に広げるものです。

---

Context を構造体に格納しない

Context メンバーを構造体型に追加しないでください。代わりに、それが必要な 各メソッドに ctx をパラメータとして渡してください:

// 悪い例: Context を構造体に格納
type Worker struct {
    ctx context.Context  // これはしないでください
}

// 良い例: Context をメソッドに渡す
type Worker struct{ /* ... */ }

func (w *Worker) Process(ctx context.Context) error {
    // Context が明示的に渡される — ライフタイムが明確
}

例外: 標準ライブラリまたはサードパーティ製ライブラリのインターフェースの シグネチャに合致させる必要があるメソッドは、これを回避する必要があるかもしれません。

---

カスタム Context 型を作成しない

カスタム Context 型を作成したり、関数シグネチャで context.Context 以外の インターフェースを使用したりしないでください:

// 悪い例: カスタム context 型
type MyContext interface {
    context.Context
    GetUserID() string
}

// 良い例: 標準的な context.Context を使用して値を抽出
func Process(ctx context.Context) error {
    userID := GetUserID(ctx)
}

---

アプリケーションデータをどこに置くか

優先順位の高い順に、以下の選択肢を検討してください:

1. 関数のパラメータ — 最も明示的で型安全
2. レシーバ — その型に属するデータ向け
3. グローバル変数 — 本当にグローバルな設定向け (控えめに使用)
4. Context 値 — リクエストスコープのデータのみ

Context 値が適切な場合:

• リクエスト ID とトレース ID
• リクエストとともに流れる認証・認可情報
• デッドラインとキャンセルシグナル

Context 値が不適切な場合:

• オプショナルな関数パラメータ
• 明示的に渡せるデータ
• リクエストごとに変わらない設定

---

よくあるパターン

Context を導出するとき (WithTimeout, WithCancel, WithDeadline)、ループや HTTP ハンドラーでキャンセルをチェックするとき、型付きキーで context 値を使用するとき、またはクイックリファレンステーブルが必要なときは references/PATTERNS.md を読んでください。

Context を導出する

導出された context を作成した直後に、必ず defer cancel() を使用してください:

ctx, cancel := context.WithTimeout(ctx, 5*time.Second)
defer cancel()

キャンセルをチェックする

select {
case <-ctx.Done():
    return ctx.Err()
default:
    // 処理を実行
}

Context の不変性

Context は不変です — 同じデッドラインとキャンセルシグナルを共有する複数の 同時実行呼び出しに対して、同じ ctx を渡すことは安全です。

---

関連スキル

• Goroutine の調整: context を goroutine キャンセル、select ベースのタイムアウト、または errgroup に使用するときは go-concurrency を参照
• エラーハンドリング: ctx.Err() キャンセルエラーをラップまたは返すかどうかを決定するときは go-error-handling を参照
• インターフェース設計: context とともにインターフェースを受け取る API を設計するときは go-interfaces を参照
• リクエストスコープのログ: ロガーを context に注入したり、構造化ログ出力にリクエスト ID を追加したりするときは go-logging を参照