Go 源码合集--server shutdown

Go 源码合集–server shutdown

使用示例

func main() {
  ...

  // 当前的 Goroutine 等待信号量
  quit := make(chan os.Signal)
  // 监控信号：SIGINT, SIGTERM, SIGQUIT
  signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM, syscall.SIGQUIT)
  // 这里会阻塞当前 Goroutine 等待信号
  <-quit

  // 调用Server.Shutdown graceful结束
  // 会最长再等待 5s 实际使用 要考虑  在关闭 server 时 最长等待多久合适
	timeoutCtx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
	defer cancel()

	if err := server.Shutdown(timeoutCtx); err != nil {
		log.Fatal("Server Shutdown:", err)
	}
}

server shutdown

// 原子设置状态
func (b *atomicBool) setTrue()    { atomic.StoreInt32((*int32)(b), 1) }

func (srv *Server) Shutdown(ctx context.Context) error {
  // 设置 server 是关闭状态 不再接受新连接
	srv.inShutdown.setTrue()

  // 获取 server 锁
	srv.mu.Lock()
  // 关闭所有的监听器，即停止服务器接受新的连接
	lnerr := srv.closeListenersLocked()
  // 闭一个用于通知关闭完成的通道,释放相关资源
	srv.closeDoneChanLocked()
  // 执行关闭 server 的钩子函数,执行设置的 server 回调函数
	for _, f := range srv.onShutdown {
		go f()
	}
	srv.mu.Unlock()

  // 以指数增长的时间间隔来轮询活跃连接的状态
	pollIntervalBase := time.Millisecond
  // 设置获取轮询间隔时长函数
	nextPollInterval := func() time.Duration {
		// Add 10% jitter.
		interval := pollIntervalBase + time.Duration(rand.Intn(int(pollIntervalBase/10)))
		// Double and clamp for next time.
		pollIntervalBase *= 2
		if pollIntervalBase > shutdownPollIntervalMax {
			pollIntervalBase = shutdownPollIntervalMax
		}
		return interval
	}
	// runtime  CPU 消耗会远低于 time.Sleep
	timer := time.NewTimer(nextPollInterval())
  // 在函数结束时停止定时器，以防止泄漏
	defer timer.Stop()
	for {
    // 检查是否可以关闭空闲连接并且所有监听器都已经关闭
    // closeIdleConns 真正执行关闭空闲连接操作
		if srv.closeIdleConns() && srv.numListeners() == 0 {
			return lnerr
		}
		select {
      // context 触发超时  Done  chan 有值
		case <-ctx.Done():
			return ctx.Err()
      // 下一轮 轮询 每隔多少时间做一次操作
		case <-timer.C:
			timer.Reset(nextPollInterval())
		}
	}
}

type Timer struct {
	C <-chan Time
	r runtimeTimer
}

closeIdleConns

// closeIdleConns 关闭所有的连接并且记录是否服务器的连接已经全部关闭
func (s *Server) closeIdleConns() bool {
  s.mu.Lock()
  defer s.mu.Unlock()
  // 是否 已经关闭所有 conn
  quiescent := true
  for c := range s.activeConn {
    st, unixSec := c.getState()
    // Issue 22682: 这里预留5s以防止在第一次读取连接头部信息的时候超过5s
    // 查看是是否可以设置为StateIdle 扎实能退
    if st == StateNew && unixSec < time.Now().Unix()-5 {
      // 处理连接在第一次读取连接头部信息时超过了 5 秒的情况
      // 即连接建立时间是否早于当前时间 5 秒以上
      // 为了避免 连接是刚刚被建立 就被关闭的情况
      // 即 至少维持StateNew 状态 5s
      st = StateIdle
    }
    if st != StateIdle || unixSec == 0 {
      // unixSec == 0 代表这个连接是非常新的连接，则标记位需要标记false
      quiescent = false
      // 不可以退出 直接continue
      continue
    }
    c.rwc.Close()
    delete(s.activeConn, c)
  }
  return quiescent
}