golang API开发过程的中的自动重启方式(基于gin框架)

(编辑：jimmy 日期: 2024/12/28 浏览：3 次 )

概要

基于 golang Gin 框架开发 web 服务时, 需要时不时的 go build , 然后重启服务查看运行结果.
go build 的过程集成在编辑器中(emacs), 可以通过快捷键迅速完成, 但是每次重启服务都切换到命令行中操作.
因此, 希望能够编译通过之后自动重启服务.

这里并不是部署阶段的服务重启, 所以不用过多考虑是否正常退出其中的协程.

实现方式

在开源的 illuminant 项目中, 已经将相应的代码集成到 gin 的 debug mode 中.

代码文件: https://gitee.com/wangyubin/illuminant/blob/dev/server_cmd.go

 func setupWatcher() (chan struct{}, error) {
  file, err := osext.Executable()
   if err != nil {
   return nil, err
   }
  log.Printf("watching %q\n", file)
   w, err := fsnotify.NewWatcher()
   if err != nil {
   return nil, err
  }
  done := make(chan struct{})
  go func() {
   select {
   case e := <-w.Events:
    log.Printf("watcher received: %+v", e)
    err := syscall.Exec(file, os.Args, os.Environ())
    if err != nil {
     log.Fatal(err)
    }
   case err := <-w.Errors:
    log.Printf("watcher error: %+v", err)
   case <-done:
    log.Print("watcher shutting down")
    return
   }
  }()
  err = w.Add(file)
  if err != nil {
   return nil, err
  }
  return done, nil
 }

在 gin debug mode 下, 使用此方法自动重启服务

if c.Bool("prod") {
   gin.SetMode(gin.ReleaseMode)
   // start route
   return routes.Routes(cnf.Server.Port)
  } else {
   gin.SetMode(gin.DebugMode)
   watcher, err := setupWatcher()
   if err != nil {
    // do something sensible
   log.Fatal(err)
  }
  defer close(watcher)
  return routes.Routes(cnf.Server.Port)
 }

补充

上面函数的核心有以下两点:

w, err := fsnotify.NewWatcher(): 创建监控文件变化的 watcher, err = w.Add(file) 并将当前二进制文件加入到监控文件列表中
err := syscall.Exec(file, os.Args, os.Environ()) 接受到文件变化的事件时, 重新调用一次自己, 使用上次一样的参数和环境变量

syscall.Exec

对于这个函数, 一般可能用的比较少, 这里稍微介绍下. 它有 3 个参数:

args[0]: 可执行文件的路径(相对路径, 绝对路径或者 PATH 中的路径都可以)
args[1]: 命令的参数
args[2]: 命令的执行的环境变量, os.Environ() 表示继承 caller 的环境变量

当 syscall.Exec 执行时, 在它之前的所有未执行完的程序都会被中止(包括在 go routine 中执行的程序),
然后执行 syscall.Exec 调用的命令, 该命令还保持在之前程序的 PID 下执行.

syscall.Exec 是最后一条执行的代码, 重启时在它之后可以有代码, 但是都不会被执行到, 包括 defer 中的代码.

下面是个小例子(通过这个例子可以验证上面的结论):

package main
  
  import (
  "fmt"
  "log"
  "os"
  "syscall"
  "time"
  
  "github.com/fsnotify/fsnotify"
  "github.com/kardianos/osext"
 )
 
 func syscallExec() {
  watcher, err := setupWatcher()
  if err != nil {
   log.Fatal(err)
  }
  defer finally(watcher)
 
  fmt.Printf("current pid: %d\n", os.Getpid())
  var count = 0
 
  go func(count int) {
   for {
    fmt.Printf("> count in GO ROUTINE: %d\n", count)
    count++
    time.Sleep(1 * time.Second)
   }
  }(count)
 
  for {
   fmt.Printf("> count in MAIN: %d\n", count)
   count++
   time.Sleep(1 * time.Second)
  }
 }
 
 func finally(watcher chan struct{}) {
  // 重启时没有执行此函数
  fmt.Println("exit original exec")
  close(watcher)
 }
 
 func setupWatcher() (chan struct{}, error) {
  file, err := osext.Executable()
  if err != nil {
   return nil, err
  }
  log.Printf("watching %q\n", file)
  w, err := fsnotify.NewWatcher()
  if err != nil {
   return nil, err
  }
  done := make(chan struct{})
  go func() {
   select {
   case e := <-w.Events:
    log.Printf("watcher received: %v", e)
    err := syscall.Exec(file, os.Args, os.Environ())
    if err != nil {
     log.Fatal(err)
    }
   case err := <-w.Errors:
    log.Printf("watcher error: %+v", err)
   case <-done:
    log.Print("watcher shutting down")
    return
   }
  }()
  err = w.Add(file)
  if err != nil {
   return nil, err
  }
  return done, nil
 }

上一篇：golang 设置web请求状态码操作
下一篇：解决Goland中利用HTTPClient发送请求超时返回EOF错误DEBUG