主頁(yè) > 知識(shí)庫(kù) > 使用Go實(shí)現(xiàn)優(yōu)雅重啟服務(wù)功能

使用Go實(shí)現(xiàn)優(yōu)雅重啟服務(wù)功能

暴力的重啟服務(wù)方案

一般服務(wù)器重啟可以直接通過(guò) kill 命令殺死進(jìn)程，然后重新啟動(dòng)一個(gè)新的進(jìn)程即可。但這種方法比較粗暴，有可能導(dǎo)致某些正在處理中的客戶端請(qǐng)求失敗，如果請(qǐng)求正在寫(xiě)數(shù)據(jù)，那么還有可能導(dǎo)致數(shù)據(jù)丟失或者數(shù)據(jù)不一致等。

那么有什么方式可以優(yōu)雅的重啟服務(wù)呢？

優(yōu)雅的重啟服務(wù)方案

優(yōu)雅的重啟方式流程如下：

從上面的流程可以看出，舊進(jìn)程必須等待所有的請(qǐng)求連接完成后才會(huì)退出，請(qǐng)求不會(huì)被強(qiáng)制關(guān)閉，所以是個(gè)優(yōu)雅的重啟方式。

使用Go實(shí)現(xiàn)優(yōu)雅重啟

下面我們使用Go語(yǔ)言來(lái)演示怎么實(shí)現(xiàn)優(yōu)雅啟動(dòng)功能，我們先來(lái)看看原理圖：

從原理圖可以知道，重啟時(shí)首先通過(guò)發(fā)送 SIGHUP信號(hào) 給服務(wù)進(jìn)程，服務(wù)進(jìn)程收到 SIGHUP信號(hào) 后會(huì) fork 一個(gè)新進(jìn)程來(lái)處理新的請(qǐng)求，然后新進(jìn)程會(huì)發(fā)送 SIGTERM信號(hào) 給舊服務(wù)進(jìn)程（父進(jìn)程），舊服務(wù)進(jìn)程接收到 SIGTERM信號(hào) 后會(huì)關(guān)閉監(jiān)聽(tīng)的 socket句柄（停止接收新請(qǐng)求），并且等待未處理完成的請(qǐng)求完成后再退出進(jìn)程。

下面通過(guò)代碼來(lái)說(shuō)明這個(gè)流程，代碼主要參考 endless 這個(gè)庫(kù)，有興趣可以查看其源碼。

首先我們定義一個(gè)名為 endlessServer 的結(jié)構(gòu)并且繼承 http.Server 結(jié)構(gòu)：

type endlessServer struct {
  http.Server
  EndlessListener net.Listener
  wg        sync.WaitGroup
  sigChan     chan os.Signal
  isChild     bool
  state      uint8
  lock       *sync.RWMutex
}

Go的繼承很簡(jiǎn)單，就是在定義結(jié)構(gòu)時(shí)把要繼承的結(jié)構(gòu)嵌入到里面就可以了。

這里說(shuō)明一下 endlessServer 各個(gè)成員的作用吧：

Server：用于繼承 http.Server 結(jié)構(gòu)
EndlessListener：監(jiān)聽(tīng)客戶端請(qǐng)求的 Listener
wg：用于記錄還有多少客戶端請(qǐng)求沒(méi)有完成
sigChan：用于接收信號(hào)的管道
isChild：用于重啟時(shí)標(biāo)志本進(jìn)程是否是為一個(gè)新進(jìn)程
state：當(dāng)前進(jìn)程的狀態(tài)
lock：用于鎖定一些資源

定義一個(gè)創(chuàng)建 endlessServer 結(jié)構(gòu)的函數(shù)：

func NewServer(addr string, handler http.Handler) (srv *endlessServer) {
  isChild := os.Getenv("ENDLESS_CONTINUE") != ""
  srv = endlessServer{
    wg:   sync.WaitGroup{},
    sigChan: make(chan os.Signal),
    isChild: isChild,
    state: STATE_INIT,
    lock: sync.RWMutex{},
  }
  srv.Server.Addr = addr
  srv.Server.ReadTimeout = 0
  srv.Server.WriteTimeout = 0
  srv.Server.MaxHeaderBytes = 0
  srv.Server.Handler = handler
  return
}

NewServer() 函數(shù)的實(shí)現(xiàn)比較簡(jiǎn)單，就是創(chuàng)建一個(gè) endlessServer 結(jié)構(gòu)，然后初始化其各個(gè)成員。要注意的是，是否為新進(jìn)程是通過(guò)讀取環(huán)境變量 ENDLESS_CONTINUE 來(lái)判斷的，如果定義了 ENDLESS_CONTINUE 環(huán)境變量，就是說(shuō)當(dāng)前進(jìn)程是新的服務(wù)進(jìn)程。

用過(guò)Go語(yǔ)言的HTTP包的同學(xué)應(yīng)該知道，要進(jìn)行監(jiān)聽(tīng)客戶端請(qǐng)求的話必須調(diào)用其 ListenAndServe() 函數(shù)，所以我們要定義這個(gè)函數(shù)：

func ListenAndServe(addr string, handler http.Handler) error {
  server := NewServer(addr, handler)
  return server.ListenAndServe()
}

函數(shù)的實(shí)現(xiàn)很簡(jiǎn)單，就是先調(diào)用 NewServer() 函數(shù)創(chuàng)建一個(gè) endlessServer 結(jié)構(gòu)，然后調(diào)用其 ListenAndServe() 方法。所以我們要為 endlessServer 結(jié)構(gòu)定義一個(gè) ListenAndServe() 方法：

func (srv *endlessServer) ListenAndServe() (err error) {
  addr := srv.Addr
  if addr == "" {
    addr = ":http"
  }
  go srv.handleSignals()
  l, err := srv.getListener(addr)
  if err != nil {
    log.Println(err)
    return
  }
  srv.EndlessListener = newEndlessListener(l, srv)
  if srv.isChild {
    syscall.Kill(syscall.Getppid(), syscall.SIGTERM)
  }
  return srv.Serve()
}

ListenAndServe() 方法首先會(huì)創(chuàng)建一個(gè)協(xié)程處理 handleSignals() 方法，這個(gè)方法主要是處理信號(hào)，下面會(huì)介紹。然后調(diào)用 getListener() 方法獲取一個(gè)類型為 net.Listener 的對(duì)象，然后調(diào)用 newEndlessListener() 函數(shù)創(chuàng)建一個(gè)類型為 endlessListener 的對(duì)象。再通過(guò)判斷當(dāng)前進(jìn)程是否為新的處理進(jìn)程，如果是就調(diào)用 syscall.Kill() 方法發(fā)送一個(gè) SIGTERM信號(hào) 給父進(jìn)程（舊的服務(wù)處理進(jìn)程），最后調(diào)用 Serve() 方法開(kāi)始處理客戶端連接。

我們先來(lái)看看處理信號(hào)的 handleSignal() 方法：

func (srv *endlessServer) handleSignals() {
  var sig os.Signal
  signal.Notify(
    srv.sigChan,
    syscall.SIGHUP,
    syscall.SIGINT,
    syscall.SIGTERM,
  )
  pid := syscall.Getpid()
  for {
    sig = -srv.sigChan
    srv.signalHooks(PRE_SIGNAL, sig)
    switch sig {
    case syscall.SIGHUP:
      err := srv.fork()
      if err != nil {
        log.Println("Fork err:", err)
      }
    case syscall.SIGINT:
      srv.shutdown()
    case syscall.SIGTERM:
      srv.shutdown()
    default:
      log.Printf("Received %v: nothing i care about...\n", sig)
    }
  }
}

handleSignal() 方法主要監(jiān)聽(tīng)3種信號(hào)， syscall.SIGHUP 、 syscall.SIGINT 和 syscall.SIGTERM 。 syscall.SIGHUP 信號(hào)為重啟信號(hào)，而 syscall.SIGINT 信號(hào)為關(guān)閉服務(wù)信號(hào)，而 syscall.SIGTERM 信號(hào)主要是新的服務(wù)進(jìn)程發(fā)送給舊的服務(wù)進(jìn)程，告訴其關(guān)閉監(jiān)聽(tīng)處理客戶端的socket。當(dāng)收到 syscall.SIGHUP 信號(hào)時(shí)，需要調(diào)用 fork() 方法來(lái)創(chuàng)建一個(gè)新的服務(wù)進(jìn)程，而收到 syscall.SIGINT 和 syscall.SIGTERM 信號(hào)主要調(diào)用 shutdown() 方法來(lái)關(guān)閉當(dāng)前進(jìn)程。

再來(lái)看看創(chuàng)建新服務(wù)進(jìn)程的 fork() 方法：

func (srv *endlessServer) fork() (err error) {
  files := []*os.File{
    srv.EndlessListener.(*endlessListener).File(),
  }
  env := append(
    os.Environ(),
    "ENDLESS_CONTINUE=1",
  )
  path := os.Args[0]
  var args []string
  if len(os.Args) > 1 {
    args = os.Args[1:]
  }
  cmd := exec.Command(path, args...)
  cmd.Stdout = os.Stdout
  cmd.Stderr = os.Stderr
  cmd.ExtraFiles = files
  cmd.Env = env
  err = cmd.Start()
  if err != nil {
    log.Fatalf("Restart: Failed to launch, error: %v", err)
  }
  return
}

fork() 方法也比較簡(jiǎn)單，主要是使用 exec 包的 Command() 方法來(lái)創(chuàng)建一個(gè) Cmd 對(duì)象，然后調(diào)用其 Start() 方法來(lái)啟動(dòng)一個(gè)新進(jìn)。要注意的是，創(chuàng)建新進(jìn)程前需要設(shè)置環(huán)境變量 ENDLESS_CONTINUE ，這是告訴新進(jìn)程需要發(fā)送 syscall.SIGTERM 信號(hào)給父進(jìn)程。還有就是通過(guò) Cmd 對(duì)象的 ExtraFiles 成員把監(jiān)聽(tīng)客戶端連接的socket句柄傳遞給新服務(wù)處理進(jìn)程了。

再來(lái)看看關(guān)閉服務(wù)進(jìn)程的 shutdown() 方法：

func (srv *endlessServer) shutdown() {
  err := srv.EndlessListener.Close()
}

這個(gè)方法很簡(jiǎn)單，就是調(diào)用 net.Listener 對(duì)象的 Close() 方法來(lái)關(guān)閉監(jiān)聽(tīng)客戶端請(qǐng)求的socket。關(guān)閉監(jiān)聽(tīng)客戶端請(qǐng)求的socket后，主循環(huán)會(huì)退出處理，然后會(huì)退出進(jìn)程。

接著我們來(lái)看看接收客戶端請(qǐng)求的 endlessListener.Accept() 方法：

func (el *endlessListener) Accept() (c net.Conn, err error) {
  tc, err := el.Listener.(*net.TCPListener).AcceptTCP()
  if err != nil {
    return
  }
  tc.SetKeepAlive(true)         // see http.tcpKeepAliveListener
  tc.SetKeepAlivePeriod(3 * time.Minute) // see http.tcpKeepAliveListener
  c = endlessConn{
    Conn:  tc,
    server: el.server,
  }
  el.server.wg.Add(1)
  return
}

主要要注意的是，函數(shù)最后會(huì)調(diào)用 el.server.wg.Add(1) 這行代碼來(lái)增加客戶端請(qǐng)求的計(jì)數(shù)器，這是優(yōu)雅重啟的關(guān)鍵。因?yàn)樵?nbsp; endlessServer.Serve() 方法中會(huì)等待所有客戶端請(qǐng)求處理完畢才會(huì)退出，我們來(lái)看看 endlessServer.Serve() 方法的實(shí)現(xiàn)：

func (srv *endlessServer) Serve() (err error) {
  err = srv.Server.Serve(srv.EndlessListener)
  srv.wg.Wait()
  return
}

可以看到， endlessServer.Serve() 方法最后會(huì)調(diào)用 srv.wg.Wait() 這行代碼來(lái)等待所有客戶端請(qǐng)求完成。那么客戶端連接計(jì)數(shù)器什么時(shí)候會(huì)減少呢？在 endlessConn.Close() 方法中可以看到計(jì)數(shù)器減少的操作：

func (w endlessConn) Close() error {
  err := w.Conn.Close()
  if err == nil {
    w.server.wg.Done()
  }
  return err
}

可以看到， endlessConn.Close() 方法最后會(huì)調(diào)用 w.server.wg.Done() 這行代碼來(lái)減少客戶端請(qǐng)求計(jì)數(shù)器。至此，優(yōu)雅重啟服務(wù)的實(shí)現(xiàn)就完成。

當(dāng)然，本篇文章主要介紹的是優(yōu)雅重啟的原理，完成的源碼實(shí)現(xiàn)還是要查看 endless 這個(gè)庫(kù)。

總結(jié)

以上所述是小編給大家介紹的使用Go實(shí)現(xiàn)優(yōu)雅重啟服務(wù)功能，希望對(duì)大家有所幫助，如果大家有任何疑問(wèn)請(qǐng)給我留言，小編會(huì)及時(shí)回復(fù)大家的。在此也非常感謝大家對(duì)腳本之家網(wǎng)站的支持！
如果你覺(jué)得本文對(duì)你有幫助，歡迎轉(zhuǎn)載，煩請(qǐng)注明出處，謝謝！

您可能感興趣的文章:

解決django服務(wù)器重啟端口被占用的問(wèn)題
詳解如何熱重啟golang服務(wù)器
在Go程序中實(shí)現(xiàn)服務(wù)器重啟的方法

標(biāo)簽：湘潭崇左銅川黃山仙桃衡水湖南蘭州

巨人網(wǎng)絡(luò)通訊聲明：本文標(biāo)題《使用Go實(shí)現(xiàn)優(yōu)雅重啟服務(wù)功能》，本文關(guān)鍵詞；如發(fā)現(xiàn)本文內(nèi)容存在版權(quán)問(wèn)題，煩請(qǐng)?zhí)峁┫嚓P(guān)信息告之我們，我們將及時(shí)溝通與處理。本站內(nèi)容系統(tǒng)采集于網(wǎng)絡(luò)，涉及言論、版權(quán)與本站無(wú)關(guān)。