GoFrame项目中启用gf run main.go可实现热编译:自动监听.go/.tpl文件变更→触发构建→重启进程;需先安装gf CLI并确保在模块根目录执行,不支持配置文件热重载。

在GoFrame项目中启用gf run热编译功能,可让代码保存后自动重建并重启进程,省去手动go run或gf build→./xxx的重复操作,提升开发调试效率。
确认gf CLI已正确安装并可用
执行gf -v查看版本,输出应包含类似GoFrame CLI Tool v2.6.0字样;若提示命令未找到,请先通过go install github.com/gogf/gf/cmd/gf@latest安装,并确保$GOPATH/bin已加入系统PATH。
这一步不可跳过——【gf run依赖gf CLI工具链,不是单纯go run的封装】,没有gf命令,后续所有热编译指令都会报错。
使用gf run启动热编译服务
进入项目根目录(含go.mod文件),直接运行:
gf run main.go
终端将显示监听日志,如[INFO] Watching files... (press Ctrl+C to exit),此时修改任意.go源文件并保存,gf会自动检测变更→触发go build→杀掉旧进程→启动新二进制。
注意:默认只监听.go和.tpl文件,不监听config/*.yaml等配置文件变更——如需响应配置热重载,需额外集成gcfg或自行监听重载逻辑。
常用调试配置选项
方法一:启用详细日志与调试信息
gf run -a -v main.go 其中-a开启自动重启(默认已启用,显式指定更明确),-v输出编译及启动全过程日志,便于定位构建失败原因。
方法二:指定监听路径与忽略目录
gf run --watch-dir=./internal --ignore-dir=./docs main.go 适用于大型项目,可缩小监听范围,避免因node_modules、vendor等冗余目录变更引发误重启。
方法三:自定义构建标签与环境变量
gf run -tags=dev -env=develop main.go 这会向底层go build传递-tags dev并设置环境变量GF_ENV=develop,使程序内gcfg.MustGet("app.name").String()等配置能按需加载develop.yaml。
⚠️ 注意:-env参数仅设置GF_ENV环境变量,不会自动加载对应环境配置文件——是否生效取决于你的配置初始化逻辑是否调用gcfg.LoadWithFilter或类似机制。
排查热编译失效的典型场景
第一步:检查是否在模块根目录执行gf run 若在子目录(如./cmd/app/)下运行gf run main.go,gf可能无法正确识别go.mod位置,导致构建失败或监听路径错乱。
第二步:确认main.go中无语法错误且可独立编译 gf run本质是包装go build,若代码存在undefined: xxx或import cycle,首次构建即失败,后续保存也不会触发重建。
第三步:验证文件系统事件通知是否就绪 Linux/macOS通常无问题;Windows用户若使用WSL2,需确保项目路径位于WSL文件系统内(而非/mnt/c/…),否则inotify可能无法捕获Windows资源管理器的保存事件。
gf run main.go











