快捷導(dǎo)航

Air實(shí)現(xiàn)Go程序?qū)崟r(shí)熱重載使用過程解析示例

更新時(shí)間：2022年04月16日 13:41:17 作者：Jeff的技術(shù)棧

這篇文章主要為大家介紹了Air實(shí)現(xiàn)Go程序?qū)崟r(shí)熱重載使用過程解析示例，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步早日升職加薪

前言

今天我們要介紹一個(gè)神器——Air能夠?qū)崟r(shí)監(jiān)聽項(xiàng)目的代碼文件，在代碼發(fā)生變更之后自動(dòng)重新編譯并執(zhí)行，大大提高gin框架項(xiàng)目的開發(fā)效率。

為什么需要實(shí)時(shí)加載？

之前使用Python編寫Web項(xiàng)目的時(shí)候，常見的Flask或Django框架都是支持實(shí)時(shí)加載的，你修改了項(xiàng)目代碼之后，程序能夠自動(dòng)重新加載并執(zhí)行（live-reload），這在日常的開發(fā)階段是十分方便的。

在使用Go語言的gin框架在本地做開發(fā)調(diào)試的時(shí)候，經(jīng)常需要在變更代碼之后頻繁的按下Ctrl+C停止程序并重新編譯再執(zhí)行，這樣就不是很方便。

Air介紹

怎樣才能在基于gin框架開發(fā)時(shí)實(shí)現(xiàn)實(shí)時(shí)加載功能呢？像這種煩惱肯定不會(huì)只是你一個(gè)人的煩惱，所以我報(bào)著肯定有現(xiàn)成輪子的心態(tài)開始了全網(wǎng)大搜索。果不其然就在Github上找到了一個(gè)工具：Air。它支持以下特性：

彩色日志輸出
自定義構(gòu)建或二進(jìn)制命令
支持忽略子目錄
啟動(dòng)后支持監(jiān)聽新目錄
更好的構(gòu)建過程

安裝Air

Go

這也是最經(jīng)典的安裝方式：

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中運(yùn)行你的項(xiàng)目：

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

為了敲命令時(shí)更簡(jiǎn)單更方便，你應(yīng)該把alias air='~/.air'加到你的.bashrc或.zshrc中。

首先進(jìn)入你的項(xiàng)目目錄：

cd /path/to/your_project

最簡(jiǎn)單的用法就是直接執(zhí)行下面的命令：

# 首先在當(dāng)前目錄下查找 `.air.conf`配置文件，如果找不到就使用默認(rèn)的
air -c .air.conf

推薦的使用方法是：

# 1. 在當(dāng)前目錄創(chuàng)建一個(gè)新的配置文件.air.conf
touch .air.conf
# 2. 復(fù)制 `air.conf.example` 中的內(nèi)容到這個(gè)文件，然后根據(jù)你的需要去修改它
# 3. 使用你的配置運(yùn)行 air, 如果文件名是 `.air.conf`，只需要執(zhí)行 `air`。
air

air_example.conf示例

完整的air_example.conf示例配置如下，可以根據(jù)自己的需要修改。

# [Air](https://github.com/cosmtrek/air) TOML 格式的配置文件
# 工作目錄
# 使用 . 或絕對(duì)路徑，請(qǐng)注意 `tmp_dir` 目錄必須在 `root` 目錄下
root = "."
tmp_dir = "tmp"
[build]
# 只需要寫你平常編譯使用的shell命令。你也可以使用 `make`
# Windows平臺(tái)示例: cmd = "go build -o tmp\main.exe ."
cmd = "go build -o ./tmp/main ."
# 由`cmd`命令得到的二進(jìn)制文件名
# Windows平臺(tái)示例：bin = "tmp\main.exe"
bin = "tmp/main"
# 自定義執(zhí)行程序的命令，可以添加額外的編譯標(biāo)識(shí)例如添加 GIN_MODE=release
# Windows平臺(tái)示例：full_bin = "tmp\main.exe"
full_bin = "APP_ENV=dev APP_USER=air ./tmp/main"
# 監(jiān)聽以下文件擴(kuò)展名的文件.
include_ext = ["go", "tpl", "tmpl", "html"]
# 忽略這些文件擴(kuò)展名或目錄
exclude_dir = ["assets", "tmp", "vendor", "frontend/node_modules"]
# 監(jiān)聽以下指定目錄的文件
include_dir = []
# 排除以下文件
exclude_file = []
# 如果文件更改過于頻繁，則沒有必要在每次更改時(shí)都觸發(fā)構(gòu)建?？梢栽O(shè)置觸發(fā)構(gòu)建的延遲時(shí)間
delay = 1000 # ms
# 發(fā)生構(gòu)建錯(cuò)誤時(shí)，停止運(yùn)行舊的二進(jìn)制文件。
stop_on_error = true
# air的日志文件名，該日志文件放置在你的`tmp_dir`中
log = "air_errors.log"
[log]
# 顯示日志時(shí)間
time = true
[color]
# 自定義每個(gè)部分顯示的顏色。如果找不到顏色，使用原始的應(yīng)用程序日志。
main = "magenta"
watcher = "cyan"
build = "yellow"
runner = "green"
[misc]
# 退出時(shí)刪除tmp目錄
clean_on_exit = true