如何在 Golang 中优雅地关闭 HTTP 服务器

PHPz

发布时间：2023-03-22 14:23:50

2856人浏览过

来源于php中文网

原创

golang (又称为 go) 是一门相对比较年轻的编程语言，它被广泛应用于后端服务和 api 的开发中。而 http 是一个常用的协议，很多 golang 开发人员会选择使用 golang 中自带的 http 包来进行 http 服务器的开发。然而，当我们需要关闭 http 服务器时会遇到一些问题。在本文中，我们将介绍如何在 golang 中优雅地关闭 http 服务器。

HTTP 服务器的关闭方式

在 Golang 中，我们通常使用 http.ListenAndServe() 函数来启动 HTTP 服务器。该函数会一直运行直到程序被杀死或服务器关闭。如果我们直接关闭程序，HTTP 服务器就会立即停止运行。但是，这种方式并不是一个优雅的关闭方式，因为正在处理的客户端会被强制断开连接，这可能会导致数据丢失或异常。

另外一种关闭方式是使用服务端上下文（context）的 Done() 方法。当我们调用 Done() 方法时，HTTP 服务器会正确关闭并停止接受新的客户端连接，但仍会处理一些已经接受了的连接。这样虽然不会强制断开正在处理的客户端的连接，但仍可能会导致某些请求无响应的问题。

最后，我们还有一种优雅的关闭方式，即使用 http.Server 结构体中的 Shutdown() 方法。该方法会优雅地关闭 HTTP 服务器，即等待正在处理的请求处理完成后再关闭服务器。

实现 HTTP 服务器的优雅关闭

假设我们已经编写了以下代码用于启动 HTTP 服务器：

立即学习“go语言免费学习笔记（深入）”；

package main

import (
    "log"
    "net/http"
)

func main() {
    http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
        w.Write([]byte("Hello World!"))
    })

    if err := http.ListenAndServe(":8080", nil); err != nil {
        log.Fatal(err)
    }
}

现在我们需要在程序退出时正确关闭 HTTP 服务器。我们可以采用以下步骤：

1) 创建一个 http.Server 实例，并将该实例的 Handler 属性设置为我们现有的 Handler 函数。

腾讯AI 开放平台

腾讯AI开放平台

下载

server := http.Server{
    Addr:    ":8080",
    Handler: http.DefaultServeMux,
}

2) 使用一个 goroutine 来启动 http.Server 的 ListenAndServe() 方法，以处理客户端连接请求。

go func() {
    if err := server.ListenAndServe(); err != nil && err != http.ErrServerClosed {
        log.Fatal(err)
    }
}()

3) 在我们的程序退出时，使用 http.Server 的 Shutdown() 方法来安全地关闭服务器。

// 用于停止 HTTP 服务器的通道
stopChan := make(chan os.Signal)

// 监听 Interrupt 和 Terminate 信号
signal.Notify(stopChan, os.Interrupt, syscall.SIGTERM)

// 等待接收到信号，执行 Shutdown()
<-stopChan
log.Println("Shutting down server...")

// 等待处理完成的请求处理完成
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()

if err := server.Shutdown(ctx); err != nil {
    log.Fatal(err)
}

log.Println("Server gracefully stopped.")

这段代码中我们首先创建了一个通道，用于监听操作系统发送的中断或终止信号（比如 Ctrl + C）。然后我们等待接收到信号，执行 Shutdown() 方法。在调用 Shutdown() 方法之前，我们使用 context.WithTimeout() 创建了一个上下文（Context），用于在规定的超时时间内等待正在处理的请求处理完成。待所有请求处理完成后，Shutdown() 方法能够安全地关闭 HTTP 服务器。