golang 中signal包的Notify用法說明

Posted on by

函數聲明為：

func Notify(c chan<- os.Signal, sig ...os.Signal)

官方描述：

Notify函數讓signal包將輸入信號轉發到c。如果沒有列出要傳遞的信號，會將所有輸入信號傳遞到c；否則隻傳遞列出的輸入信號。

signal包不會為瞭向c發送信息而阻塞（就是說如果發送時c阻塞瞭，signal包會直接放棄）：調用者應該保證c有足夠的緩存空間可以跟上期望的信號頻率。對使用單一信號用於通知的通道，緩存為1就足夠瞭。

示例代碼：

ch := make(chan os.Signal, 1)
  signal.Notify(ch, syscall.SIGHUP, syscall.SIGQUIT, syscall.SIGTERM, syscall.SIGSTOP, syscall.SIGUSR1)
  for {
    s := <-ch
    switch s {
    case syscall.SIGQUIT:
      log.Infof("SIGSTOP")
      return
    case syscall.SIGSTOP:
      log.Infof("SIGSTOP")
      return
    case syscall.SIGHUP:
      log.Infof("SIGHUP")
      return
    case syscall.SIGKILL:
      log.Infof("SIGKILL")
      return
    case syscall.SIGUSR1:
      log.Infof("SIGUSR1")
      return
    default:
      log.Infof("default")
      return
    }
  }

以上代碼告訴 signal ，將對應的信號通知 ch，然後在 for 循環中針對不同信號做不同的處理， for 循環為死循環。

補充：關於 signal.Notify 使用帶緩存的 channel

package main
import (
  "fmt"
  "os"
  "os/signal"
)
func main() {
  // Set up channel on which to send signal notifications.
  // We must use a buffered channel or risk missing the signal
  // if we're not ready to receive when the signal is sent.
  c := make(chan os.Signal, 1)
  signal.Notify(c, os.Interrupt)
  // Block until a signal is received.
  s := <-c
  fmt.Println("Got signal:", s)
}

上面一段代碼是 signal.Notify 的事例代碼，註釋說：

我們得使用帶緩沖 channel

否則，發送信號時我們還沒有準備好接收，就有丟失信號的風險

我一直沒理解這段註釋，於是翻看源碼 $GOROOT/src/os/signal/signal.go，有這樣一段代碼，並註釋有“發送但不阻塞”。這裡應該就是“有可能丟失信號”的原因瞭吧。

  ...
  for c, h := range handlers.m {
    if h.want(n) {
      // send but do not block for it
      select {
      case c <- sig:
      default:
      }
    }
  }
  ...

於是，我寫瞭一段代碼進行測試：

package main
import (
  "log"
  "os"
  "os/signal"
  "time"
)
func main() {
  c := make(chan os.Signal)
  signal.Notify(c, os.Interrupt)
  time.Sleep(time.Second * 5) // 假裝 5 秒沒準備好接收
  s := <-c
  log.Println(s)
}

在使用不帶緩存的 channel 時，5 秒的 sleep 期間無論按多少個 control + c，sleep 結束都不會打印，也不會退出程序；

在使用帶緩存的 channel 時，隻要接收到一個 SIGINT ，在 sleep 結束後也就是準備好接收，便會打印並退出程序。

這就是 signal.Notify 使用帶緩存 channel 的作用。

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。如有錯誤或未考慮完全的地方，望不吝賜教。

推薦閱讀：