Golang使用channel實(shí)現(xiàn)一個(gè)優(yōu)雅退出功能
前言
最近補(bǔ) Golang channel 方面八股的時(shí)候發(fā)現(xiàn)用 channel 實(shí)現(xiàn)一個(gè)優(yōu)雅退出功能好像不是很難，之前寫的 HTTP 框架剛好也不支持優(yōu)雅退出功能，于是就參考了 Hertz 優(yōu)雅退出方面的代碼，為我的 PIANO 補(bǔ)足了這個(gè) feature。
字節(jié)跳動(dòng)開源社區(qū) CloudWeGo 開源的一款高性能 HTTP 框架，具有高易用性、高性能、高擴(kuò)展性等特點(diǎn)。
筆者自己實(shí)現(xiàn)的輕量級(jí) HTTP 框架，具有中間件，三種不同的路由（靜態(tài)，通配，參數(shù)）方式，路由分組，優(yōu)雅退出等功能，迭代發(fā)展中。
實(shí)現(xiàn)思路
通過一個(gè) os.Signal 類型的 chan 接收退出信號(hào)，收到信號(hào)后進(jìn)行對(duì)應(yīng)的退出收尾工作，利用 context.WithTimeout 或 time.After 等方式設(shè)置退出超時(shí)時(shí)間防止收尾等待時(shí)間過長。
讀源碼
由于 Hertz 的 Hook 功能中的 ShutdownHook 是 graceful shutdown 的一環(huán)，并且 Hook 功能的實(shí)現(xiàn)也不是很難所以這里就一起分析了，如果不想看直接跳到后面的章節(jié)即可 :)
Hook
Hook 函數(shù)是一個(gè)通用的概念，表示某事件觸發(fā)時(shí)所伴隨的操作，Hertz 提供了 StartHook 和 ShutdownHook 用于在服務(wù)觸發(fā)啟動(dòng)后和退出前注入用戶自己的處理邏輯。
兩種 Hook 具體是作為兩種不同類型的 Hertz Engine 字段，用戶可以直接以 append 的方式添加自己的 Hooks，下面是作為 Hertz Engine 字段的代碼：
type Engine struct {
...
// Hook functions get triggered sequentially when engine start
OnRun []CtxErrCallback
// Hook functions get triggered simultaneously when engine shutdown
OnShutdown []CtxCallback
...
}可以看到兩者都是函數(shù)數(shù)組的形式，并且是公開字段，所以可以直接 append，函數(shù)的簽名如下，OnShutdown 的函數(shù)不會(huì)返回 error 因?yàn)槎纪顺隽怂詻]法對(duì)錯(cuò)誤進(jìn)行處理：
// OnRun type CtxCallback func(ctx context.Context) // OnShutdown type CtxErrCallback func(ctx context.Context) error
并且設(shè)置的 StartHook 會(huì)按照聲明順序依次調(diào)用，但是 ShutdownHook 會(huì)并發(fā)的進(jìn)行調(diào)用，這里的實(shí)現(xiàn)后面會(huì)講。
StartHook 的執(zhí)行時(shí)機(jī)
觸發(fā) Server 啟動(dòng)后，框架會(huì)按函數(shù)聲明順序依次調(diào)用所有的 StartHook 函數(shù)，完成調(diào)用之后，才會(huì)正式開始端口監(jiān)聽，如果發(fā)生錯(cuò)誤，則立刻終止服務(wù)。
上面是官方文檔中描述的 StartHook 的執(zhí)行時(shí)機(jī)，具體在源碼中就是下面的代碼：
func (engine *Engine) Run() (err error) {
...
// trigger hooks if any
ctx := context.Background()
for i := range engine.OnRun {
if err = engine.OnRun[i](ctx); err != nil {
return err
}
}
return engine.listenAndServe()
}熟悉或使用過 Hertz 的同學(xué)肯定知道 h.Spin() 方法調(diào)用后會(huì)正式啟動(dòng) Hertz 的 HTTP 服務(wù)，而上面的 engine.Run 方法則是被 h.Spin 異步調(diào)用的?？梢钥吹皆?engine.Run 方法里循環(huán)調(diào)用 engine.OnRun 數(shù)組中注冊(cè)的函數(shù)，最后執(zhí)行完成完成并且沒有 error 的情況下才會(huì)執(zhí)行 engine.listenAndServe() 正式開始端口監(jiān)聽，和官方文檔中說的一致，并且這里是通過 for 循環(huán)調(diào)用的所以也正如文檔所說框架會(huì)按函數(shù)聲明順序依次調(diào)用。
ShutdownHook 的執(zhí)行時(shí)機(jī)
Server 退出前，框架會(huì)并發(fā)地調(diào)用所有聲明的 ShutdownHook 函數(shù)，并且可以通過 server.WithExitWaitTime配置最大等待時(shí)長，默認(rèn)為5秒，如果超時(shí)，則立刻終止服務(wù)。
上面是官方文檔中描述的 ShutdownHook 的執(zhí)行時(shí)機(jī)，具體在源碼中就是下面的代碼：
func (engine *Engine) executeOnShutdownHooks(ctx context.Context, ch chan struct{}) {
wg := sync.WaitGroup{}
for i := range engine.OnShutdown {
wg.Add(1)
go func(index int) {
defer wg.Done()
engine.OnShutdown[index](ctx)
}(i)
}
wg.Wait()
ch <- struct{}{}
}通過 sync.WaitGroup 保證每個(gè) ShutdownHook 函數(shù)都執(zhí)行完畢后給形參 ch 發(fā)送信號(hào)通知，注意這里每個(gè) ShutdownHook 都起了一個(gè)協(xié)程，所以是并發(fā)執(zhí)行，這也是官方文檔所說的并發(fā)的進(jìn)行調(diào)用。
服務(wù)注冊(cè)與下線的執(zhí)行時(shí)機(jī)
服務(wù)注冊(cè)
Hertz 雖然是一個(gè) HTTP 框架，但是 Hertz 的客戶端和服務(wù)端可以通過注冊(cè)中心進(jìn)行服務(wù)發(fā)現(xiàn)并進(jìn)行調(diào)用，并且 Hertz 也提供了大部分常用的注冊(cè)中心擴(kuò)展，在下面的 initOnRunHooks 方法中，通過注冊(cè)一個(gè) StartHook 調(diào)用 Registry 接口的 Register 方法對(duì)服務(wù)進(jìn)行注冊(cè)。
func (h *Hertz) initOnRunHooks(errChan chan error) {
// add register func to runHooks
opt := h.GetOptions()
h.OnRun = append(h.OnRun, func(ctx context.Context) error {
go func() {
// delay register 1s
time.Sleep(1 * time.Second)
if err := opt.Registry.Register(opt.RegistryInfo); err != nil {
hlog.SystemLogger().Errorf("Register error=%v", err)
// pass err to errChan
errChan <- err
}
}()
return nil
})
}取消注冊(cè)
在 Shutdown 方法中進(jìn)行調(diào)用 Deregister 取消注冊(cè)，可以看到剛剛提到的 executeOnShutdownHooks 的方法在開始異步執(zhí)行后就會(huì)進(jìn)行取消注冊(cè)操作。
func (engine *Engine) Shutdown(ctx context.Context) (err error) {
...
ch := make(chan struct{})
// trigger hooks if any
go engine.executeOnShutdownHooks(ctx, ch)
defer func() {
// ensure that the hook is executed until wait timeout or finish
select {
case <-ctx.Done():
hlog.SystemLogger().Infof("Execute OnShutdownHooks timeout: error=%v", ctx.Err())
return
case <-ch:
hlog.SystemLogger().Info("Execute OnShutdownHooks finish")
return
}
}()
if opt := engine.options; opt != nil && opt.Registry != nil {
if err = opt.Registry.Deregister(opt.RegistryInfo); err != nil {
hlog.SystemLogger().Errorf("Deregister error=%v", err)
return err
}
}
...
}Engine Status
講 graceful shutdown 之前最好了解一下 Hertz Engine 的 status 字段以獲得更好的閱讀體驗(yàn)ww
type Engine struct {
...
// Indicates the engine status (Init/Running/Shutdown/Closed).
status uint32
...
}如上所示，status 是一個(gè) uint32 類型的內(nèi)部字段，用來表示 Hertz Engine 的狀態(tài)，具體具有四種狀態(tài)（Init 1, Running 2, Shutdown 3, Closed 4），由下面的常量定義。
const ( _ uint32 = iota statusInitialized statusRunning statusShutdown statusClosed )
下面列出了 Hertz Engine 狀態(tài)改變的時(shí)機(jī)：
| 函數(shù) | 狀態(tài)改變前 | 狀態(tài)改變后 |
|---|---|---|
| engine.Init | 0 | Init (1) |
| engine.Run | Init (1) | Running (2) |
| engine.Shutdown | Running (2) | Shutdown (3) |
| engine.Run defer | ? | Closed (4) |
對(duì)狀態(tài)的改變都是通過 atomic 包下的函數(shù)進(jìn)行更改的，保證了并發(fā)安全。
優(yōu)雅退出
Hertz Graceful Shutdown 功能的核心方法如下，signalToNotify 數(shù)組包含了所有會(huì)觸發(fā)退出的信號(hào)，觸發(fā)了的信號(hào)會(huì)傳向 signals 這個(gè) channel，并且 Hertz 會(huì)根據(jù)收到信號(hào)類型決定進(jìn)行優(yōu)雅退出還是強(qiáng)制退出。
// Default implementation for signal waiter.
// SIGTERM triggers immediately close.
// SIGHUP|SIGINT triggers graceful shutdown.
func waitSignal(errCh chan error) error {
signalToNotify := []os.Signal{syscall.SIGINT, syscall.SIGHUP, syscall.SIGTERM}
if signal.Ignored(syscall.SIGHUP) {
signalToNotify = []os.Signal{syscall.SIGINT, syscall.SIGTERM}
}
signals := make(chan os.Signal, 1)
signal.Notify(signals, signalToNotify...)
select {
case sig := <-signals:
switch sig {
case syscall.SIGTERM:
// force exit
return errors.New(sig.String()) // nolint
case syscall.SIGHUP, syscall.SIGINT:
hlog.SystemLogger().Infof("Received signal: %s\n", sig)
// graceful shutdown
return nil
}
case err := <-errCh:
// error occurs, exit immediately
return err
}
return nil
}如果 engine.Run 方法返回了一個(gè)錯(cuò)誤則會(huì)通過 errCh 傳入 waitSignal 函數(shù)然后觸發(fā)立刻退出。前面也提到 h.Spin() 是以異步的方式調(diào)用 engine.Run，waitSignal 則由 h.Spin() 直接調(diào)用，所以運(yùn)行后 Hertz 會(huì)阻塞在 waitSignal 函數(shù)的 select 這里等待信號(hào)。
三個(gè)會(huì)觸發(fā) Shutdown 的信號(hào)區(qū)別如下：
syscall.SIGINT表示中斷信號(hào)，通常由用戶在終端上按下 Ctrl+C 觸發(fā)，用于請(qǐng)求程序停止運(yùn)行；syscall.SIGHUP表示掛起信號(hào)，通常是由系統(tǒng)發(fā)送給進(jìn)程，用于通知進(jìn)程它的終端或控制臺(tái)已經(jīng)斷開連接或終止，進(jìn)程需要做一些清理工作；syscall.SIGTERM表示終止信號(hào)，通常也是由系統(tǒng)發(fā)送給進(jìn)程，用于請(qǐng)求進(jìn)程正常地終止運(yùn)行，進(jìn)程需要做一些清理工作；
如果 waitSignal 的返回值為 nil 則 h.Spin() 會(huì)進(jìn)行優(yōu)雅退出：
func (h *Hertz) Spin() {
errCh := make(chan error)
h.initOnRunHooks(errCh)
go func() {
errCh <- h.Run()
}()
signalWaiter := waitSignal
if h.signalWaiter != nil {
signalWaiter = h.signalWaiter
}
if err := signalWaiter(errCh); err != nil {
hlog.SystemLogger().Errorf("Receive close signal: error=%v", err)
if err := h.Engine.Close(); err != nil {
hlog.SystemLogger().Errorf("Close error=%v", err)
}
return
}
hlog.SystemLogger().Infof("Begin graceful shutdown, wait at most num=%d seconds...", h.GetOptions().ExitWaitTimeout/time.Second)
ctx, cancel := context.WithTimeout(context.Background(), h.GetOptions().ExitWaitTimeout)
defer cancel()
if err := h.Shutdown(ctx); err != nil {
hlog.SystemLogger().Errorf("Shutdown error=%v", err)
}
}并且 Hertz 通過 context.WithTimeout 的方式設(shè)置了優(yōu)雅退出的超時(shí)時(shí)長，默認(rèn)為 5 秒，用戶可以通過 WithExitWaitTime 方法配置 server 的優(yōu)雅退出超時(shí)時(shí)長。將設(shè)置了超時(shí)時(shí)間的 ctx 傳入 Shutdown 方法，如果 ShutdownHook 先執(zhí)行完畢則 ch channel 收到信號(hào)后返回退出，否則 Context 超時(shí)收到信號(hào)強(qiáng)制返回退出。
func (engine *Engine) Shutdown(ctx context.Context) (err error) {
...
ch := make(chan struct{})
// trigger hooks if any
go engine.executeOnShutdownHooks(ctx, ch)
defer func() {
// ensure that the hook is executed until wait timeout or finish
select {
case <-ctx.Done():
hlog.SystemLogger().Infof("Execute OnShutdownHooks timeout: error=%v", ctx.Err())
return
case <-ch:
hlog.SystemLogger().Info("Execute OnShutdownHooks finish")
return
}
}()
...
return
}以上就是 Hertz 優(yōu)雅退出部分的源碼分析，可以發(fā)現(xiàn) Hertz 多次利用了協(xié)程，通過 channel 傳遞信號(hào)進(jìn)行流程控制和信息傳遞，并通過 Context 的超時(shí)機(jī)制完成了整個(gè)優(yōu)雅退出流程。
自己實(shí)現(xiàn)
說是自己實(shí)現(xiàn)實(shí)際上也就是代碼搬運(yùn)工，把 Hertz 的 graceful shutdown 及其相關(guān)功能給 PIANO 進(jìn)行適配罷了ww
代碼實(shí)現(xiàn)都差不多，一些小細(xì)節(jié)根據(jù)我個(gè)人的習(xí)慣做了修改，完整修改參考這個(gè) commit，對(duì) PIANO 感興趣的話歡迎 Star !
適配 Hook
type Engine struct {
...
// hook
OnRun []HookFuncWithErr
OnShutdown []HookFunc
...
}
type (
HookFunc func(ctx context.Context)
HookFuncWithErr func(ctx context.Context) error
)
func (e *Engine) executeOnRunHooks(ctx context.Context) error {
for _, h := range e.OnRun {
if err := h(ctx); err != nil {
return err
}
}
return nil
}
func (e *Engine) executeOnShutdownHooks(ctx context.Context, ch chan struct{}) {
wg := sync.WaitGroup{}
for _, h := range e.OnShutdown {
wg.Add(1)
go func(hook HookFunc) {
defer wg.Done()
hook(ctx)
}(h)
}
wg.Wait()
ch <- struct{}{}
}適配 Engine Status
type Engine struct {
...
// initialized | running | shutdown | closed
status uint32
...
}
const (
_ uint32 = iota
statusInitialized
statusRunning
statusShutdown
statusClosed
)適配 Graceful Shutdown
// Play the PIANO now
func (p *Piano) Play() {
errCh := make(chan error)
go func() {
errCh <- p.Run()
}()
waitSignal := func(errCh chan error) error {
signalToNotify := []os.Signal{syscall.SIGHUP, syscall.SIGINT, syscall.SIGTERM}
if signal.Ignored(syscall.SIGHUP) {
signalToNotify = signalToNotify[1:]
}
signalCh := make(chan os.Signal, 1)
signal.Notify(signalCh, signalToNotify...)
select {
case sig := <-signalCh:
switch sig {
case syscall.SIGTERM:
// force exit
return errors.New(sig.String())
case syscall.SIGHUP, syscall.SIGINT:
// graceful shutdown
log.Infof("---PIANO--- Receive signal: %v", sig)
return nil
}
case err := <-errCh:
return err
}
return nil
}
if err := waitSignal(errCh); err != nil {
log.Errorf("---PIANO--- Receive close signal error: %v", err)
return
}
log.Infof("---PIANO--- Begin graceful shutdown, wait up to %d seconds", p.Options().ShutdownTimeout/time.Second)
ctx, cancel := context.WithTimeout(context.Background(), p.Options().ShutdownTimeout)
defer cancel()
if err := p.Shutdown(ctx); err != nil {
log.Errorf("---PIANO--- Shutdown err: %v", err)
}
}總結(jié)
本文通過對(duì) Hertz 優(yōu)雅退出功能的實(shí)現(xiàn)做了源碼分析并對(duì)自己的 HTTP 框架進(jìn)行了適配，希望可以幫助讀者利用 channel 實(shí)現(xiàn)一個(gè)優(yōu)雅退出功能提供參考和思路，如果哪里有問題或者錯(cuò)誤歡迎評(píng)論或者私信，以上。
以上就是Golang使用channel實(shí)現(xiàn)一個(gè)優(yōu)雅退出功能的詳細(xì)內(nèi)容，更多關(guān)于Golang channel退出的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
Golang項(xiàng)目在github創(chuàng)建release后自動(dòng)生成二進(jìn)制文件的方法
這篇文章主要介紹了Golang項(xiàng)目在github創(chuàng)建release后如何自動(dòng)生成二進(jìn)制文件,本文給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2023-03-03
Golang異常處理之defer,panic,recover的使用詳解
這篇文章主要為大家介紹了Go語言異常處理機(jī)制中defer、panic和recover三者的使用方法，文中示例代碼講解詳細(xì),需要的朋友可以參考下2022-05-05
通過源碼分析Golang?cron的實(shí)現(xiàn)原理
golang實(shí)現(xiàn)定時(shí)任務(wù)很簡單，只須要簡單幾步代碼即可以完成，最近在做了幾個(gè)定時(shí)任務(wù)，想研究一下它內(nèi)部是怎么實(shí)現(xiàn)的，所以將源碼過了一遍，記錄和分享在此。需要的朋友可以參考以下內(nèi)容，希望對(duì)大家有幫助2022-10-10
這篇文章主要為大家介紹了GPT回答go語言和C語言map操作方法對(duì)比,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-10-10
Go Mongox輕松實(shí)現(xiàn)MongoDB的時(shí)間字段自動(dòng)填充
這篇文章主要為大家詳細(xì)介紹了Go語言如何使用 mongox 庫,在插入和更新數(shù)據(jù)時(shí)自動(dòng)填充時(shí)間字段,從而提升開發(fā)效率并減少重復(fù)代碼,需要的可以參考下2025-02-02
詳解golang執(zhí)行Linux shell命令完整場(chǎng)景下的使用方法
本文主要介紹了golang執(zhí)行Linux shell命令完整場(chǎng)景下的使用方法，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2022-06-06
本文主要介紹了Go指針的具體使用,包括使用指針、空指針、指針數(shù)組、指向指針的指針等,具有一定的參考價(jià)值,感興趣的可以了解一下2023-11-11
Go語言封裝一個(gè)Cron定時(shí)任務(wù)管理器
在現(xiàn)代應(yīng)用中,定時(shí)任務(wù)是非常常見的需求,無論是用于定時(shí)清理數(shù)據(jù),還是定時(shí)執(zhí)行系統(tǒng)維護(hù)任務(wù),下面我們就來使用Go語言封裝一個(gè)Cron定時(shí)任務(wù)管理器吧2024-12-12
go官方介紹go內(nèi)存模型的時(shí)候說：探究在什么條件下，goroutine?在讀取一個(gè)變量的值的時(shí)，能夠看到其它?goroutine?對(duì)這個(gè)變量進(jìn)行的寫的結(jié)果，Go內(nèi)存模型規(guī)定了一些條件，在這些條件下，在一個(gè)goroutine中讀取變量返回的值能夠確保是另一個(gè)goroutine中對(duì)該變量寫入的值2023-03-03
詳解Go語言微服務(wù)開發(fā)框架之Go chassis
分布式系統(tǒng)中每個(gè)進(jìn)程的動(dòng)態(tài)配置管理及運(yùn)行時(shí)熱加載就成為了一個(gè)亟待解決的問題。go chassis汲取了netflix的archaius框架經(jīng)驗(yàn)，并做出來自己的創(chuàng)新特性。2021-05-05