概要
基于 golang Gin 框架開發(fā) web 服務(wù)時, 需要時不時的 go build , 然后重啟服務(wù)查看運(yùn)行結(jié)果.
go build 的過程集成在編輯器中(emacs), 可以通過快捷鍵迅速完成, 但是每次重啟服務(wù)都切換到命令行中操作.
因此, 希望能夠編譯通過之后自動重啟服務(wù).
這里并不是部署階段的服務(wù)重啟, 所以不用過多考慮是否正常退出其中的協(xié)程.
實(shí)現(xiàn)方式
在開源的 illuminant 項目中, 已經(jīng)將相應(yīng)的代碼集成到 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 下, 使用此方法自動重啟服務(wù)
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)
}
補(bǔ)充
上面函數(shù)的核心有以下兩點(diǎn):
- w, err := fsnotify.NewWatcher(): 創(chuàng)建監(jiān)控文件變化的 watcher, err = w.Add(file) 并將當(dāng)前二進(jìn)制文件加入到監(jiān)控文件列表中
- err := syscall.Exec(file, os.Args, os.Environ()) 接受到文件變化的事件時, 重新調(diào)用一次自己, 使用上次一樣的參數(shù)和環(huán)境變量
syscall.Exec
對于這個函數(shù), 一般可能用的比較少, 這里稍微介紹下. 它有 3 個參數(shù):
- args[0]: 可執(zhí)行文件的路徑(相對路徑, 絕對路徑或者 PATH 中的路徑都可以)
- args[1]: 命令的參數(shù)
- args[2]: 命令的執(zhí)行的環(huán)境變量, os.Environ() 表示繼承 caller 的環(huán)境變量
當(dāng) syscall.Exec 執(zhí)行時, 在它之前的所有未執(zhí)行完的程序都會被中止(包括在 go routine 中執(zhí)行的程序),
然后執(zhí)行 syscall.Exec 調(diào)用的命令, 該命令還保持在之前程序的 PID 下執(zhí)行.
syscall.Exec 是最后一條執(zhí)行的代碼, 重啟時在它之后可以有代碼, 但是都不會被執(zhí)行到, 包括 defer 中的代碼.
下面是個小例子(通過這個例子可以驗證上面的結(jié)論):
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{}) {
// 重啟時沒有執(zhí)行此函數(shù)
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
}
到此這篇關(guān)于golang API開發(fā)過程的中的自動重啟方式(基于gin框架)的文章就介紹到這了,更多相關(guān)golang API 自動重啟內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
您可能感興趣的文章:- 使用Golang簡單實(shí)現(xiàn)七牛圖片處理API
- Laravel框架執(zhí)行原生SQL語句及使用paginate分頁的方法
- Flask框架Flask-Login用法分析
- Go Web框架gin的入門教程
- Python的Flask框架及Nginx實(shí)現(xiàn)靜態(tài)文件訪問限制功能
- PHP框架Laravel插件Pagination實(shí)現(xiàn)自定義分頁
- 使用Nginx+uWsgi實(shí)現(xiàn)Python的Django框架站點(diǎn)動靜分離
