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的资料请关注脚本之家其它相关文章!

相关文章

  • Golang回调函数与闭包和接口函数的定义及使用介绍

    Golang回调函数与闭包和接口函数的定义及使用介绍

    这篇文章主要介绍了Golang回调函数与闭包和接口函数的定义及使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习吧
    2023-05-05
  • Golang常见错误之值拷贝和for循环中的单一变量详解

    Golang常见错误之值拷贝和for循环中的单一变量详解

    这篇文章主要给大家介绍了关于Golang常见错误之值拷贝和for循环中单一变量的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧。
    2017-11-11
  • GO 切片删除元素的三种方法

    GO 切片删除元素的三种方法

    本文主要介绍了GO 切片删除元素,根据要删除元素的位置有三种情况,分别是从开头位置删除、从中间位置删除和从尾部删除,具有一定的参考价值,感兴趣的可以了解一下
    2024-08-08
  • 破解IDEA(Goland)注册码设置 license server一直有效不过期的过程详解

    破解IDEA(Goland)注册码设置 license server一直有效不过期的过程详解

    这篇文章主要介绍了破解IDEA(Goland)注册码设置 license server一直有效不过期,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-11-11
  • PHP结构型模式之组合模式

    PHP结构型模式之组合模式

    这篇文章主要介绍了PHP组合模式Composite Pattern优点与实现,组合模式是一种结构型模式,它允许你将对象组合成树形结构来表示“部分-整体”的层次关系。组合能让客户端以一致的方式处理个别对象和对象组合
    2023-04-04
  • Golang 文件操作:删除指定的文件方式

    Golang 文件操作:删除指定的文件方式

    这篇文章主要介绍了Golang 文件操作:删除指定的文件方式,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-04-04
  • 一文详解Golang的模块版本管理与语义版本控制

    一文详解Golang的模块版本管理与语义版本控制

    在Golang中,模块(module)是Go 1.11版本引入的依赖管理系统,帮助开发者管理项目的依赖,在Go模块推出之前,开发者通常使用GOPATH和vendor目录来管理项目的依赖,本文将给大家详细介绍Golang的模块版本管理与语义版本控制,需要的朋友可以参考下
    2023-12-12
  • golang使用go test输出单元测试覆盖率的方式

    golang使用go test输出单元测试覆盖率的方式

    单元测试覆盖率是衡量代码质量的一个重要指标,重要的代码文件覆盖率应该至少达到80%以上,Java 可以通过JaCoCo 统计覆盖率,那么go 项目如何进行代码覆盖率测试呢,本文将给大家详细的介绍一下golang使用go test输出单元测试覆盖率的方式,需要的朋友可以参考下
    2024-02-02
  • Golang字符串类型原理及其使用方法

    Golang字符串类型原理及其使用方法

    本文主要介绍了Golang字符串类型原理及其使用方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-09-09
  • go语言执行等待直到后台goroutine执行完成实例分析

    go语言执行等待直到后台goroutine执行完成实例分析

    这篇文章主要介绍了go语言执行等待直到后台goroutine执行完成的方法,实例分析了Go语言中WaitGroup的使用技巧,需要的朋友可以参考下
    2015-03-03

最新评论