Go项目实现优雅关机与平滑重启

Demo快速上手

优雅关机

package main

import (
	"context"
	"github.com/gin-gonic/gin"
	"log"
	"net/http"
	"os"
	"os/signal"
	"syscall"
	"time"
)

// 实现优雅关机和平滑重启
func main() {
	router := gin.Default()
	router.GET("/", func(c *gin.Context) {
		// 这个10秒的延时。是为了演示操作方便，实际上线一定注释掉
		time.Sleep(time.Second * 10)
		c.String(http.StatusOK, "hello xiaosheng")
	})
	srv := &http.Server{
		Addr:    ":8080",
		Handler: router,
	}
	// 必须开启一个go routine 因为如果不开起，下面会一直listen and serve,进入死循环
	// err != http.ErrServerClosed这个很重要
	go func() {
		// 开启一个goroutine启动服务
		if err := srv.ListenAndServe(); err != nil && err != http.ErrServerClosed {
			log.Fatalf("listen : %s\n", err)
		}
	}()
	// 等待中断信号来优雅关掉服务器， 为关闭服务器做一个5秒的延时
	quit := make(chan os.Signal, 1)
	// kill 默认会发送syscall.SIGTREN信号
	// kill -2发送syscall.SIGINT信号，我们常用的ctrl+c就是触发系统SIGINT信号
	// kill -9发送syscall.SIGKILL信号，但是不能被捕获，所以不需要添加他
	// signal.Notify把收到的syscall.SIGINT或syscall.SIGTREN信号传给quit
	signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM) // 此处不会阻塞
	<-quit                                               // 阻塞在此，当收到上述两种信号的时候才会往下执行
	log.Println("ShutDown Server ...")
	// 创建一个5秒超时的context
	ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)
	defer cancel()
	// 5秒内优雅关闭服务， （将未处理完的请求处理完再关闭服务）， 超过5秒就退出
	if err := srv.Shutdown(ctx); err != nil {
		log.Fatal("shut down:", err)
	}
	log.Println("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) {
		// 这个5秒的延时。是为了演示操作方便，实际上线一定注释掉
		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: %s\n", err)
	}

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

Detail

优雅关机

服务端关机命令发出后不立即关机，而是等待当前还在处理的请求全部处理完毕后再退出程序，这样是一种对客户端友好的关机方式。
执行Ctrl+C时，会强制结束进程，这样导致正在访问的请求出现问题。
Go 1.8版本之后， http.Server内置的 Shutdown()方法就支持优雅关机

流程

8080端口开启了一个web服务，并且只注册了一条路由,“/”， 但客户端访问127.0.0.1:8080/时，过10秒才会响应，如果这时我们按下ctrl+c，给程序发送syscall.SIGINT信号，他会等待10秒将当前请求处理完，他才会消亡，当然也取决于创建的5秒的context超时时间。

平滑重启

可以使用fvbock/endless 来替换默认的 ListenAndServe启动服务来实现

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) {
		// 这个5秒的延时。是为了演示操作方便，实际上线一定注释掉
		time.Sleep(5 * time.Second)
		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\n", err)
	}

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

流程

• 在终端执行go build -o graceful_restart编译，并执行./graceful_restart,终端输出当前pid(假设为44444)
• 将代码中处理请求函数返回的hello xiaosheng!修改为hello world!，再次编译go build -o graceful_restart
• 打开浏览器访问127.0.0.1:8080/，此时客户端浏览器等待服务端返回响应。
• 在终端执行kill -1 44444命令给程序发送syscall.SIGHUP重启信号
• 等第3步客户端浏览器收到响应信息hello xiaosheng!后，再次访问127.0.0.1:8080/会收到hello world!的响应。

这样做在不影响当前未处理完请求的同时完成了程序代码的替换，实现了平滑重启。但实际上用的不多，因为实际都是多台服务器，或者说有类似supervisor的软件管理进程时就不适用这种方式,因为他进程pid变了，他自己重启和supervisor的软件管理进程给他重启就冲突了。