go如何优雅关闭Graceful Shutdown服务

更新时间：2023年05月15日 08:55:12 作者：cainmusic

这篇文章主要为大家介绍了go优雅关闭Graceful Shutdown服务详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪

Shutdown方法

Go1.8之后有了Shutdown方法，用来优雅的关闭（Graceful Shutdown）服务。

func (srv *Server) Shutdown(ctx context.Context) error

这个方法会在调用时进行下述操作：

1.关闭所有open listeners

2.关闭所有idle connections

3.无限期等待connections回归idle状态

4.之后关闭服务

注：3的无限期等待可以用context的超时来解决。

RegisterOnShutdown方法

Go1.9之后有了RegisterOnShutdown方法，用来在优雅的关闭服务的同时处理一些退出任务。

func (srv *Server) RegisterOnShutdown(f func())

关于RegisterOnShutdown如何生效，我们看代码。

type Server struct {
    ...
    onShutdown []func()
}

func (srv *Server) RegisterOnShutdown(f func()) {
    srv.mu.Lock()
    srv.onShutdown = append(srv.onShutdown, f)
    srv.mu.Unlock()
}

func (srv *Server) Shutdown(ctx context.Context) error {
    ...

    srv.mu.Lock()
    ...
    for _, f := range srv.onShutdown {
        go f()
    }
    srv.mu.Unlock()

    ...
}

由代码可知，在通过RegisterOnShutdown进行注册之后，这些函数被放入一个函数切片中，并在Shutdown被调用的时候，为每个函数启动了一个goroutine进行处理。

但由于没有进行后续处理，于是这里有个小问题，Shutdown是不等待这些处理函数结束的，就可能比这些处理函数先完成并进而结束程序。

package main
import (
    "context"
    "log"
    "net/http"
    "os"
    "os/signal"
    "time"
)
func main() {
    var srv http.Server
    srv.RegisterOnShutdown(func() {
        time.Sleep(3 * time.Second)
        log.Println("Exit func")
    })
    idleConnsClosed := make(chan struct{})
    go func() {
        sigint := make(chan os.Signal, 1)
        signal.Notify(sigint, os.Interrupt)
        <-sigint
        // We received an interrupt signal, shut down.
        if err := srv.Shutdown(context.Background()); err != nil {
            // Error from closing listeners, or context timeout:
            log.Printf("HTTP server Shutdown: %v", err)
        }
        close(idleConnsClosed)
    }()
    if err := srv.ListenAndServe(); err != http.ErrServerClosed {
        // Error starting or closing listener:
        log.Fatalf("HTTP server ListenAndServe: %v", err)
    }
    <-idleConnsClosed
}

运行时Ctrl+c之后，服务立刻结束了，并未等待log.Println("Exit func")的输出。

sync.WaitGroup处理退出函数

为了解决这个问题我们使用sync.WaitGroup来处理这些退出函数，于是我们有了下面的代码（解耦并增加了一些日志）：

package main
import (
    "context"
    "log"
    "net/http"
    "os"
    "os/signal"
    "sync"
    "time"
)
func main() {
    var srv http.Server
    var wg sync.WaitGroup
    register := func(f func()) {
        wg.Add(1)
        log.Println("Exit func register")
        srv.RegisterOnShutdown(func() {
            defer wg.Done()
            f()
            log.Println("Exit func done")
        })
    }
    register(func() {
        time.Sleep(3 * time.Second)
        log.Println("Called on Shutdown")
    })
    idleConnsClosed := make(chan struct{})
    go func() {
        sigint := make(chan os.Signal, 1)
        signal.Notify(sigint, os.Interrupt)
        <-sigint
        // We received an interrupt signal, shut down.
        log.Println("Shutdown start")
        if err := srv.Shutdown(context.Background()); err != nil {
            // Error from closing listeners, or context timeout:
            log.Printf("HTTP server Shutdown: %v", err)
        }
        close(idleConnsClosed)
    }()
    if err := srv.ListenAndServe(); err != http.ErrServerClosed {
        // Error starting or closing listener:
        log.Fatalf("HTTP server ListenAndServe: %v", err)
    }
    <-idleConnsClosed
    log.Println("Shutdown finish")
    wg.Wait()
}

我们在RegisterOnShutdown时使用了time.Sleep(3 * time.Second)来模拟一个长时间的退出程序，并且在"Shutdown finish"之后进行等待，等待退出程序完成任务。

执行日志如下：

2023/05/12 16:48:53 Exit func register
^C2023/05/12 16:48:54 Shutdown start
2023/05/12 16:48:54 Shutdown finish
2023/05/12 16:48:57 Called on Shutdown
2023/05/12 16:48:57 Exit func done

可以看到这个服务本身很轻，Shutdown start之后立刻就finish并来到wg.Wait()，并等待register的函数完成之后再退出程序。

另外，如果在服务运行的过程中需要启动一些其他的任务，也可以使用

wg.Add(1)
go func() {
    defer wg.Done()
    ...
}

来保证任务在服务Shutdown之后可以顺利完成。

以上就是go如何优雅关闭Graceful Shutdown服务的详细内容，更多关于go关闭Graceful Shutdown的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

浅析Go语言中的栈和先进先出原则
这篇文章主要来和大家探讨一样如何在Go语言中实现和使用堆栈，以及堆栈如何遵循先进先出 (FIFO) 原则，文中的示例代码简洁易懂，需要的可以参考一下
2023-07-07
Golang学习笔记之安装Go1.15版本(win/linux/macos/docker安装)
这篇文章主要介绍了Golang学习笔记之安装Go1.15版本(win/linux/macos/docker安装),本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2020-12-12
一文掌握Golang模糊测试
本文主要介绍了一文掌握Golang模糊测试，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-06-06
go reflect要不要传指针原理详解
这篇文章主要为大家介绍了go reflect要不要传指针原理详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-01-01
go日志库中的logrus
这篇文章主要介绍了go日志库中的logrus主要包括go日志库logrus的安装和使用，本文通过实例代码给大家介绍的非常详细,需要的朋友可以参考下
2022-08-08
golang实现整型和字节数组之间的转换操作
这篇文章主要介绍了golang实现整型和字节数组之间的转换操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-12-12
go使用SQLX操作MySQL数据库的教程详解
sqlx 是 Go 语言中一个流行的操作数据库的第三方包,它提供了对 Go 标准库 database/sql 的扩展,简化了操作数据库的步骤,下面我们就来学习一下go如何使用SQLX实现MySQL数据库的一些基本操作吧
2023-11-11
Go作用域的理解
在Go语言中,作用域是指变量的可见性范围,它定义了变量在程序中的生命周期和可访问性,本文主要介绍了Go作用域的理解,包括局部作用域、全局作用域、命名空间作用域等,感兴趣的可以了解一下
2023-11-11
go mod tidy报错:zip: not a valid zip file解决办法
这篇文章主要给大家介绍了关于go mod tidy报错:zip: not a valid zip file的解决办法,go mod是进行代码管理，这错误是因为本地分支和远程分支冲突,本文通过代码介绍的非常详细,需要的朋友可以参考下
2024-01-01
Golang中Append()使用实例详解
今天在刷leetcode的时候,第113题让我遇到了一个Go语言中append函数的一个坑,所以复习下,这篇文章主要给大家介绍了关于Golang中Append()使用的相关资料,需要的朋友可以参考下
2023-01-01