Golang实现Go应用实时热重载开发工具插件库Air的使用

☁️ Air - Go应用实时热重载工具

Air是一个用于Go应用程序开发的实时重载命令行工具。只需在项目根目录运行air命令，它就会监控代码变化并自动重新编译运行你的应用。

功能特性

• 彩色日志输出
• 自定义构建命令
• 支持排除子目录
• 启动后可以添加新的监控目录
• 优化的构建过程

安装方法

推荐使用go install安装

go install github.com/air-verse/air@latest

通过install.sh安装

# 二进制文件会安装到$(go env GOPATH)/bin/air
curl -sSfL https://raw.githubusercontent.com/air-verse/air/master/install.sh | sh -s -- -b $(go env GOPATH)/bin

# 或者安装到./bin/目录
curl -sSfL https://raw.githubusercontent.com/air-verse/air/master/install.sh | sh -s

air -v

使用示例

基本使用

1. 首先进入你的项目目录：

cd /path/to/your_project

1. 初始化配置文件（可选）：

air init

这会生成一个默认的.air.toml配置文件。

1. 启动Air：

air

自定义配置示例

你可以在命令行中直接覆盖配置参数：

air --build.cmd "go build -o bin/api cmd/run.go" --build.bin "./bin/api"

或者使用逗号分隔列表参数：

air --build.cmd "go build -o bin/api cmd/run.go" --build.bin "./bin/api" --build.exclude_dir "templates,build"

运行时参数

你可以传递参数给构建后的二进制文件：

# 会运行 ./tmp/main bench
air bench

# 会运行 ./tmp/main server --port 8080
air server --port 8080

使用--分隔Air参数和程序参数：

# 会运行 ./tmp/main -h
air -- -h

# 使用自定义配置并传递-h参数给程序
air -c .air.toml -- -h

Docker使用示例

直接运行

docker run -it --rm \
    -w "<PROJECT>" \
    -e "air_wd=<PROJECT>" \
    -v $(pwd):<PROJECT> \
    -p <PORT>:<APP SERVER PORT> \
    cosmtrek/air
    -c <CONF>

在shellrc中添加函数

air() {
  podman/docker run -it --rm \
    -w "$PWD" -v "$PWD":"$PWD" \
    -p "$AIR_PORT":"$AIR_PORT" \
    docker.io/cosmtrek/air "$@"
}

配置示例

.air.toml配置文件示例：

[build]
  cmd = "go build -o ./tmp/main ."
  bin = "./tmp/main"
  exclude_dir = ["assets", "tmp", "vendor"]
  include_ext = ["go", "tpl", "tmpl", "html"]
  delay = 1000 # ms
  stop_on_error = true

[log]
  time = false

[color]
  main = "magenta"
  watcher = "cyan"
  build = "yellow"
  runner = "green"

常见问题

命令找不到问题

如果遇到"command not found: air"错误，请确保PATH设置正确：

export GOPATH=$HOME/xxxxx
export PATH=$PATH:$GOROOT/bin:$GOPATH/bin
export PATH=$PATH:$(go env GOPATH)/bin

仅热编译不运行

如果你想只编译不运行，可以这样配置：

[build]
  cmd = "/usr/bin/true"

静态文件修改自动刷新浏览器

确保：

1. 静态文件在include_dir、include_ext或include_file中
2. HTML有</body>标签
3. 启用代理配置：

[proxy]
  enabled = true
  proxy_port = <air proxy port>
  app_port = <your server port>

开发

如果你想参与Air的开发：

# Fork项目
# 克隆
mkdir -p $GOPATH/src/github.com/cosmtrek
cd $GOPATH/src/github.com/cosmtrek
git clone git@github.com:<YOUR USERNAME>/air.git

# 安装依赖
cd air
make ci

# 探索并开始开发
make install

Air是一个强大的Go开发工具，可以显著提高开发效率，避免手动停止和重启服务的麻烦。