针对项目部署后因配置变更或功能迭代重启服务的需求,Gin框架借助Go1.8内置的http.Server.Shutdown()方法实现优雅关机。通过捕获SIGINT和SIGTERM信号,等待当前请求处理完毕后再关闭服务器,避免强制终止导致请求中断。
项目部署上线后,免不了因配置变更或功能迭代需要重启服务。直接使用kill -9 pid虽然干脆,但正在处理的请求会中断。有没有更体面的做法?

长期稳定更新的攒劲资源: >>>点此立即查看<<<
阅读本文需要了解UNIX系统中信号的基本概念,请提前查阅资料预习。
所谓优雅关机,直白地说就是在关机命令发出后不立即退出,而是等待当前正在处理的请求全部完成后才停止。相比之下,Ctrl+C强制结束会直接中断正在访问的请求,显然不够友好。
Go 1.8版本之后,http.Server内置的Shutdown()方法支持优雅关机。具体实现代码如下:
// +build go1.8
package main
import (
"context"
"log"
"net/http"
"os"
"os/signal"
"syscall"
"time"
"github.com/gin-gonic/gin"
)
func main() {
router := gin.Default()
router.GET("/", func(c *gin.Context) {
time.Sleep(5 * time.Second)
c.String(http.StatusOK, "Welcome Gin Server")
})
srv := &http.Server{
Addr: ":8080",
Handler: router, // 将router注册到server里面
}
go func() {
// 开启一个goroutine启动服务
// 如果不开启ListenAndServe就会一直接收请求处理请求,代码就不会往下执行
if err := srv.ListenAndServe(); err != nil && err != http.ErrServerClosed {
log.Fatalf("listen: %sn", err)
}
}()
// 等待中断信号来优雅地关闭服务器,为关闭服务器操作设置一个5秒的超时
quit := make(chan os.Signal, 1) // 创建一个接收信号的通道
// 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秒超时的context
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
// 5秒内优雅关闭服务(将未处理完的请求处理完再关闭服务),超过5秒就超时退出
if err := srv.Shutdown(ctx); err != nil {
log.Fatal("Server Shutdown: ", err)
}
log.Println("Server exiting")
}
如何验证效果?上述代码运行后,本地8080端口启动一个Web服务,仅注册了/路由,后端会先sleep 5秒再返回响应。操作步骤如下:
127.0.0.1:8080/,此时页面白屏,等待服务端响应;Ctrl+C,发送syscall.SIGINT信号;优雅关机实现了,那优雅重启呢?
可以使用fvbock/endless替换默认的ListenAndServe启动服务。示例代码如下:
package main
import (
"log"
"net/http"
"time"
"github.com/fvbock/endless"
"github.com/gin-gonic/gin"
)
func main() {
router := gin.Default()
router.GET("/", func(c *gin.Context) {
time.Sleep(5 * time.Second)
c.String(http.StatusOK, "hello gin!")
})
// 默认endless服务器会监听下列信号:
// syscall.SIGHUP,syscall.SIGUSR1,syscall.SIGUSR2,syscall.SIGINT,syscall.SIGTERM和syscall.SIGTSTP
// 接收到 SIGHUP 信号将触发`fork/restart` 实现优雅重启(kill -1 pid会发送SIGHUP信号)
// 接收到 syscall.SIGINT或syscall.SIGTERM 信号将触发优雅关机
// 接收到 SIGUSR2 信号将触发HammerTime
// SIGUSR1 和 SIGTSTP 被用来触发一些用户自定义的hook函数
if err := endless.ListenAndServe(":8080", router); err!=nil{
log.Fatalf("listen: %sn", err)
}
log.Println("Server exiting")
}
补充:
# 将main.go运行起来 go run main.go # 假设你当前在 graceful_restart_demo 目录下执行 go build # 生成的可执行文件叫 graceful_restart_demo # 指定程序名 go build -o graceful_restart # -o 是 output(输出)的缩写,用来指定生成的文件的名字。这里指定了生成的程序名叫 graceful_restart # 直接可以将这个可执行文件运行起来 ./graceful_restart
如何验证优雅重启?通过执行kill -1 pid发送syscall.SIGHUP信号通知程序优雅重启。具体操作:
go build -o graceful_restart并运行./graceful_restart,记住输出的PID(假设为43682);hello gin!改成hello q1mi!,再次编译go build -o graceful_restart;127.0.0.1:8080/,页面白屏等待响应;kill -1 43682,发送syscall.SIGHUP信号;hello gin!后,再次访问127.0.0.1:8080/,会收到hello q1mi!的响应。需要注意的是,此时程序的PID会发生变化。因为endless通过fork子进程处理新请求,待原进程处理完当前请求后再退出。如果项目使用类似supervisor的软件管理进程,这种方式就不适用了。
无论是优雅关机还是优雅重启,核心都是监听特定系统信号,然后执行相应逻辑,确保当前正在处理的请求正常完成后再关闭进程。具体选用哪种方式、如何实现,需要根据项目实际情况决定。
侠游戏发布此文仅为了传递信息,不代表侠游戏网站认同其观点或证实其描述