Go gin 之 Air 實現實時加載

今天我們要介紹一個神器——Air能夠實時監聽項目的代碼文件，在代碼發生變更之后自動重新編譯並執行，大大提高gin框架項目的開發效率。

　　　　　　　　　　　　　　　　為什么需要實時加載？

---

在使用Go語言的gin框架在本地做開發調試的時候，經常需要在變更代碼之后頻繁的按下Ctrl+C停止程序並重新編譯再執行，這樣就不是很方便。

 

　　　　　　　　　　　　　　　　　　　　Air介紹

---

怎樣才能在基於gin框架開發時實現實時加載功能呢？像這種煩惱肯定不會只是你一個人的煩惱，所以我報着肯定有現成輪子的心態開始了全網大搜索。果不其然就在Github上找到了一個工具：Air。它支持以下特性

1. 彩色日志輸出
2. 自定義構建或二進制命令
3. 支持忽略子目錄
4. 啟動后支持監聽新目錄
5. 更好的構建過程

1、安裝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

 

Dcoker

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

2、使用Air

為了敲命令時更簡單更方便，你應該把alias air='~/.air'加到你的.bashrc或.zshrc中、然后重啟終端或者 source ~/.bashrc 使其生效

首先進入你的項目目錄：

cd go/src/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`
cmd = "go build -o ./tmp/main ."
# 由`cmd`命令得到的二進制文件名
bin = "tmp/main"
# 自定義的二進制，可以添加額外的編譯標識例如添加 GIN_MODE=release
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  #啟動項目  取代之前的 go run main.go

 感受實時重新加載的便利吧。

 

 本文轉自： https://www.liwenzhou.com/posts/Go/live_reload_with_air/