golang 中signal包的Notify用法说明

221 阅读 0 评论 146 点赞

我是靠谱客的博主迷你小熊猫，最近开发中收集的这篇文章主要介绍golang 中signal包的Notify用法说明，觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

函数声明为：

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 的作用。

以上为个人经验，希望能给大家一个参考，也希望大家多多支持靠谱客。如有错误或未考虑完全的地方，望不吝赐教。