imicola HTTP优雅退出流程
HTTP优雅退出流程

HTTP优雅退出流程

414 字 · 约 1 分钟

我们之前写过http.ListenAndServe(":8080", mux) 这样的代码,这实际上是一个快捷函数,其在内部构造了 http.Server,但是我们没办法调用,配置它,所以在进行优雅退出前,我们先要了解如何自行配置http.Server

Http.Server

其实很简单,其结构如下

server := &http.Server{
	Addr:              ":8080",
	Handler:           mux,
	ReadHeaderTimeout: 5 * time.Second,  // 客户端传入Header限制
	ReadTimeout:       8 * time.Second,  // 服务器读取整个请求时间限制
	WriteTimeout:      10 * time.Second, // 服务器写入响应时间限制
	IdleTimeout:       30 * time.Second, // HTTP keep-alive
}
go

这几个Timeout限制在此简单说明一下

  • ReadHeaderTimeout 是“客户端最多花多久把 HTTP 请求头发给我”
  • ReadTimeout 更广,它大体限制服务端读取整个请求的时间,包括 header 和 body
  • WriteTimeout 则反过来,是服务器最多允许自己花多长时间把响应写回客户端
  • IdleTimeout 主要对应 HTTP keep-alive

有一个很重要的性质是 err := server.ListenAndServe() 这个函数是常态阻塞的,所以我们应该将其放入一个 goroutine 中,同时这样也可以更好的实现优雅退出等操作

信号

ctx, stop := signal.NotifyContext(
    context.Background(),
    os.Interrupt,
    syscall.SIGTERM,
)
defer stop()
go

我们可以这样注册信号,这个结构的意思是在接受到 os.Interrupt 和 syscall.SIGTERM 后发送信号停止

退出方法

select {
	case err := <-serverErr:
		if err != nil && !errors.Is(err, http.ErrServerClosed) {
			return fmt.Errorf("listen and serve: %w", err)
		}
		log.Println("Server Normal exit")
		return nil
	case <-ctx.Done():
		shutdownCtx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
		defer cancel()

		err := server.Shutdown(shutdownCtx)
		if err != nil {
			return fmt.Errorf("shutdown server: %w", err)
		}
		log.Println("get system stop signal,exit Http server")
		return nil
	}
go

这部分需要拆分成两个大块

  • 对于上面的 err := <- serverErr 的分支
    • 我们必须判读这是否不是我们close所产生的error,所以有个判断条件,因为正常调用 server.Shutdown 也会产生一个error,但这个不能称为错误了,而是一个正常的退出逻辑
  • 对于下面的 <- ctx.Done 分支
    • 我们不能收到信号后立刻 Server.Close ,我们应该预留一个时间窗口通知服务器中的

知识关联

1 反向链接 · 0 提及笔记
局部关系图谱 悬停高亮 · 点击跳转