第十五:使用Air实现Go程序实时热重载

Air介绍

怎样才能在基于gin框架开发时实现实时加载功能呢?像这种烦恼肯定不会只是你一个人的烦恼,所以我报着肯定有现成轮子的心态开始了全网大搜索。果不其然就在Github上找到了一个工具:Air。它支持以下特性:

  1. 彩色日志输出
  2. 自定义构建或二进制命令
  3. 支持忽略子目录
  4. 启动后支持监听新目录
  5. 更好的构建过程

安装Air

Go

这也是最经典的安装方式:

复制代码
go get -u github.com/cosmtrek/air
MacOS
复制代码
curl -fLo air https://git.io/darwin_air
Linux
复制代码
curl -fLo air https://git.io/linux_air
Windows
复制代码
curl -fLo air.exe https://git.io/windows_air
Docker
复制代码
docker run -it --rm \
    -w "<PROJECT>" \
    -e "air_wd=<PROJECT>" \
    -v $(pwd):<PROJECT> \
    -p <PORT>:<APP SERVER PORT> \
    cosmtrek/air
    -c <CONF>

然后按照下面的方式在docker中运行你的项目:

复制代码
docker run -it --rm \
    -w "/go/src/github.com/cosmtrek/hub" \
    -v $(pwd):/go/src/github.com/cosmtrek/hub \
    -p 9090:9090 \
    cosmtrek/air

使用Air

为了敲命令时更简单更方便,你应该把alias air='~/.air'加到你的.bashrc.zshrc中。

首先进入你的项目目录:

复制代码
cd /path/to/your_project

最简单的用法就是直接执行下面的命令:

复制代码
# 首先在当前目录下查找 `.air.conf`配置文件,如果找不到就使用默认的
air -c .air.conf

推荐的使用方法是:

复制代码
# 1. 在当前目录创建一个新的配置文件.air.conf
touch .air.conf

# 2. 复制 `air.conf.example` 中的内容到这个文件,然后根据你的需要去修改它

# 3. 使用你的配置运行 air, 如果文件名是 `.air.conf`,只需要执行 `air`。
air
air_example.conf示例

完整的air_example.conf示例配置如下,可以根据自己的需要修改。

复制代码
# [Air](https://github.com/cosmtrek/air) TOML 格式的配置文件

# 工作目录
# 使用 . 或绝对路径,请注意 `tmp_dir` 目录必须在 `root` 目录下
root = "."
tmp_dir = "tmp"

[build]
# 只需要写你平常编译使用的shell命令。你也可以使用 `make`
# Windows平台示例: cmd = "go build -o tmp\main.exe ."
cmd = "go build -o ./tmp/main ."
# 由`cmd`命令得到的二进制文件名
# Windows平台示例:bin = "tmp\main.exe"
bin = "tmp/main"
# 自定义执行程序的命令,可以添加额外的编译标识例如添加 GIN_MODE=release
# Windows平台示例:full_bin = "tmp\main.exe"
full_bin = "APP_ENV=dev APP_USER=air ./tmp/main"
# 监听以下文件扩展名的文件.
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,感受实时重新加载的便利吧。

相关推荐
观无2 分钟前
c#中的virtual方法
开发语言·c#
2401_840192278 分钟前
git的作用,以及和github的区别
开发语言·经验分享·git·python·devops
lamdaxu19 分钟前
Java基础 - 注解机制详解
后端
Lemon12522 分钟前
DeepSpeed多机多卡微调实验记录
后端
ClarkLee23 分钟前
控制反转(IOC)及依赖注入(DI)详解
后端
紧跟先前的步伐43 分钟前
【Golang】第十一弹------反射
开发语言·后端·golang
一人の梅雨1 小时前
西域平台关键字搜索接口开发指南
java·开发语言·数据库
Code_Geo1 小时前
pyproj 库中 Geod 类讲解
开发语言·python·geod·pyproj
三木SanMu1 小时前
LangChain基础系列之LLM接口详解:从原理到实战的全攻略
后端
失业写写八股文1 小时前
Spring基础:Spring特性与优势
后端·spring