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程序退出的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

Golang中crypto/rand库的使用技巧与最佳实践
在Golang的众多随机数生成库中,crypto/rand 是一个专为加密安全设计的库,本文主要介绍了Golang中crypto/rand库的使用技巧与最佳实践,感兴趣的可以了解一下
2024-02-02
基于Go和PHP语言实现爬楼梯算法的思路详解
这篇文章主要介绍了Go和PHP 实现爬楼梯算法,本文通过动态规划和斐波那契数列两种解决思路给大家讲解的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2020-05-05
golang连接kafka消费进ES操作
这篇文章主要介绍了golang连接kafka消费进ES操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-12-12
使用Gin框架搭建一个Go Web应用程序的方法详解
在本文中,我们将要实现一个简单的 Web 应用程序,通过 Gin 框架来搭建,主要支持用户注册和登录,用户可以通过注册账户的方式创建自己的账号,并通过登录功能进行身份验证,感兴趣的同学跟着小编一起来看看吧
2023-08-08
一文带你了解Golang中select的实现原理
select是go提供的一种跟并发相关的语法，非常有用。本文将介绍 Go 语言中的 select 的实现原理，包括 select 的结构和常见问题、编译期间的多种优化以及运行时的执行过程
2023-02-02
Fedora14 Linux系统安装Golang开发环境笔记
这篇文章主要介绍了Fedora14 Linux系统安装Golang开发环境笔记,本文讲解了2种安装方法,需要的朋友可以参考下
2014-10-10
golang用melody搭建轻量的websocket服务的示例代码
在Go中,可以使用gin和melody库来搭建一个轻量级的WebSocket服务,gin是一个流行的Web框架,而melody是一个用于处理WebSocket的库,本文给大家演示如何使用gin和melody搭建WebSocket服务,感兴趣的朋友一起看看吧
2023-10-10
深入了解Go语言中web框架的中间件运行机制
大家在使用iris框架搭建web系统时，一定会用到中间件。那么你了解中间件的运行机制吗？你知道为什么在iris和gin框架的请求处理函数中要加c.Next()函数吗？本文就和大家一起探究该问题的答案
2023-02-02
Go一站式配置管理工具Viper的使用教程
Viper是一个方便Go语言应用程序处理配置信息的库,它可以处理多种格式的配置,这篇文章主要为大家介绍了它的具体使用教程,需要的可以参考下
2023-08-08
详解Golang如何动态获取配置文件
项目中经常获取一些常用配置文件,当有配置文件中的参数被修改后,如何的实时获取配置文件就很关键了,下面小编就来讲讲如何利用viper实时获取配置文件吧
2023-08-08