GoFrame项目需按环境分离配置以避免误提交和运行异常,具体包括:创建development/testing/production目录结构、删除根config.yaml、确保app.mode与目录名严格一致、通过命令行/环境变量/编译参数指定环境,并用日志验证生效。

在GoFrame项目交付前,必须让开发环境能快速调试、生产环境能稳定运行,而配置混在一起会导致本地改个数据库地址就提交到Git,线上服务直接连错库。
初始化多环境配置目录结构
执行 gf init myapp 后,进入项目根目录,手动创建 config 子目录并按环境拆分:
mkdir -p config/{development,testing,production}
这一步不能跳过——gf CLI 默认只生成 config.yaml 单文件,不建目录会导致后续环境加载失败。
将原 config.yaml 内容剪切,分别存为:
• config/development/config.yaml(含本地MySQL地址、debug=true)
• config/production/config.yaml(含线上DB地址、debug=false、log.level=error)
【必须删除根目录下的 config.yaml】,否则 gf 会优先加载它,覆盖掉环境子目录配置。
配置文件内容规范与关键字段
每个环境的 config.yaml 必须包含 app 和 database 顶层键,且 app.mode 值必须与目录名严格一致:
development/config.yaml 中写:app: { mode: "development" }
production/config.yaml 中写:app: { mode: "production" }
mode 字段不是可选标签,而是 gf 框架启动时自动匹配 config 目录的依据;写错大小写或拼写(如写成 “prod”)会导致框架静默回退到默认配置,数据库连接参数全部失效。
database 配置块中,production 环境必须禁用 debug 并启用 maxIdleConnCount 和 maxOpenConnCount,例如:database: { default: { debug: false, maxIdleConnCount: 20, maxOpenConnCount: 50 } }
启动时指定环境的方法
方法一:命令行参数(推荐用于本地调试)
gf run main.go --env=production
方法二:环境变量(生产部署标准做法)
export GF_ENV=testing && gf run main.go
方法三:编译时嵌入(适合Docker镜像构建)
gf build -a -m production -o app main.go
注意:三种方式优先级为「命令行参数 > 环境变量 > 编译参数」;若同时设置 GF_ENV=development 且加 --env=production,最终生效的是 production。
验证配置是否生效
在 main.go 的 g.Server().Start 前插入一行日志打印:
g.Log().Info(context.TODO(), "current app mode:", g.Cfg().GetString("app.mode"))
运行后观察控制台输出是否与预期环境一致;若输出为空字符串或 “default”,说明配置未加载成功,立即检查 config 目录层级和 app.mode 字段拼写。
这一步操作起来很简单,直接把日志语句加进去就行。











