コンテンツにスキップ

Go/goコマンド/vet/sigchanyzer

出典: フリー教科書『ウィキブックス(Wikibooks)』

go vet の sigchanyzer アナライザ

[編集]

何を検出するか

[編集]

signal.Notify にバッファなしチャネルを渡しているコードを検出します。

問題のあるコード

[編集]
c := make(chan os.Signal)    // ⚠️ バッファなし
signal.Notify(c, os.Interrupt)

なぜ問題なのか

[編集]

signal.Notify はシグナルを受信すると、登録されたチャネルにシグナルを送信します。しかしこの送信はノンブロッキングで行われます。

OS がシグナルを送出
        ↓
Go ランタイムがチャネルに送信しようとする
        ↓
バッファなし → 受信側の準備ができていないと送信できない
        ↓
シグナルが破棄される(ドロップ)

signal.Notify の公式ドキュメントにも明記されています:

> Package signal will not block sending to c: the caller must ensure that c has sufficient buffer space to keep up with the expected signal rate.

正しいコード

[編集]

バッファサイズ 1 以上のチャネルを使います。

c := make(chan os.Signal, 1) // ✅ バッファあり
signal.Notify(c, os.Interrupt)

バッファサイズ 1 で十分な理由は、シグナルハンドリングは通常:

// 受信したら即座に処理するパターンが多い
<-c
// シャットダウン処理...

連続して複数のシグナルを処理したい場合はより大きなバッファが必要です。

典型的な使用パターン

[編集]
// ✅ グレースフルシャットダウンの定番イディオム
c := make(chan os.Signal, 1)
signal.Notify(c, os.Interrupt, syscall.SIGTERM)
defer signal.Stop(c)

<-c // シグナルを待つ
fmt.Println("shutting down...")

signal.Stop も忘れずに

[編集]

signal.Notify を使ったら、不要になった時点で signal.Stop でチャネルへの通知を解除します。

c := make(chan os.Signal, 1)
signal.Notify(c, os.Interrupt)
defer signal.Stop(c) // ✅ チャネルへの送信を停止してリソースを解放

まとめ

[編集]
コード 問題
make(chan os.Signal) を signal.Notify に渡す ⚠️ シグナルがドロップする可能性
make(chan os.Signal, 1) を signal.Notify に渡す ✅ バッファありで安全

シグナルのドロップは低頻度かつタイミング依存なため、テストでは再現しにくいバグです。特に SIGTERM を取りこぼすとグレースフルシャットダウンが機能しないという深刻な問題になりえます。バッファサイズ 1 を習慣にしておくだけで防げます。