使用AIR热加载Go程序

使用AIR热加载Go程序

air是一个用于Go语言项目的热重载工具,它可以监控你的Go代码变化,并在检测到代码变化时自动编译和重启你的应用。这样,你就可以在开发过程中实时看到代码更改的效果,无需手动停止和重新启动应用,极大提高了开发效率。

使用air实现热重载的基本步骤:

  1. 安装
    首先,你需要安装air。可以通过下面的命令来全局安装air

    go install github.com/cosmtrek/air@latest
    go get github.com/air-verse/air@latest
    

    如果遇到路径问题,确保使用正确的模块路径。

  2. 配置
    air使用.air.toml配置文件来定义如何监控文件变化和如何编译重启应用。你可以在项目的根目录下创建一个.air.toml文件,或者使用air init命令生成一个默认的配置文件。这个配置文件是可选的,air也可以使用默认配置运行。

    .air.toml中,你可以配置监控的目录、排除的文件、编译命令、运行命令等。

    # [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
    
  3. 运行

    linux

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

    在项目根目录下,运行air命令来启动热重载监控:

    air
    

    如果你的项目有特定的配置文件路径,可以通过-c参数指定配置文件:

    air -c path/to/your/.air.toml
    

windows:

​ 找到air目录下,执行:

go build .

在目录下会生成 air.exe 文件,将 air.exe 所在目录配置环境变量,执行 air -v 命令查看是否配置成功。

项目终端输入 air 即可启动项目

这样,每当你保存对Go代码的更改时,air会自动编译并重启应用,你可以在开发过程中即时看到更改的效果。

posted @ 2024-06-26 11:07  Showball  阅读(115)  评论(0编辑  收藏  举报