Go实现Gin服务优雅关机

软件开发大郭
0 评论
/
7 阅读
/
2354 字
22 2023-11
分类:

无论是优雅关机还是优雅重启归根结底都是通过监听特定系统信号,然后执行一定的逻辑处理保障当前系统正在处理的请求被正常处理后再关闭当前进程。

优雅关机

优雅关机就是服务端关机命令发出后不是立即关机,而是等待当前还在处理的请求全部处理完毕后再退出程序,是一种对客户端友好的关机方式。注:如果是执行Ctrl+C关闭服务端时,仍会强制结束进程导致正在访问的请求出现问题。

Gin优雅关机

Gin是不带优雅关机功能的,但Go 1.8版本之后, http.Server 内置的 Shutdown() 方法就支持优雅地关机,所以可以先将Gin的路由封装为一个http.Server。

说明一下Shutdown工作的机制:当程序检测到中断信号时,我们调用http.server种的shutdown方法,该方法将阻止新的请求进来,同时保持当前的连接,知道当前连接完成则终止程序!

代码实现

package main
 
import (
    "context"
    "log"
    "net/http"
    "os"
    "os/signal"
    "syscall"
    "time"
 
    "github.com/gin-gonic/gin"
)
 
func main() {
    // 创建 Gin 实例
    router := gin.Default()
 
    // 添加路由
    router.GET("/", func(c *gin.Context) {
        c.String(http.StatusOK, "Hello, World! weiyigeek.top")
    })
 
    // 创建 HTTP Server
    srv := &http.Server{
        Addr:    ":8080",
        Handler: router,
    }
 
  // 开启一个goroutine启动服务 启动 HTTP Server
    go func() {
        if err := srv.ListenAndServe(); err != nil && err != http.ErrServerClosed {
            log.Fatalf("listen: %s\n", err)
        }
    }()
 
    // 等待中断信号
    quit := make(chan os.Signal)
    // kill 默认会发送 syscall.SIGTERM 信号
    // kill -2 发送 syscall.SIGINT 信号,我们常用的Ctrl+C就是触发系统SIGINT信号
    // kill -9 发送 syscall.SIGKILL 信号,但是不能被捕获,所以不需要添加它
    // signal.Notify把收到的 syscall.SIGINT或syscall.SIGTERM 信号转发给quit
    signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM) // 此处不会阻塞
    <-quit    // 阻塞在此,当接收到上述两种信号时才会往下执行
    log.Println("Shutdown Server ...")
 
    // 创建一个 5 秒的超时上下文
    ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
    defer cancel()
 
    // 关闭 HTTP Server
  //     // 5秒内优雅关闭服务(将未处理完的请求处理完再关闭服务),超过5秒就超时退出
    if err := srv.Shutdown(ctx); err != nil {
        log.Fatal("Server Shutdown:", err)
    }
    log.Println("Server exiting")
}

代码说明

首先创建了一个Gin实例和一个HTTP Server,然后启动HTTP Server。 接下来,使用signal.Notify()函数监听中断信号(SIGINT和SIGTERM),当接收到中断信号时,服务器会进入优雅关闭流程,即先关闭HTTP Server,然后等待5秒钟, 最后退出程序。

在关闭HTTP Server时,我们使用了srv.Shutdown()函数,它会优雅地关闭HTTP Server并等待所有连接关闭。如果在5秒钟内没有关闭完所有连接,函数会返回错误。

标签:
    暂无数据