【Go Web开发】执行优雅停止

上一篇文章我们实现了服务拦截信号,但还没有对拦截后做任何处理,其实也没有多大用处!在本节中,我们将更新应用程序,对截获的SIGINT和SIGTERM信号触发API服务的安全关闭。

具体地说,在接收到任意一个可捕获的终止信号之后,我们将调用HTTP服务器的Shutdown()方法。官方文件对此作了如下描述:

Shutdown优雅地关闭服务器,而不会中断任何正在处理的连接。Shutdown的工作方式是,首先关闭所有打开的侦听器,然后关闭所有空闲连接,最后无限期地等待连接返回空闲状态并关闭。

用文字是很难表达其实现方式的,因此让我们进入代码,并在过程中讨论细节。

File:cmd/api/server.go


package main

...

func (app *application) server() error {
    srv := &http.Server{
        ErrorLog:     log.New(app.logger, "", 0),
        Addr:         fmt.Sprintf(":%d", app.config.port),
        Handler:      app.routes(),
        IdleTimeout:  time.Minute,
        ReadTimeout:  10 * time.Second,
        WriteTimeout: 30 * time.Second,
    }
        //创建shutdownErr通道,用于接收Shutdown()函数返回的错误
    shutdownError := make(chan error)

    go func() {
        quit := make(chan os.Signal, 1)
        signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
        s := <-quit
        //打印服务器关闭日志
        app.logger.Info("shutting down server", map[string]string{
            "signal": s.String(),
        })
        //创建一个过期时间5s的上下文实例
        ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
        defer cancel()
   
        //调用http.Server的Shutdown()方法,并传入ctx实例。如果正常关闭返回nil,否则返回错误。
        //错误原因可能是关闭监听器报错或在5s内没有正常关闭,将错写入shutdownErr传入main函数处理
        shutdownError <- srv.Shutdown(ctx)
    }()
    app.logger.Info("starting server", map[string]string{
        "addr": srv.Addr,
        "env":  app.config.env,
    })
    //调用Shutdown()会导致ListenAndServe()立即返回http.ErrServerClosed错误。因此看到这个错误的话
    //表明发生优雅关闭。因此需要检查该错误类型,否则返回错误。
    err := srv.ListenAndServe()
    if !errors.Is(err, http.ErrServerClosed) {
        return err
    }
    //否则,等待Shutdown()返回值写入通道。如果有错误说明异常关闭返回错误。
    err = <-shutdownError
    if err != nil {
        return err
    }
    //到这里说明http服务被正常关闭,只需要打印关闭日志即可
    app.logger.Info("stopped server", map[string]string{
        "addr": srv.Addr,
    })
    return nil
}

乍一看这段代码似乎有点复杂,但是在逻辑上做了什么可以概括的非常简单:当程序收到SIGINT或SIGTERM信号,服务器停止接受任何新的HTTP请求,并给任何正在执行请求5秒“宽限期”,5s后应用程序终止。

有几个重要的细节需要注意:

  • Shutdown()方法不会等待任何后台任务完成,也不会关闭被劫持的长连接,比如WebSockets。相反,您需要实现自己的逻辑来协调这些细节的优雅关闭。我们将在后面介绍一些技巧。
  • 有一个开源bug,它对HTTP/2连接限制了宽限期为5秒。在Go中,HTTP/2自动支持HTTPS连接,所以如果你打算处理来自Go应用程序的HTTPS连接,那么(目前)明智的做法是为你的上下文超时设置一个5秒的宽限期。如果不是因为这个bug,我建议使用更长的宽限期(大约20秒)。

但是除了这些,现在我们的应用程序应该可以很好地工作。

为了演示说明,你可以在healthcheckHandler方法中添加sleep模拟连接处理延时:

File:cmd/api/healthcheck.go


package main

import (
    "net/http"
    "time"
)

//申明一个handler返回应用程序状态,操作环境和版本
func (app *application) healthcheckHandler(w http.ResponseWriter, r *http.Request) {
    env := envelope{
        "status": "available",
        "system_info": map[string]string{
            "environment": app.config.env,
            "version":     version,
        },
    }

    //添加4s延时
    time.Sleep(4 * time.Second)

    err := app.writeJSON(w, http.StatusOK, env, nil)
    if err != nil {
        app.serverErrorResponse(w, r, err)
    }
}

然后启动API服务器,并在另一个终端窗口中向healthcheck接口发出请求,并发出SIGTERM信号。

$  $ curl localhost:4000/v1/healthcheck & pkill -SIGTERM api

在服务器的日志中,你会立即看到一个“shutting down server”的消息在SIGTERM信号之后,类似如下:

$ go run ./cmd/api
{"level":"INFO","time":"2021-12-19T03:28:17Z","message":"database connection pool established"}
{"level":"INFO","time":"2021-12-19T03:28:17Z","message":"starting server","properties":{"addr":":4000","env":"development"}}
{"level":"INFO","time":"2021-12-19T03:28:32Z","message":"shutting down server","properties":{"signal":"terminated"}}

然后,在4s后请求处理完毕,我们的healthcheckHandler正常返回JSON响应,并且你会发现API服务在退出前打印日志“stopped server”消息。

$ go run ./cmd/api
{"level":"INFO","time":"2021-12-19T03:28:17Z","message":"database connection pool established"}
{"level":"INFO","time":"2021-12-19T03:28:17Z","message":"starting server","properties":{"addr":":4000","env":"development"}}
{"level":"INFO","time":"2021-12-19T03:28:32Z","message":"shutting down server","properties":{"signal":"terminated"}}
{"level":"INFO","time":"2021-12-19T03:28:36Z","message":"stopped server","properties":{"addr":":4000"}}

注意:4s的延时刚好在打印"shutting down server"日志和"stopped server"日志的时间戳中体现出来了。

因此,现在代码效果不错。当我们想要优雅地关闭应用程序时,可以通过发送一个SIGINT (Ctrl+C)或SIGTERM信号来实现。只要正在处理的请求不会超过5秒的时间能完成,我们的处理程序就有时间来完成它们的工作,客户端就会收到一个正确的HTTP响应。如果我们想要立即退出,而不是优雅地关闭,我们仍然可以通过发送SIGQUIT (Ctrl+)或SIGKILL信号来完成。

最后别忘了撤销healthcheckHandler添加的4s延时操作。

你可能感兴趣的:(【Go Web开发】执行优雅停止)