http服务怎么重启

首页 > 实用技巧 > 作者:YD1662023-06-15 14:26:06

Florian von Bock[1] 已将本文中描述的内容实现成了一个名为Endless[2]的 Go 程序包。

对于 Golang HTTP 的服务,我们可能需要重启来升级或者更改某些配置。如果你(像我曾经一样)因为网络服务器对优雅重启很重视就理所当然地认为它(优雅重启)早已实现了,那么这份教程将会对你很有用处。因为在 Golang 中,你需要自己动手来实现。

实际上,这里需要解决两个问题。首先是 UNIX 端的优雅重启,即进程无需关闭监听套接字即可自行重启的机制。第二个问题是确保所有进行中的请求被正确完成或超时。

在不关闭套接字的情况下重启

派生一个新的进程

有多种使用 Golang 的库去实现派生进程的方法,在本文中的例子中,我们选择用 exec.Command[3]。这是因为此函数返回的 cmd 结构体[4] 具有 ExtraFiles 成员,该成员可以使打开的文件(除了 stdin/err/out 之外)被新进程继承。

看起来如下所示:

file:=netListener.File()//thisreturnsaDup() path:="/path/to/executable" args:=[]string{ "-graceful"} cmd:=exec.Command(path,args...) cmd.Stdout=os.Stdout cmd.Stderr=os.Stderr cmd.ExtraFiles=[]*os.File{file} err:=cmd.Start() iferr!=nil{ log.Fatalf("gracefulRestart:Failedtolaunch,error:%v",err) }

在上面的代码中,netListener 是指向 net.Listener[5] 的指针,net.Listener 用于侦听 HTTP 请求。如果你要升级,则 path 变量应包含新可执行文件的路径(可能与当前正在运行的文件相同)。

上面代码中的关键是 netListener.File() 会返回一个文件描述符 dup(2)[6]。这个文件描述符不会设置 FD_CLOEXEC 标识[7],这会导致文件在子进程中被关闭(不是我们想要的的情况)。

你可能会看到一些示例,通过命令行参数将需要继承的文件描述符传递给子进程,但是 ExtraFiles 实现的方式使这些变得没有必要。文档指出 "如果输入 non-nil,输入的切片索引为 i 则读取的文件描述符为 3 i。” 这意味着在上述代码段中,子进程中继承的文件描述符将始终为 3,因此无需显式传递它(译者注:这一段有点难以理解,ExtraFiles 可以指定额外的文件句柄传递给子进程,也就是可以通过这个方法将 netListener.File() 传递给子进程,而子进程通过 f := os.NewFile(3, "") 来读取,为什么是 3 呢?因为前面还有几个默认句柄,所以传入额外的句柄需要从 3 开始读取)。

最后,args 数组包含 -graceful 选项:你的程序将需要某种方式来通知子进程这是正常重启的一部分,并且子进程应重新使用套接字,而不是打开新的套接字。还有一种方法是通过环境变量来实现这个功能。

初始化子进程

这是程序启动序列的一部分

server:=&http.Server{Addr:"0.0.0.0:8888"} vargracefulChildbool varlnet.Listever varerrerror flag.BoolVar(&gracefulChild,"graceful",false,"listenonfdopen3(internaluseonly)") ifgracefulChild{ log.Print("main:Listeningtoexistingfiledescriptor3.") f:=os.NewFile(3,"") l,err=net.FileListener(f) }else{ log.Print("main:Listeningonanewfiledescriptor.") l,err=net.Listen("tcp",server.Addr) }

通知父进程停止

至此,子进程已经准备好接收请求,但是在此之前,需要告诉父进程停止接收请求并退出,这可能是这样的:

ifgracefulChild{ parent:=syscall.Getppid() log.Printf("main:Killingparentpid:%v",parent) syscall.Kill(parent,syscall.SIGTERM) } server.Serve(l)

进行中的请求 完成/超时

为此,我们需要使用 sync.WaitGroup[8] 跟踪打开的连接。我们需要给每次新增的连接使用 wg.Add,并在每次关闭连接时使用 wg.Done。

varhttpWgsync.WaitGroup

乍一看,Golang 标准的 http 包没有提供任何对 Accept() 或 Close() 操作的钩子,但是使用接口解决了这个问题。(非常感谢 Jeff R. Allen[9]的这篇文章[10])。

这是一个 listener 的示例,它在每个 Accept() 上使用 httpWg.Add(1) 计数。首先,我们对 net.Listener 进行“子类化”(stop 和 stopped 的作用将在下文体现):

typegracefulListenerstruct{ net.Listener stopchanerror stoppedbool }

接下来,我们“覆盖” Accept 方法。(暂时不要考虑 gracefulConn,稍后再介绍)。

func(gl*gracefulListener)Accept()(cnet.Conn,errerror){ c,err=gl.Listener.Accept() iferr!=nil{ return } c=gracefulConn{Conn:c} httpWg.Add(1) return }

我们还需要一个构造函数:

funcnewGracefulListener(lnet.Listener)(gl*gracefulListener){ gl=&gracefulListener{Listener:l,stop:make(chanerror)} Gofunc(){ _=<-gl.stop gl.stopped=true gl.stop<-gl.Listener.Close() }() return }

上面的函数启动 Goroutine 的原因是因为在上面的 Accept() 中无法完成此操作,因为它会被 gl.Listener.Accept() 阻塞。Goroutine 通过关闭文件描述符来解除阻塞。

我们的 Close() 方法仅将 nil 发送给上述 Goroutine 的 stop channel 即可完成其余工作。

func(gl*gracefulListener)Close()error{ ifgl.stopped{ returnsyscall.EINVAL } gl.stop<-nil return<-gl.stop }

最后,从 net.TCPListener 中提取文件描述符。

func(gl*gracefulListener)File()*os.File{ tl:=gl.Listener.(*net.TCPListener) fl,_:=tl.File() returnfl }

当然,我们还需要一个嵌入了 net.Conn 的结构体,该结构体会通过 httpWg.Done() 来减少 Close() 上的计数:

typegracefulConnstruct{ net.Conn } func(wgracefulConn)Close()error{ httpWg.Done() returnw.Conn.Close() }

如果要使用上述优美版本的 Listener,我们需要将 server.Serve(l) 行替换为:

netListener=newGracefulListener(l) server.Serve(netListener)

还有一件事。你应避免挂起客户端无意关闭的连接。最好按以下方式创建服务:

server:=&http.Server{ Addr:"0.0.0.0:8888", ReadTimeout:10*time.Second, WriteTimeout:10*time.Second, MaxHeaderBytes:1<<16}


via: https://grisha.org/blog/2014/06/03/graceful-restart-in-golang/

作者:humblehack[11]译者:咔叽咔叽[12]校对:lxbwolf[13]

本文由 GCTT[14] 原创编译,Go 中文网[15]

参考资料

[1]

Florian von Bock: https://github.com/fvbock

[2]

Endless: https://github.com/fvbock/endless

[3]

exec.Command: https://golang.org/pkg/os/exec/#Command

[4]

Cmd 结构体: https://golang.org/pkg/os/exec/#Cmd

[5]

net.Listener: https://golang.org/pkg/net/#Listener

[6]

dup(2): https://pubs.opengroup.org/onlinepubs/009695399/functions/dup.html

[7]

标识: https://pubs.opengroup.org/onlinepubs/009695399/functions/fcntl.html

[8]

sync.WaitGroup: https://golang.org/pkg/sync/#WaitGroup

[9]

Jeff R. Allen: http://nella.org/jra/

[10]

文章: http://blog.nella.org/zero-downtime-upgrades-of-tcp-servers-in-go/

[11]

humblehack: https://twitter.com/humblehack

[12]

咔叽咔叽: https://github.com/watermelo

[13]

lxbwolf: https://github.com/lxbwolf

[14]

GCTT: https://github.com/studygolang/GCTT

[15]

Go 中文网: https://studygolang.com




喜欢本文的朋友,欢迎关注“Go语言中文网”

http服务怎么重启,(1)

栏目热文

文档排行

本站推荐

Copyright © 2018 - 2021 www.yd166.com., All Rights Reserved.