graceful

README

说明

• 优雅的重启和关闭服务器

• 优雅的重启需要获取原进程监听套接字的文件描述符，所以不能直接使用http.server的ListenAndServe和ListenAndServeTLS

• 只要将http.Server替换为ghelper/graceful/server即可

• 优雅的关闭服务器:

  • 服务器会关闭监听，执行用户注册的清理函数，等待未处理完毕的连接继续处理
  • 服务器每隔 500 毫秒判断一次所有连接是否处理完毕，如果处理完毕，则关闭服务器
  • 如果直到超时，都未处理完，直接关闭服务器。如果没有额外设置，默认超时时间为 5 秒

• 优雅的重启服务器:

  • 新进程"继承"旧进程的 os.Stdin, os.Stdout, os.Stderr 三个文件描述符以及 监听套接字 的文件描述符
  • 旧进程优雅的关闭，监听新连接的工作由新进程接手

示例 1

本示例使用默认信号

• 代码

  import (
      "net/http"
      "os"
  
      "github.com/alex-my/ghelper/graceful"
      "github.com/alex-my/ghelper/logger"
  )
  
  // http.Server 要求实现 ServeHTTP
  type testServer struct {}
  
  func (server *testServer) ServeHTTP(res http.ResponseWriter, req *http.Request) {
    // 这里进行逻辑处理，比如按照路由进行处理
    res.Write([]byte("Hello world"))
  }
  
  func main() {
      addr := "127.0.0.1:8877"
      server := &testServer{}
      logger := logger.NewLogger()
  
      // 使用 gserver 而不是 http.Server
      gserver := graceful.NewServer(server, logger)
  
      logger.Infof("listen on: http://%s, pid: %d", addr, os.Getpid())
  
      // 监听信号
      graceful.ListenSignal()
  
      // 启动服务器，接受连接
      err := gserver.ListenAndServe(addr)
      if err != nil {
          if err == http.ErrServerClosed {
              logger.Info("server closed")
          } else {
              logger.Error(err.Error())
          }
      }
  }
  

• 操作
  • 关闭服务器: ctrl+c|cmd+c 或者 kill {pid}
  • 重启服务器: kill -USR1 {pid} 或者 kill -USR2 {pid}
  • 重启服务器后，我们发现，仍然可以访问网站。查看端口: mac 下 lsof -i tcp:8877

示例 2

在示例 1 中，使用了默认配置的信号，SIGUSR1，SIGUSR2 用于重启服务器，SIGINT，SIGTERM 用于关闭服务器。但在实际情况中，可能 SIGUSR2 被用户设置其它用途，比如重载配置。这里就需要用到自定义信号

• 代码:

  import (
    "net/http"
    "os"
  
    "github.com/alex-my/ghelper/graceful"
    "github.com/alex-my/ghelper/logger"
  )
  
    // http.Server 要求实现 ServeHTTP
  type testServer struct {}
  
  func (server *testServer) ServeHTTP(res http.ResponseWriter, req *http.Request) {
    // 这里进行逻辑处理，比如按照路由进行处理
    res.Write([]byte("Hello world"))
  }
  
  func main() {
    addr := "127.0.0.1:8877"
    server := &testServer{}
    logger := logger.NewLogger()
  
    // 使用 gserver 而不是 http.Server
    gserver := graceful.NewServer(server, logger)
  
    // 设置重启信号  kill -USR1 {pid}
    graceful.RegisterRestartSignal(syscall.SIGUSR1)
  
    // 设置关闭信号 ctrl+c 或者 cmd+c
    graceful.RegisterCloseSignal(syscall.SIGINT)
  
    // 设置退出超时时间，默认 5 秒
    graceful.SetShutdownTimeout(3)
  
    // 注册清理函数，比如资源回收，先注册的函数先调用
    graceful.RegisterShutdownHandler(func() {
        // close mysql ..
    })
     graceful.RegisterShutdownHandler(func() {
        // some other work
    })
  
    // 监听信号
    graceful.ListenSignal()
  
    // 启动服务器，接受连接
    err := gserver.ListenAndServe(addr)
    if err != nil {
        if err == http.ErrServerClosed {
            logger.Info("server closed")
        } else {
            logger.Error(err.Error())
        }
    }
  }
  

Documentation

Index

• func Close()
• func ListenSignal()
• func RegisterCloseSignal(sig ...os.Signal) error
• func RegisterRestartSignal(sig ...os.Signal) error
• func RegisterShutdownHandler(f func()) error
• func Restart()
• func SetShutdownTimeout(timeout int)
• func Shutdown()
• type Server
  • func NewServer(handler http.Handler, logger logger.Logger) *Server
  • func (server *Server) ListenAndServe(addr string) error
  • func (server *Server) ListenAndServeTLS(addr, certFile, keyFile string) error

Functions

func Close

func Close()

Close 直接关闭服务器

func ListenSignal

func ListenSignal()

ListenSignal 监听信号

func RegisterCloseSignal

func RegisterCloseSignal(sig ...os.Signal) error

RegisterCloseSignal 设置响应关闭的信号，接收到信号之后会优雅的关闭服务器 如果没有设置，会默认使用 SIGINT，SIGTERM

sig: 退出信号

func RegisterRestartSignal

func RegisterRestartSignal(sig ...os.Signal) error

RegisterRestartSignal 设置响应重启的信号，接收到信号之后会优雅的重启服务器 如果没有设置，会默认使用 SIGUSR1，SIGUSR2

sig: 重启信号

func RegisterShutdownHandler

func RegisterShutdownHandler(f func()) error

RegisterShutdownHandler 注册关闭函数 按照注册的顺序调用这些函数 所有已经添加的服务器都会响应这个函数

func Restart

func Restart()

Restart ..

func SetShutdownTimeout

func SetShutdownTimeout(timeout int)

SetShutdownTimeout 设置优雅退出超时时间 服务器会每隔500毫秒检查一次连接是否都断开处理完毕 如果超过超时时间，就不再检查，直接退出 如果要单独给指定的服务器设置 超时时间，可以使用 WithTimeout

timeout: 单位：秒，当 <= 0 时无效，直接退出

func Shutdown

func Shutdown()

Shutdown 优雅关闭服务器 关闭监听 执行之前注册的关闭函数(RegisterShutdownHandler)，可以用于清理资源等 关闭空闲连接，等待激活的连接变为空闲，再关闭它

Types

type Server

type Server struct {
	*http.Server
	// contains filtered or unexported fields
}

Server 替代 http.Server

func NewServer

func NewServer(handler http.Handler, logger logger.Logger) *Server

NewServer 生成服务器，用来替代 `http.Server`

func (*Server) ListenAndServe

func (server *Server) ListenAndServe(addr string) error

ListenAndServe 用于替代 `http.Server.ListenAndServe`

func (*Server) ListenAndServeTLS

func (server *Server) ListenAndServeTLS(addr, certFile, keyFile string) error

ListenAndServeTLS 用于替代 `http.Server.ListenAndServeTLS`