使用Air實現Go程式實時熱過載
阿新 • • 發佈:2022-01-27
今天我們要介紹一個神器——Air能夠實時監聽專案的程式碼檔案,在程式碼發生變更之後自動重新編譯並執行,大大提高gin框架專案的開發效率。
為什麼需要實時載入?
之前使用Python編寫Web專案的時候,常見的Flask或Django框架都是支援實時載入的,你修改了專案程式碼之後,程式能夠自動重新載入並執行(live-reload),這在日常的開發階段是十分方便的。
在使用Go語言的gin框架在本地做開發除錯的時候,經常需要在變更程式碼之後頻繁的按下Ctrl+C
停止程式並重新編譯再執行,這樣就不是很方便。
Air介紹
怎樣才能在基於gin框架開發時實現實時載入功能呢?像這種煩惱肯定不會只是你一個人的煩惱,所以我報著肯定有現成輪子的心態開始了全網大搜索。果不其然就在Github上找到了一個工具: Air。它支援以下特性:
- 彩色日誌輸出
- 自定義構建或二進位制命令
- 支援忽略子目錄
- 啟動後支援監聽新目錄
- 更好的構建過程
安裝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
,感受實時重新載入的便利吧。