go热编工具

go热编工具

在使用Go语言的gin框架在本地做开发时候,经常需要在变更代码之后频繁的按下Ctrl+C停止程序并重新编译再执行,这样就不是很方便。

使用热编插件加快你的开发速度

如:Air,gowatch

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

或直接点击下载 直接放在bin 目录即可(如:C:\Program Files\Go\bin)

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

使用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,只需要执行 airair

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 保存后将自动编译

file

gowatch

安装使用

go install github.com/silenceper/gowatch

安装完成之后,即可使用 gowatch 命令,在当前文件执行

相关配置

大部分情况下,不需要更改配置,直接执行 gowatch 命令就能满足的大部分的需要,但是也提供了一些配置用于自定义,在执行目录下创建 gowatch.yml 文件,支持的配置如下:

# gowatch.yml 配置示例

# 当前目录执行下生成的可执行文件的名字,默认是当前目录名
appname: "test"   
# 是否对当前目录下相关依赖执行 ‘go install’命令,将会执行安装依赖
go_install: true
# 需要监听的文件名后缀,默认只有'.go'文件
watch_exts:
    - .yml
# 在执行命令时,需要增加的其他参数
cmd_args:
    - arg1=val1
# 需要增加环境变量,默认已加载当前环境变量
envs:
    - a=b
# 是否监听 ‘vendor’ 文件夹下的文件改变
vendor_watch: false
# 不需要监听的目录名字
excluded_paths:
    - path
# build tags
build_tags: ""
猜你喜欢