18. Go实现Gin服务优雅关机与重启

百里守约学编程

已于 2024-12-24 19:55:52 修改

阅读量822

点赞数

CC 4.0 BY-SA版权

分类专栏： go 文章标签： golang gin

于 2023-09-26 16:52:49 首次发布

本文链接：https://blog.youkuaiyun.com/YouMing_Li/article/details/133315270

go 专栏收录该内容

172 篇文章

订阅专栏

文章目录

优雅关机
更通用的优雅关闭写法
优雅重启

代码地址： https://gitee.com/lymgoforIT/golang-trick/tree/master/46-graceful-shutdown

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

优雅关机

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

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秒钟内没有关闭完所有连接，函数会返回错误。

更通用的优雅关闭写法

目录结构如下
在这里插入图片描述
我们可以专门写一个包和文件，管理所有需要优雅关闭的函数，如listener.go

package listeners

import (
	"log"
	"sync"
	"sync/atomic"
	"time"
)

var ServerCloseState uint32

type ServerCloseListener func()

var listeners []ServerCloseListener
var listenersRegisterLock sync.Mutex

func RegisterServerCloseListener(listener ServerCloseListener) {
	listenersRegisterLock.Lock()
	defer listenersRegisterLock.Unlock()
	listeners = append(listeners, listener)
}

func IsServerClosed() bool {
	return atomic.LoadUint32(&ServerCloseState) == 1
}

func NotifyClosed() {
	atomic.StoreUint32(&ServerCloseState, 1)
	// 依次给每个需要优雅关闭的操作最多5秒的时间完成指定的操作
	for _, l := range listeners {
		safeShutdown(l)
	}
}

func safeShutdown(listener ServerCloseListener) {
	defer func() {
		if err := recover(); err != nil {
			log.Fatalf("shut down panic %v", err)
		}
	}()
	done := make(chan bool)
	go func() {
		listener()
		done <- true
	}()
	select {
	case <-done:

	case <-time.After(5 * time.Second):
	}
}

上述代码定义了注册需要优雅关闭操作的入口，在程序要退出时，依次给每个需要优雅关闭的操作最多5秒的时间完成指定的操作。

使用：

package main

import (
	"context"
	"github.com/gin-gonic/gin"
	"golang-trick/46-graceful-shutdown/listeners"
	"log"
	"net/http"
	"os"
	"os/signal"
	"syscall"
	"time"
)

type Server struct {
	*http.Server
}

func main() {
	// 创建 Gin 实例
	router := gin.Default()

	// 添加路由
	router.GET("/", func(c *gin.Context) {
		c.String(http.StatusOK, "Hello, World! weiyigeek.top")
	})

	// 创建 HTTP Server,为了让srv可以设置优雅关闭函数ginGracefulShutdown，我们封装了一下
	srv := &Server{
		Server: &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)
		}
	}()

	// 注册关闭监听器
	listeners.RegisterServerCloseListener(srv.ginGracefulShutdown)

	// 等待中断信号
	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 ...")
	listeners.NotifyClosed()
	log.Println("Server exiting")
}

func (srv *Server) ginGracefulShutdown() {
	// 注意：优雅关闭listener那边超时时间是5秒，这里实际3秒就会返回啦，那边5秒是可能还注册了其他需要优雅关闭的操作，统一设置的5秒
	// 比如项目中用了协程池，优雅关闭时，可能给5秒的时间，让所有已经进入协程池的任务跑完，而使用listeners.IsServerClosed()控制不让新的任务加入协程池
	// 创建一个 3 秒的超时上下文
	ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
	defer cancel()

	// 关闭 HTTP Server
	// 	3秒内优雅关闭服务（将未处理完的请求处理完再关闭服务），超过5秒就超时退出
	if err := srv.Shutdown(ctx); err != nil {
		log.Fatal("Server Shutdown:", err)
	}
}