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

 更新时间:2020年12月14日 14:35:46   作者:返回主页千里之行,始于足下  
这篇文章主要介绍了golang API开发过程的中的自动重启方式(基于gin框架),本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

概要

基于 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 API开发过程的中的自动重启方式(基于gin框架)的文章就介绍到这了,更多相关golang API 自动重启内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • golang 如何自动下载所有依赖包

    golang 如何自动下载所有依赖包

    这篇文章主要介绍了golang 自动下载所有依赖包的操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-04-04
  • GoLang中的iface 和 eface 的区别解析

    GoLang中的iface 和 eface 的区别解析

    iface 和 eface 都是 Go 中描述接口的底层结构体,区别在于 iface 描述的接口包含方法,而 eface 则是不包含任何方法的空接口:interface{},这篇文章主要介绍了GoLang之iface 和 eface 的区别,需要的朋友可以参考下
    2022-09-09
  • Go语言基础知识点介绍

    Go语言基础知识点介绍

    在本篇文章里小编给大家整理的是一篇关于Go语言基础知识点介绍内容,有兴趣的朋友们可以跟着学习参考下。
    2021-07-07
  • go doudou开发单体RESTful服务快速上手教程

    go doudou开发单体RESTful服务快速上手教程

    这篇文章主要为大家介绍了go doudou开发单体RESTful服务快速上手教程,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-12-12
  • golang踩坑实战之channel的正确使用方式

    golang踩坑实战之channel的正确使用方式

    Golang channel是Go语言中一个非常重要的特性,除了用来处理并发编程的任务中,它还可以用来进行消息传递和事件通知,这篇文章主要给大家介绍了关于golang踩坑实战之channel的正确使用方式,需要的朋友可以参考下
    2023-06-06
  • 详解Go语言运用广度优先搜索走迷宫

    详解Go语言运用广度优先搜索走迷宫

    广度优先搜索是从图中的某一顶点出发,遍历每一个顶点时,依次遍历其所有的邻接点,再从这些邻接点出发,依次访问它们的邻接点,直到图中所有被访问过的顶点的邻接点都被访问到。然后查看图中是否存在尚未被访问的顶点,若有,则以该顶点为起始点,重复上述遍历的过程
    2021-06-06
  • 深入浅析Go中三个点(...)用法

    深入浅析Go中三个点(...)用法

    这篇文章主要介绍了深入浅析Go中三个点(...)用法,需要的朋友可以参考下
    2021-10-10
  • 详解minio分布式文件存储

    详解minio分布式文件存储

    MinIO 是一款基于 Go 语言的高性能、可扩展、云原生支持、操作简单、开源的分布式对象存储产品,这篇文章主要介绍了minio分布式文件存储,需要的朋友可以参考下
    2023-10-10
  • go中值传递和指针传递的使用

    go中值传递和指针传递的使用

    在Go语言中,使用&和*可以分别取得变量的地址和值,解引用未初始化或为nil的指针会引发空指针异常,正确的做法是先进行nil检查,此外,nil在Go中用于多种类型的空值表示,值传递和指针传递各有适用场景,通常小型数据结构优先考虑值传递以减少解引用开销
    2024-10-10
  • 浅谈Gin框架中bind的使用

    浅谈Gin框架中bind的使用

    Gin框架中有bind函数,可以非常方便的将url的查询参数query parameter、http的Header,body中提交上来的数据格式,本文就详细的介绍Gin框架中bind的使用,感兴趣的可以了解一下
    2021-12-12

最新评论