Go mod 好菜系列 - 0x05 viper 把配置从代码里请出去

从配置文件、环境变量、默认值和热更新角度详细讲 viper,看看它怎么帮你把项目配置真正组织起来。

只要项目稍微长一点,配置迟早会变成一个很现实的问题。数据库地址、端口、Redis、JWT 密钥、日志级别、运行环境,这些东西一开始你可能图快直接写在代码里,但只要环境一多,这种写法马上就会开始反噬你。

viper 是来解决什么的

它最核心的价值,是帮你把配置来源统一起来。你可以从:

  • 配置文件
  • 环境变量
  • 默认值
  • 命令行参数衔接

把这些来源揉成一套比较稳定的读取方式。

一个最常见的起手式

viper.SetConfigName("config")
viper.SetConfigType("yaml")
viper.AddConfigPath(".")
viper.AddConfigPath("./configs")

if err := viper.ReadInConfig(); err != nil {
    return err
}

这段代码的意思很朴素:去这些路径找一个叫 config.yaml 的文件,然后读进来。

配置文件读起来为什么比环境变量舒服

因为很多配置是有结构的。比如:

app:
  port: 8080

mysql:
  dsn: "user:pass@tcp(127.0.0.1:3306)/demo"

redis:
  addr: "127.0.0.1:6379"

如果全靠环境变量当然也能做,但层级感会差一些。配置文件尤其适合本地开发和多配置项项目。

默认值也很实用

viper.SetDefault("app.port", 8080)
viper.SetDefault("log.level", "info")

默认值的意义不是偷懒,而是让你的程序在配置缺一小块时不至于立刻罢工。尤其是那些“有默认值就能跑”的选项,完全值得提前设好。

环境变量衔接

viper.AutomaticEnv()
viper.SetEnvPrefix("APP")

这样你就可以让环境变量去覆盖配置文件。这个模式在部署时特别好用:本地开发用 yaml,线上用环境变量改关键项。

绑定到结构体才更像样

type Config struct {
    App struct {
        Port int `mapstructure:"port"`
    } `mapstructure:"app"`
    MySQL struct {
        DSN string `mapstructure:"dsn"`
    } `mapstructure:"mysql"`
}

var cfg Config
if err := viper.Unmarshal(&cfg); err != nil {
    return err
}

这一步非常关键。很多人用 viper 用了半天,最后还是满项目写字符串 key 去取值,结果配置系统也变成了另一种散乱。绑结构体以后,配置才真正开始像一份“模型”。

热更新能用,但别先冲动

viper 确实支持监听配置文件变化,但这功能不是每个项目都需要。很多服务配置在启动时读一次已经够了。别因为看见它能热更新,就强行给项目加一层动态复杂度。

viper 最适合的项目位置

通常是启动阶段统一加载一次,然后把解析好的配置结构体往下传。别让业务代码到处直接 import viper 然后边走边读,那样后面很难维护,也难测试。

小结

viper 这道菜属于那种“看起来不炫,但工程里很常吃”的类型:

  • 它让配置文件、环境变量和默认值能统一管理
  • 配置最好最后落到结构体,而不是一地字符串 key
  • 它适合放在启动阶段统一处理
  • 热更新是可选项,不是必选项

下一篇我们收这一套系列的最后一口:cobra。虽然它不是 Web 项目必备,但凡是涉及 CLI、脚手架、管理命令的 Go 工程,几乎总会碰到它。

Read more

序章:长夜之后

后来的历史书把那一天称为“长夜之后”。 这个名字并不准确。事情发生在地球上的许多个白天和夜晚之间,发生在不同经度的清晨、午后、傍晚,发生在地下库房、山体掩体、海军基地、荒原试验场和无人值守的材料贮存井里。它既不是一场战争,也不是一次统一指挥的袭击。没有人按下那个能够解释一切的按钮。 但历史需要一个名称。 “长夜之后”最终被保留下来,是因为调查者在追溯事件源头时,不得不一次又一次回到海王星。回到那颗距离太阳太远、光照近乎吝啬的蓝色行星。回到六名中国宇航员死去的地方。回到一艘核动力科考船熄灭后的漫长黑暗。 在联合调查委员会公开的第一版报告中,事件时间线被压缩成了一页表格。 2030年9月,问海一号在海王星附近失联。 2034年11月,问海二号抵达失事区域,确认问海一号全员死亡。 2035年1月,问海二号完成样本封装,开始返航。 2038年6月,海王星样本进入地球高等级隔离实验室。 2038年7月,全球多个核材料设施发生不可逆事故,部分核电站进入最高级别应急。 2038年8月,所有已知核武库事实上失效,全球核电装机大规模停运。 这张表格后来被反复引用,因为它足够冷静,也

By Fuyu Jia

第一章:四小时以前的地球

林予舟第一次听见“问海一号”的最后通信,是在距离地面三百九十公里的轨道上。 那不是一个适合听遗言的地方。 舷窗外,地球从飞船腹侧缓慢转过去,云层像被谁铺平的白色金属屑,青藏高原的阴影压在晨昏线上。太阳还没有完全越出地平线,近地轨道的黑暗因此显得很薄,像一层马上要被擦掉的墨。 “链路稳定。”林予舟说。 他的声音被舱内麦克风收进去,压缩,打包,送进中继卫星,再落回海南深空任务中心。延迟不到一秒。这样奢侈的实时感,在他们离开地月系统后会迅速消失。等飞船抵达海王星附近,地球说一句话,要四个小时左右才能抵达;他们回一句,地球也要再等四个小时。 对话会变成考古。 控制台上方的状态灯一排排亮着,绿色多得几乎让人不安。问海二号还在近地轨道泊位上,推进舱、居住舱、通信桁架和补给舱刚完成最后一次组合检查。它不像公众宣传片里那样优雅。现实中的深空飞船更像一串被迫相互妥协的工程物:银灰色隔热层、外露管线、姿控喷口、展开到一半的高增益天线,所有东西都为了质量、功耗、散热和冗余让步。 它也不像一艘该去海王星的船。 至少不像一艘该去救援核动力深空飞船的船。 问海二号没有主反应堆。 这件事在公开报

By Fuyu Jia

第二章:没有核反应堆的船

发射前四十分钟,林予舟收到了一条来自地面的私人通信。 通信被压在任务数据包后面,标记为低优先级。它随着推进剂温度曲线、姿态平台校准结果、医学监测基线和最后一版逃逸窗口修正量一起进入问海二号的主机,像一枚被夹在工具箱里的薄纸片。 林予舟本来不该在这个时候打开它。 发射前四十分钟,人的每一个动作都应当有明确目的。检查阀门状态,确认加压序列,复诵逃逸程序,核对地面口令。人的情绪如果在这个时候出现,就应该被折叠起来,放进某个不影响任务的地方。 他还是点开了。 画面里是母亲的厨房。抽油烟机没有开,镜头被热气熏得微微发白。桌上摆着一碗面,青菜、荷包蛋和切得很薄的牛肉。母亲没有出镜,只在画面外说:“我知道你现在不能吃,等回来再吃也一样。” 林予舟看着那碗面,隔了几秒才意识到自己没有呼吸。 “怎么了?”沈从越问。 “私人包。” “家里?” “嗯。” “看完删掉。”沈从越说,“别让它留在主屏缓存里。发射时系统会重排任务窗口,乱七八糟的东西越少越好。” 他语气平淡,不像关心,也不像责备。沈从越说话常常这样,像把所有情绪都预先压成了流程。林予舟关掉视频,把它转存进私人存储区。那碗面从

By Fuyu Jia

第三章:地球变成录音

离开地月系统后的第十九天,林予舟第一次觉得,地球不是一个地方,而是一种延迟。 最初的几天,通信仍然近乎实时。地面问,他们答;他们报数,地面确认。贺岚的声音穿过中继链路抵达舱内时,还带着地球上办公室的秩序感:清晰、稳定、克制。林予舟甚至能从她停顿的长度判断总控大厅里有多少人在看同一块屏幕。 后来,停顿被拉长。 五秒。 十七秒。 一分钟。 再后来,地球的每一句话都像从更早的时间里寄来。母亲发来的第二条视频在一个姿态修正段后抵达。她说北京降温了,问他那边冷不冷。林予舟看着舷窗外没有温度的黑暗,忽然不知道该怎么回答。 他当然冷。 但那不是气温。 “私人日志,任务日二十。”他说,“今天第一次做梦,梦见自己回到地面,站在厨房里。锅里有水,水一直不开。母亲在旁边说火太小,我低头看,灶台下面接着的是问海二号的离子推进器。” 他说完后,自己笑了一下。 笑声在舱内很短,很快被风机吞掉。 沈从越从设备舱飘过,听见最后半句:“梦境记录?” “心理监测要求。” “别把自己写得太正常。

By Fuyu Jia