Webサーバの安全な起動と終了
http.ListenAndServe はサーバを起動して、リクエストを待ち続ける関数です。呼び出したあとは後続のコードに進まず、シグナル(Ctrl+C や SIGTERM)を受け取るまでそのまま動き続けます。実運用ではこのシグナルを受けたときに、処理中のリクエストが途中で切れないよう、それらが終わってからサーバを止めたい場面が多くあります。この「進行中のリクエストを最後まで処理してから安全に止める」方法をグレースフルシャットダウンと呼び、http.Server を明示的に用意して Shutdown メソッドを呼ぶことで実現できます。
これは、グレースフルシャットダウンを実現する main.go の全体コードです。main.go を以下の内容で置き換えて保存します。
package main
import (
"context"
"fmt"
"log"
"net/http"
"os"
"os/signal"
"syscall"
"time"
)
func main() {
mux := http.NewServeMux()
mux.HandleFunc("GET /health", func(w http.ResponseWriter, r *http.Request) {
fmt.Fprintln(w, "ok")
})
srv := &http.Server{
Addr: ":8080",
Handler: mux,
}
go func() {
if err := srv.ListenAndServe(); err != nil && err != http.ErrServerClosed {
log.Fatal(err)
}
}()
fmt.Println("http://localhost:8080 で起動")
// シグナル受信を待つ
sigCh := make(chan os.Signal, 1)
signal.Notify(sigCh, syscall.SIGINT, syscall.SIGTERM)
<-sigCh
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
srv.Shutdown(ctx)
fmt.Println("shutdown完了")
}
サーバを起動して、Ctrl+C で停止します。
go run main.go
起動メッセージが表示された状態でCtrl+Cを押すと、以下のような実行結果が表示されます。
http://localhost:8080 で起動
^Cshutdown完了
Shutdown(ctx) が呼ばれてサーバが正常に停止し、shutdown完了 のメッセージが表示されました。処理中のリクエストがあれば、それが終わるまで待ってから終了します。
コードを解説します。
srv := &http.Server{
Addr: ":8080",
Handler: mux,
}
go func() {
if err := srv.ListenAndServe(); err != nil && err != http.ErrServerClosed {
log.Fatal(err)
}
}()
http.Server を明示的に用意し、ListenAndServe を goroutine で起動しています。http.ErrServerClosed は Shutdown 呼び出し後に返る想定内のエラーなので、無視しています。
sigCh := make(chan os.Signal, 1)
signal.Notify(sigCh, syscall.SIGINT, syscall.SIGTERM)
<-sigCh
シグナル(Ctrl+C や SIGTERM)を受け取るための channel を用意し、signal.Notify でシグナルを流し込みます。<-sigCh はシグナルが来るまでその場で待ち、コードの実行を先に進めません。
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
srv.Shutdown(ctx)
srv.Shutdown(ctx) は「新しい接続を受け付けず、進行中のリクエストが終わるまで待つ」動きをします。context でタイムアウトを付けておくと、長時間終わらない接続を強制切断できます。詳しくは公式ドキュメント http package に記載があります。