Air实现Go程序实时热加载
在使用Go语言的gin框架在本地做开发调试的时候,经常需要在变更代码之后频繁的按下Ctrl+C
停止程序并重新编译再执行,这样就不是很方便,此博客全部基于window!!!
基于李文周老师博客进行修改自定义李文周
Air介绍
Air它支持以下特性:
- 彩色日志输出
- 自定义构建或二进制命令
- 支持忽略子目录
- 启动后支持监听新目录
- 更好的构建过程
安装Air
使用 go install
使用 Go 的版本为 1.16 或更高:
go install github.com/cosmtrek/air@latest
使用Air
为了敲命令时更简单更方便,你应该把alias air='~/.air'
加到你的.bashrc
或.zshrc
中。
首先进入你的项目目录:
cd /path/to/your_project
最简单的用法就是直接执行下面的命令:
# 首先在当前目录下查找 `.air.toml`配置文件,如果找不到就使用默认的
air -c .air.toml
您可以运行以下命令初始化,把默认配置添加到当前路径下的.air.toml
文件。
air init
在这之后,你只需执行 air
命令,无需添加额外的变量,它就能使用 .air.toml
文件中的配置了。
air
推荐的使用方法是:
# 1. 在当前目录创建一个新的配置文件.air.toml
touch .air.toml
# 2. 复制 `air.conf.example` 中的内容到这个文件,然后根据你的需要去修改它
# 3. 使用你的配置运行 air, 如果文件名是 `.air.conf`,只需要执行 `air`。
air
air_example.toml示例
官方网址:air_example.toml
完整的air_example.toml
示例配置如下,可以根据自己的需要修改。
# [Air](https://github.com/cosmtrek/air) TOML 格式的配置文件
# 工作目录
# 使用 . 或绝对路径,请注意 `tmp_dir` 目录必须在 `root` 目录下
root = "."
tmp_dir = "tmp"
[build]
# 只需要写你平常编译使用的shell命令。
cmd = "go build -o ./tmp/main.exe"
# 由`cmd`命令得到的二进制文件名
bin = "./tmp/main.exe"
# 自定义执行程序的命令,可以添加额外的编译标识
full_bin = "./tmp/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是后面添加配置文件路径
air ./conf/config.yaml
-
启动Air报错提示Window缺少"xxx"文件
Air toml配置文件中,可能存在Linux或者Mac下的命令语句