golang 热更新技巧

序言

Golang标准库的http部分提供了强大的web应用支持,再加上negroni等中间件框架的支持,可以开发高性能的web应用(如提供Restful的api服务等)。
通常这些web应用部署在多台Linux操作系统的应用服务器上,并用Nginx等做为反向代理,实现高可用的集群服务。当应用版本升级时,如何实现比较优雅的多态服务器的版本更新呢?

问题分析

Web应用的更新,我觉得可能需要考虑几个方面的问题:

  1. 编译好的应用二进制文件、配置文件上传到服务器上;
  2. 应用服务器能感知到有新的版本上传;
  3. 在没有停止服务的情况下,热更新版本;
  4. 最好所有的更新过程,可以脚本化,减少手动操作的错误。

方案

其实,go社区有一些开源项目,可以自动检测web应用的改变,并实现自动的更新,但这些应用都是检测源码、资源文件的更新,启动build过程,实现自动的编译和重启,例如 ginfresh,这些应用适合应用于开发和测试阶段,可能并不适合应用的部署和更新,但提供了良好的思路。

部署环境的目录及版本的上传
我将发布的应用二进制文件和配置文件,存放在某个目录下,如 ~/app/release,每个版本都保留在这个目录中,例如 app.1.0、app.1.1、app.2.0,一旦发现有问题,可以及时的回滚。
同时,在~/app目录下,利用软链接文件,指向到最新版本,如

ln -s ~/app/release/app.2.0 ~/app/app.bin

此外,利用一个保存在 ~/app/release 下的文本文件,来指明当前应用的版本,如current.conf:

{
    "bin.file": "~/app/release/app.2.0",
    "cfg.file": "~/app/release/cfg.2.0"
}

当需要更新服务器的版本时,可以通过脚本调用scp,将新版本上传到release目录下,然后更新current.conf文件。
监控current.conf文件,获知版本更新
current.conf文件中是当前的版本,一旦这个文件发生变化,即表示有版本需要更新(或者回滚),我们只需要监控这个文件的变化,一旦发生变化,则做相应的处理。文件的监控,可以通过 fsnotify来实现。

func watch() {
    watcher, err := fsnotify.NewWatcher()
    if err != nil {
        logger.Fatal(err)
    }
    defer watcher.Close()

    go func() {
        for {
                select {
                case event := <-watcher.Events:
                    logger.Println("event:", event)
                    if event.Op&fsnotify.Write == fsnotify.Write {
                        logger.Println("notify runner to do the ln -s and restart server.")
                        restartChan <- true
                    }
                case err := <-watcher.Errors:
                    logger.Println("error:", err)
            }
        }
    }()

    err = watcher.Add("/path/to/current.conf")
    if err != nil {
        logger.Fatal(err)
    }

    <- make(chan bool)
}

重启服务
监控到current.conf文件的变化后,接下来就是重启服务。
为了让服务不中断,优雅的进行重启,可以利用 endless 来替换标准库net/http的ListenAndServe:

 n := negroni.New()
    n.Use(middleware.NewRecovery())
    n.Use(middleware.NewMaintainMiddleware())
    n.Use(middleware.NewLogMiddleware())
    n.Use(middleware.NewStatic(http.Dir("static")))
    n.UseHandler(router.NewRouter())

    log.Fatal(endless.ListenAndServe(":3000", n))

在current.conf变更后,首先将~/app下的软链接文件指向最新版本,然后利用

kill -HUP

通知应用重启。

func run() {
    for {
        <- restartChan

        c, err := ioutil.ReadFile("/path/to/current.conf")
        if err != nil {
            logger.Println("current.conf read error:", err)
            return
        }

        var j interface{}
        err = json.Unmarshal(c, &j)
        if err != nil {
            logger.Println("current.conf parse error:", err)
            return
        }

        parsed, ok := j.(map[string]interface{})
        if !ok {
            logger.Println("current.conf parse error: mapping errors")
            return
        }

        exec.Command("rm", "app.bin").Run()
        exec.Command("ln", "-s", parsed["bin.file"].(string), "app.bin").Run()

        exec.Command("rm", "app.conf").Run()
        exec.Command("ln", "-s", parsed["cfg.file"].(string), "app.cfg").Run()

        if !started {
            cmd := exec.Command("./app.bin", "-c", "app.cfg")
            started = true
        } else {
            processes, _ := ps.Processes()
            for _, v := range processes {
                if strings.Contains(v.Executable(), parsed["bin.file"]) {
                    process, _ := os.FindProcess(v.Pid())
                    process.Signal(syscall.SIGHUP)
                }
            }
        }
    }
}

推荐阅读更多精彩内容