«

Go如何实现优雅关机与平滑重启功能

时间:2024-4-10 10:24     作者:韩俊     分类: Go语言


这篇“Go如何实现优雅关机与平滑重启功能”文章的知识点大部分人都不太理解,所以小编给大家总结了以下内容,内容详细,步骤清晰,具有一定的借鉴价值,希望大家阅读完这篇文章能有所收获,下面我们一起来看看这篇“Go如何实现优雅关机与平滑重启功能”文章吧。

什么是优雅关机?

优雅关机就是服务端关机命令发出后不是立即关机,而是等待当前还在处理的请求全部处理完毕后再退出程序,是一种对客户端友好的关机方式。而执行

Ctrl+C
关闭服务端时,会强制结束进程导致正在访问的请求出现问题。

实现原理

Go 1.8版本之后, http.Server 内置的 Shutdown() 方法就支持优雅地关机,说明一下Shutdown工作的机制:当程序检测到中断信号时,我们调用http.server种的shutdown方法,该方法将阻止新的请求进来,同时保持当前的连接,知道当前连接完成则终止程序!

实现优雅重启

package main

import (
    "context"
    "fmt"
    "github.com/spf13/viper"
    "go.uber.org/zap"
    "log"
    "net/http"
    "os"
    "os/signal"
    "syscall"
    "time"
)

func main() {
    //启动服务(优雅关机)
    srv := &http.Server{
        Addr:    fmt.Sprintf(":%d", viper.GetInt("app.port")),
        Handler: r,
    }
    go func() {
        // 开启一个goroutine启动服务
        if err := srv.ListenAndServe(); err != nil && err != http.ErrServerClosed {
            log.Fatalf("listen: %s
", 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                                               // 阻塞在此,当接收到上述两种信号时才会往下执行
    zap.L().Info("Shutdown Server ...")
    // 创建一个5秒超时的context
    ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
    defer cancel()
    // 5秒内优雅关闭服务(将未处理完的请求处理完再关闭服务),超过5秒就超时退出
    if err := srv.Shutdown(ctx); err != nil {
        zap.L().Fatal("Server Shutdown: ", zap.Error(err))
    }
    zap.L().Info("Server exiting")
}

实现平滑重启

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) {
        c.String(http.StatusOK, "hello xiaosheng !")
    })
    // 默认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: %s
", err)
    }

    log.Println("Server exiting...")

测试

我们通过执行kill -1 pid命令发送syscall.SIGINT来通知程序优雅重启,具体做法如下:

  • 打开终端,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信号

  • 等第3步浏览器收到响应信息hello gin!后再次访问127.0.0.1:8080/会收到hello q1mi!的响应。

  • 在不影响当前未处理完请求的同时完成了程序代码的替换,实现了优雅重启。

但是需要注意的是,此时程序的PID变化了,因为endless 是通过fork子进程处理新请求,待原进程处理完当前请求后再退出的方式实现优雅重启的。所以当你的项目是使用类似supervisor的软件管理进程时就不适用这种方式了。

标签: golang

热门推荐