为什么需要实时加载?
在使用 Go 语言的 gin 框架在本地做开发时,经常会在变更代码之后重新编译运行整个程序,开发起来效率很低。
Air
air 是 Go 语言的热加载工具,它可以监听文件或目录的变化,自动编译,重启程序。大大提高开发的工作效率
Git 地址:https://github.com/cosmtrek/air
安装
go get -u github.com/cosmtrek/air
执行成功之后,找到 air 所在目录,我的 air 目录为
F:\gowork\pkg\mod\github.com\cosmtrek
每个人的目录都不一样,自行进入自己的 go 的安装目录寻找
windows配置Air环境变量
进入 air 目录下,执行:
go build .
在目录下会生成 air.exe 文件,将 air.exe 所在目录配置环境变量,执行 air -v 命令查看是否配置成功。
C:\Users\admin>air -v
__ _ ___
/ /\ | | | |_)
/_/--\ |_| |_| \_ , built with Go
C:\Users\admin>
在开发过程中,可能会用到很多第三方包,可以建一个 bin 文件夹,将需要配置的 *.exe 文件放到 bin 文件夹下,就不需要配置多次环境变量了
配置air.conf文件
在项目根目录下创建 .air.conf 文件,将下面代码复制进去
root = "."
tmp_dir = "tmp"
[build]
# 只需要写你平常编译使用的shell命令。你也可以使用 `make`
cmd = "go build -o main.exe ."
# 由`cmd`命令得到的二进制文件名
bin = "main.exe"
# 自定义执行程序的命令,可以添加额外的编译标识例如添加 GIN_MODE=release
full_bin = "main.exe"
# 监听以下文件扩展名的文件.
include_ext = ["go", "tpl", "tmpl", "html"]
# 忽略这些文件扩展名或目录
exclude_dir = ["assets", "tmp", "vendor", "frontend/node_modules"]
# 监听以下指定目录的文件
include_dir = []
# 排除以下文件
exclude_file = []
# 如果文件更改过于频繁,则没有必要在每次更改时都触发构建。可以设置触发构建的延迟时间
delay = 1000 # ms
# 发生构建错误时,停止运行旧的二进制文件。
stop_on_error = true
# air的日志文件名,该日志文件放置在你的`tmp_dir`中
log = "air_errors.log"
[log]
# 显示日志时间
time = true
[color]
# 自定义每个部分显示的颜色。如果找不到颜色,使用原始的应用程序日志。
main = "magenta"
watcher = "cyan"
build = "yellow"
runner = "green"
[misc]
# 退出时删除tmp目录
clean_on_exit = true
运行Air
我这边使用 Go Modules,使用 gin 启动服务,示例代码如下:
main.go 文件
package main
import (
"context"
"log"
"net/http"
"os"
"os/signal"
"time"
"github.com/gin-gonic/gin"
)
func main() {
router := gin.Default()
router.GET("/", func(c *gin.Context) {
c.String(http.StatusOK, "hello world")
})
srv := &http.Server{
Addr: ":8080",
Handler: router,
}
go func() {
// 服务连接
if err := srv.ListenAndServe(); err != nil && err != http.ErrServerClosed {
log.Fatalf("listen: %s\n", err)
}
}()
// 等待中断信号以优雅地关闭服务器(设置 5 秒的超时时间)
quit := make(chan os.Signal)
signal.Notify(quit, os.Interrupt)
<-quit
log.Println("Shutdown Server ...")
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
if err := srv.Shutdown(ctx); err != nil {
log.Fatal("Server Shutdown:", err)
}
log.Println("Server exiting")
}
使用 air 启动,执行命令
air
使用 air,修改代码之后会自动编译,重启,大大提高了开发效率