Golang: 手軽にシグナルをListenしてcallback関数を呼ぶ

Go言語でシグナルを取り扱いたい場合、osパッケージおよびos/signalパッケージ、syscallパッケージを使用します。

具体的には、以下のようにします。

func main() {
    sigCh := make(chan os.Signal, 1)
    doneCh := make(chan struct{})
    
    signal.Notify(sigCh, syscall.SIGINT)
    
    go func() {
        sig := <-sigCh
        fmt.Println(sig) // (1)
        close(doneCh)
    }()
    <-done
}

実際には、(1)の様に受け取ったシグナルを出力するだけではなく、何らかの処理を行うことになるでしょうし、goroutineのリークを避けるためにシグナルの待受をキャンセルする必要が有りますから、contextを使用してfor-selectループを書くことにもなるでしょう。

例として、HTTPサーバをシャットダウンするような処理を考えます。

func main() {
    sigCh := make(chan os.Signal, 1)
    doneCh := make(chan struct{})
    ctx, cancel := context.WithCancel(context.Background())
    
    signal.Notify(sigCh, syscall.SIGINT)
    
    s := &http.Server{
        Addr: ":8080",
        Handler: http.DefaultServeMux,
    }
    
    go func() {
        for {
            select {
            case sig := <-sigCh:
                sig := <-sigCh
                s.Shutdown(context.Background())
                close(doneCh)
            case <-ctx.Done():
                return
            }
        }
    }()
    
    if err := s.ListenAndServe(); err != http.ErrServerClosed {
        log.Println(err)
        cancel()
        return
    }
    <-doneCh
}

シグナルを受け取って、関数の呼び出し(ここではs.Shutdown())をしたいだけなのに、チャンネルを作って、goroutineを立ち上げて、となんとも大仰です。 goroutineで呼び出す関数の中でfor-selectループを使っているため、行数も長くなってしまっています。

できれば、これらの処理を、もっと気軽に取り扱いたいですよね。

そこで、<code>syg</code> というパッケージを作成しました。

<code>github.com/nasa9084/syg</code>

sygパッケージに用意されているのは関数二つだけです。 ListenとListenContextだけです。察しの良い方はお気づきかもしれませんが、Listenは内部でcontext.Backgroundを使ってListenContextを呼び出します。 database/sqlパッケージの*DB.Queryと*DB.QueryContextなどの関係と同じです。つまり、処理的には実質一つの関数のみしかありません。

これらの関数はコールバック関数とシグナル(可変長)をとり、CancelFuncを返します。名前の通り、シグナルをListenして、シグナルを受け取ったら所定のコールバック関数を呼ぶ、というものです。 CancelFuncはgoroutineを停止するキャンセル用の関数のため、deferで呼び出すことでgoroutineのリークも防げます。

先程のHTTPサーバのシャットダウンの例を、sygを使用して書き換えてみます。

func main() {
    doneCh := make(chan struct{})

    s := &http.Server{
        Addr: ":8080",
        Handler: http.DefaultServeMux,
    }
    
    cancel := syg.Listen(func(os.Signal) { 
        s.Shutdown(context.Background())
        close(doneCh)
    })
    defer cancel()
    
    if err := s.ListenAndServe(); err != http.ErrServerClosed {
        log.Println(err)
        return
    }
    <-doneCh
}

goroutineの立ち上げや、シグナルを受け渡すチャンネルの処理、for-selectループなくなり、スッキリしました。

sygは数十行程度の小さなパッケージですが、是非使ってみてください！バグや改善点が有りましたら、issue、PRもお待ちしています！