Go:服务优雅关闭

优雅关闭的目的是让运行的Go应用程序停止接收新请求,同时在最终关闭之前完成正在进行的请求。这通常发生在滚动更新中。新的服务准备就绪后,旧服务才停止。

通常情况下,服务会在收到操作系统中断信号后终止。为了实现优雅的关闭,我们可以创建一个上下文,其中包含一个cancel回调和一个由http.Server接口提供的内置关闭方法。我们可以使用创建的上下文,通过一个通道侦听操作系统中断,并在接收到信号后立即调用cancel函数。

下面是一个http服务实现优雅关闭的示例。稍后我们将分析这个代码。

package main

import (
  "context"
  "fmt"
  "log"
  "net/http"
  "os"
  "os/signal"
  "time"
)

// Server is an interface that will used by app to serve and shutdown http server
type Server interface {
  ListenAndServe() error
  Shutdown(context.Context) error
}

// Logger is an interface that used by app to log something
type Logger interface {
  Fatalf(format string, v ...interface{})
  Printf(format string, v ...interface{})
}

func handler() http.Handler {
  mux := http.NewServeMux()
  mux.Handle("/healthz", http.HandlerFunc(
    func(w http.ResponseWriter, r *http.Request) {
      fmt.Fprintf(w, "ok")
    },
  ))

  return mux
}

func serve(ctx context.Context, server Server, logger Logger) error {
  var err error

  go func() {
    if err = server.ListenAndServe(); err != nil && err != http.ErrServerClosed {
      logger.Fatalf("ListenAndServe()=%+s", err)
    }
  }()

  <-ctx.Done()

  logger.Printf("server stopped")

  ctxShutDown, cancel := context.WithTimeout(context.Background(), 30*time.Second)
  defer func() {
    cancel()
  }()

  if err = server.Shutdown(ctxShutDown); err != nil {
    logger.Fatalf("server.Shutdown(ctxShutdown)=%+s", err)
  }
  
  logger.Printf("server exited gracefully")
  
  if err == http.ErrServerClosed {
    err = nil
  }
  
  return err
}

func main() {
  server := &http.Server{
    Addr:    ":8080",
    Handler: handler(),
  }

  stdLog := log.New(os.Stderr, "", log.LstdFlags)

  c := make(chan os.Signal, 1)
  signal.Notify(c, os.Interrupt)

  ctx, cancel := context.WithCancel(context.Background())
  go func() {
    osCall := <-c
    log.Printf("system call: %+v", osCall)
    cancel()
  }()

  log.Printf("starting server at %s", server.Addr)
  if err := serve(ctx, server, stdLog); err != nil {
    log.Printf("serve(ctx, server, stdLog)=%+s", err)
  }
}

要了解这种优雅的关闭是如何工作的,我们可以修改handler来模拟有请求时的处理过程。

func handler() http.Handler {
  mux := http.NewServeMux()
  mux.Handle("/healthz", http.HandlerFunc(
    func(w http.ResponseWriter, r *http.Request) {
      fmt.Fprintf(w, "ok")
      for i := 1; i <= 7; i++ {
        log.Println(i)
        time.Sleep(time.Second)
      }
    },
  ))
  return mux
}

然后向对应接口发送一个请求。当程序处理请求时,按Ctrl+C发送中断信号。服务器将停止,但它仍然处理正在进行的请求。同时,如果在服务器停止后还有新的请求发起,它将被拒绝。

代码解析

首先,在main函数中,我们创建一个用于监听os.Interrupt的channel【也可以通过|逻辑操作符来同时监听其他信号如os.kill】。

c := make(chan os.Signal, 1)
signal.Notify(c, os.Interrupt)

然后我们用context.cancel函数创建一个context。context将阻塞进程(在本例中是防止服务器关闭),直到我们调用cancel函数。

ctx, cancel := context.WithCancel(context.Background())

然后,我们创建一个在单独的goroutine中运行的匿名函数,它等待一个中断信号,然后调用cancel函数。

go func() {
  osCall := <-c
  log.Printf("system call: %+v", osCall)
  cancel()
}()

我们也创建一个&http.Server和logger实例,供后面使用。

server := &http.Server{
  Addr:    ":8080",
  Handler: handler(),
}
stdLog := log.New(os.Stderr, "", log.LstdFlags)

最后,将context、server和logger实例传递给serve函数。

if err := serve(ctx, server, stdLog); err != nil {
  log.Printf("serve(ctx, server, stdLog)=%+s", err)
}

在serve函数中,我们将在一个单独的goroutine中运行http服务。然后,用<-ctx.Done()阻塞进程,这样程序就会等待cancel函数的调用(在接收到中断信号后main函数会调用cancel)。

go func() {
  if err = server.ListenAndServe(); err != nil && err != http.ErrServerClosed {
    logger.Fatalf("ListenAndServe()=%+s", err)
  }
}()
<-ctx.Done()

在调用cancel函数之后,我们将通过服务实例调用shutdown函数来优雅地关闭服务。因为函数调用需要一个context,所以我们还创建了一个带有超时的上下文,以便为服务器关闭提供一个时间窗口。

ctxShutDown, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defer func() {
  cancel()
}()
if err = server.Shutdown(ctxShutDown); err != nil {
  logger.Fatalf("server.Shutdown(ctxShutdown)=%+s", err)
}

您可能注意到我使用Server和Logger接口。这样做的目的是使serve函数更容易测试。

总结:

服务优雅停止的目的主要是对服务正在进行的请求或操作的正常结束以及停止接收新请求,在日常开发中可以作为一个脚手架直接应用到你的服务中。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,444评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,421评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,036评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,363评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,460评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,502评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,511评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,280评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,736评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,014评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,190评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,848评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,531评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,159评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,411评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,067评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,078评论 2 352

推荐阅读更多精彩内容