Air实现Go程序实时热重载

mousemin

发布于 2023-06-10 17:34:09

71100

代码可运行

文章被收录于专栏：mouseminmousemin

运行总次数：0

代码可运行

Air实现Go程序实时热重载

Air能够实时监听项目的代码文件，在代码发生变更之后自动重新编译并执行

为什么需要实时加载？

在使用Go语言在本地做web开发调试的时候，经常需要在修改代码之后频繁的按下Crtl+C停止程序并重新编译执行，这样就比较麻烦

Air介绍

怎样才能在基于web开发实现实时加载功能呢？ Github上有一个现成的工具: Air。它支持以下特性:

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

安装Air

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

1go get -u github.com/cosmtrek/air

Mac、Linux、Window

1# binary will be $(go env GOPATH)/bin/air
2curl -sSfL https://raw.githubusercontent.com/cosmtrek/air/master/install.sh | sh -s -- -b $(go env GOPATH)/bin
3 
4# or install it into ./bin/
5curl -sSfL https://raw.githubusercontent.com/cosmtrek/air/master/install.sh | sh -s

Docker

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

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

1docker run -it --rm \
2    -w "/go/src/github.com/cosmtrek/hub" \
3    -v $(pwd):/go/src/github.com/cosmtrek/hub \
4    -p 9090:9090 \
5    cosmtrek/air

使用Air

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

首先进入你的项目目录：

1cd /path/to/your_project

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

1# 首先在当前目录下查找 `.air.toml`配置文件，如果找不到就使用默认的
2air -c .air.toml

推荐的使用方法是：

1# 1. 在当前目录创建一个新的配置文件.air.toml
2touch .air.toml
3 
4# 2. 复制 `air_example.toml` 中的内容到这个文件，然后根据你的需要去修改它
5 
6# 3. 使用你的配置运行 air, 如果文件名是 `.air.toml`，只需要执行 `air`。
7air

air_example.toml完整示例

air_example.toml示例配置如下，可以根据自己的需要修改。

 1# [Air](https://github.com/cosmtrek/air) TOML 格式的配置文件
 2 
 3# 工作目录
 4# 使用 . 或绝对路径，请注意 `tmp_dir` 目录必须在 `root` 目录下
 5root = "."
 6tmp_dir = "tmp"
 7 
 8[build]
 9# 只需要写你平常编译使用的shell命令。你也可以使用 `make`
10# Windows平台示例: cmd = "go build -o tmp\main.exe ."
11cmd = "go build -o ./tmp/main ."
12# 由`cmd`命令得到的二进制文件名
13# Windows平台示例：bin = "tmp\main.exe"
14bin = "tmp/main"
15# 自定义执行程序的命令，可以添加额外的编译标识例如添加 GIN_MODE=release
16# Windows平台示例：full_bin = "tmp\main.exe"
17full_bin = "APP_ENV=dev APP_USER=air ./tmp/main"
18# 监听以下文件扩展名的文件.
19include_ext = ["go", "tpl", "tmpl", "html"]
20# 忽略这些文件扩展名或目录
21exclude_dir = ["assets", "tmp", "vendor", "frontend/node_modules"]
22# 监听以下指定目录的文件
23include_dir = []
24# 排除以下文件
25exclude_file = []
26# 如果文件更改过于频繁，则没有必要在每次更改时都触发构建。可以设置触发构建的延迟时间 单位: ms
27delay = 1000
28# 发生构建错误时，停止运行旧的二进制文件。
29stop_on_error = true
30# air的日志文件名，该日志文件放置在你的`tmp_dir`中
31log = "air_errors.log"
32 
33[log]
34# 显示日志时间
35time = true
36 
37[color]
38# 自定义每个部分显示的颜色。如果找不到颜色，使用原始的应用程序日志。
39main = "magenta"
40watcher = "cyan"
41build = "yellow"
42runner = "green"
43 
44[misc]
45# 退出时删除tmp目录
46clean_on_exit = true

本文参与腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。

原始发表：2021年06月27日，如有侵权请联系 cloudcommunity@tencent.com 删除