Golang实现程序优雅退出的方法详解

更新时间：2022年06月15日 15:40:05 作者：Mr.YF

项目开发过程中，随着需求的迭代，代码的发布会频繁进行，在发布过程中，Golang如何让程序做到优雅的退出？本文就来详细为大家讲讲

1. 背景

项目开发过程中，随着需求的迭代，代码的发布会频繁进行，在发布过程中，如何让程序做到优雅的退出？

为什么需要优雅的退出？

你的 http 服务，监听端口没有关闭，客户的请求发过来了，但处理了一半，可能造成脏数据。
你的协程 worker 的一个任务运行了一半，程序退出了，结果不符合预期。

如下我们以 http 服务，gRPC 服务，单独的 woker 协程为例子，一步步说明平滑关闭的写法。

2. 常见的几种平滑关闭

为了解决退出可能出现的潜在问题，平滑关闭一般做如下一些事情

关闭对外的监听端口，拒绝新的连接
关闭异步运行的协程
关闭依赖的资源
等待如上资源关闭
然后平滑关闭

2.1 http server 平滑关闭

原来的写法

// startHttpServer start http server
func startHttpServer() {
    mux := http.NewServeMux()
    // mux.Handle("/metrics", promhttp.Handler())
    if err := http.ListenAndServe(":1608", mux); err != nil {
        log.Fatal("startHttpServer ListenAndServe error: " + err.Error())
    }
}

带平滑关闭的写法

// startHttpServer start http server
func startHttpServer() {
    mux := http.NewServeMux()
    // mux.Handle("/metrics", promhttp.Handler())
    srv := &http.Server{
        Addr:    ":1608",
        Handler: mux,
    }
    // 注册平滑关闭，退出时会调用 srv.Shutdown(ctx)
    quit.GetQuitEvent().RegisterQuitCloser(srv)
    if err := srv.ListenAndServe(); err != nil {
        log.Fatal("startHttpServer ListenAndServe error: " + err.Error())
    }
}

把平滑关闭注册到http.Server的关闭函数中

// startHttpServer start http server
func startHttpServer() {
    mux := http.NewServeMux()
    // mux.Handle("/metrics", promhttp.Handler())
    srv := &http.Server{
        Addr:    ":1608",
        Handler: mux,
    }
    // 把平滑退出注册到http.Server中
    srv.RegisterOnShutdown(quit.GetQuitEvent().GracefulStop)
    if err := srv.ListenAndServe(); err != nil {
        log.Fatal("startHttpServer ListenAndServe error: " + err.Error())
    }
}

2.2 gRPC server 平滑关闭

原来的写法

// startGrpcServer start grpc server
func startGrpcServer() {
    listen, err := net.Listen("tcp", "0.0.0.0:9999")
    if err != nil {
        log.Fatalf("Failed to listen: %v", err)
        return
    }
    grpcServer := grpc.NewServer()
    // helloBoot.GrpcRegister(grpcServer)
    go grpcServer.Serve(listen)
    defer grpcServer.GracefulStop()
    // ...
}

带平滑关闭的写法　

// startGrpcServer start grpc server
func startGrpcServer() {
    listen, err := net.Listen("tcp", "0.0.0.0:9999")
    if err != nil {
        log.Fatalf("Failed to listen: %v", err)
        return
    }
    grpcServer := grpc.NewServer()
    // helloBoot.GrpcRegister(grpcServer)
    go grpcServer.Serve(listen)
    // 把 grpc 的GracefulStop注册到退出事件中
    quit.GetQuitEvent().RegisterStopFunc(grpcServer.GracefulStop)
    quit.WaitSignal()
}

2.3 worker 协程平滑关闭

单独的协程启停，可以通过计数的方式注册到退出事件处理器中。

1.启动协程增加计数

quit.GetQuitEvent().AddGoroutine()

2.停止协程减计数

quit.GetQuitEvent().DoneGoroutine()

3.常驻后台运行的协程退出的条件改成退出事件是否结束的条件

!quit.GetQuitEvent().HasFired()

4.常驻后台运行的协程若通过 select 处理 chan，同时增加退出事件的chan

case <-quit.GetQuitEvent().Done()

// myWorker my worker
type myWorker struct {
}
 
// RunWorkerWithChan run Goroutine worker
func (m *myWorker) RunWorkerWithChan() {
    // 启动一个Goroutine时，增加Goroutine数
    quit.GetQuitEvent().AddGoroutine()
    defer func() {
        // 一个Goroutine退出时，减少Goroutine数
        quit.GetQuitEvent().DoneGoroutine()
    }()
    // 退出时，此次退出
    for !quit.GetQuitEvent().HasFired() {
        select {
        // 退出时，收到退出信号
        case <-quit.GetQuitEvent().Done():
            break
            //case msg := <- m.YouChan:
            // handle msg
        }
    }
}
 
// RunWorker run Goroutine worker
func (m *myWorker) RunWorker() {
    // 启动一个Goroutine时，增加Goroutine数
    quit.GetQuitEvent().AddGoroutine()
    defer func() {
        // 一个Goroutine退出时，减少Goroutine数
        quit.GetQuitEvent().DoneGoroutine()
    }()
 
    // 退出时，此次退出
    for !quit.GetQuitEvent().HasFired() {
        // ...
    }
}

2.4 实现 io.Closer 接口的自定义服务平滑关闭

实现 io.Closer 接口的结构体，增加到退出事件处理器中

// startMyService start my service
func startMyService() {
    srv := NewMyService()
    // 注册平滑关闭，退出时会调用 srv.Close()
    quit.GetQuitEvent().RegisterCloser(srv)
    srv.Run()
}
 
// myService my service
type myService struct {
    isStop bool
}
 
// NewMyService new
func NewMyService() *myService {
    return &myService{}
}
 
// Close my service
func (m *myService) Close() error {
    m.isStop = true
    return nil
}
 
// Run my service
func (m *myService) Run() {
    for !m.isStop {
        // ....
    }
}

2.5 集成其他框架怎么做

退出信号处理由某一框架接管，寻找框架如何注册退出函数，优秀的框架一般都会实现安全实现退出的机制。

如下将退出事件注册到某一框架的平滑关闭函数中

func startMyServer() {
    // ...
    // xxx框架退出函数注册退出事件
    xxx.RegisterQuitter(func() {
        quit.GetQuitEvent().GracefulStop()
    })
}

以上就是Golang实现程序优雅退出的方法详解的详细内容，更多关于Golang程序退出的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

Go每日一库之zap日志库的安装使用指南
这篇文章主要为大家介绍了Go每日一库之zap安装使用示例学习，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-05-05
Golang实现web文件共享服务的示例代码
这篇文章主要介绍了Golang实现web文件共享服务的示例代码，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-10-10
golang 打印error的堆栈信息操作
这篇文章主要介绍了golang 打印error的堆栈信息操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2021-05-05
使用Go语言编写一个简单的Web框架
Go语言（又称Golang）因其高效的性能和简洁的语法,在编写Web框架方面表现出色,下面将详细介绍如何使用Go语言编写一个简单的Web框架,文中有详细的代码供大家参考,需要的朋友可以参考下
2024-05-05
一文带你搞懂Golang结构体内存布局
结构体在Go语言中是一个很重要的部分，在项目中会经常用到。这篇文章主要带大家看一下结构体在内存中是怎么分布的？通过对内存布局的了解，可以帮助我们写出更优质的代码。感兴趣的小伙伴们可以参考借鉴，希望对大家能有所帮助
2022-10-10
golang使用sync.singleflight解决热点缓存穿透问题
在go的sync包中，有一个singleflight包，里面有一个 singleflight.go文件，代码加注释，一共200行出头，通过 singleflight可以很容易实现缓存和去重的效果，避免重复计算，接下来我们就给大家详细介绍一下sync.singleflight如何解决热点缓存穿透问题
2023-07-07
go语言搬砖之go jmespath实现查询json数据
这篇文章主要为大家介绍了go语言搬砖之go jmespath实现查询json数据，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-06-06
详解如何在Golang中执行shell命令
这篇文章主要为大家详细介绍了在 golang 中执行 shell 命令的多种方法和场景,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
2024-02-02
Go语言学习之goroutine详解
Goroutine是建立在线程之上的轻量级的抽象。它允许我们以非常低的代价在同一个地址空间中并行地执行多个函数或者方法，这篇文章主要介绍了Go语言学习之goroutine的相关知识,需要的朋友可以参考下
2020-02-02
GoLang读取文件的10种方法实例
读取文件是所有编程语言中最常见的操作之一,下面这篇文章主要给大家介绍了关于GoLang读取文件的10种方法,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
2022-06-06