Go mod 好菜系列 - 0x06 cobra 把命令行项目做得像样一点

详细讲 cobra 能做什么、为什么 Go CLI 项目常用它、命令树/flags/执行入口如何组织,以及它在工程里的位置。

如果你写的 Go 项目不只是一个 HTTP 服务,而是还带一些管理命令、运维脚本、导入导出工具,甚至本身就是 CLI 应用,那么你很快就会碰到 cobra。它不是每个项目都必需,但一旦项目开始有命令树,它就会变得很顺手。

cobra 是干嘛的

一句话:它是一个命令行应用框架。你可以用它来组织:

  • 主命令
  • 子命令
  • flags
  • 帮助文档
  • 初始化流程

也就是说,它帮你把一个“会跑的命令行程序”整理成“结构清楚的命令行项目”。

为什么 cobra 常见

因为 Go 生态里很多工具本身就是 CLI,比如:

  • 运维辅助工具
  • 代码生成器
  • 管理后台命令
  • 迁移工具
  • Kubernetes 相关工具

而 cobra 在这条线上几乎是个“默认会考虑”的选手。

最基础的命令长什么样

var rootCmd = &cobra.Command{
    Use:   "app",
    Short: "A simple CLI app",
    Run: func(cmd *cobra.Command, args []string) {
        fmt.Println("hello cobra")
    },
}

func main() {
    if err := rootCmd.Execute(); err != nil {
        os.Exit(1)
    }
}

这里的关键其实是那颗命令树。rootCmd 是根命令,后面你可以不断给它挂子命令。

子命令才是 cobra 真正的味道

var migrateCmd = &cobra.Command{
    Use:   "migrate",
    Short: "run db migrations",
    Run: func(cmd *cobra.Command, args []string) {
        fmt.Println("migrating...")
    },
}

func init() {
    rootCmd.AddCommand(migrateCmd)
}

这时候你就能跑:

app migrate

如果项目里有启动服务、建表、导入数据、生成文件这些动作,cobra 会很好组织。

flags 是 CLI 的日常刚需

var port int

func init() {
    rootCmd.Flags().IntVar(&port, "port", 8080, "server port")
}

然后执行:

app --port 9090

你会发现,flags、帮助信息、命令说明,这些本来很零碎的东西,cobra 都给你整理好了。

它通常和 viper 一起出现

这个搭配非常常见。原因也简单:

  • cobra 负责命令结构
  • viper 负责配置读取

命令行参数、配置文件、环境变量三者一打通,一个 CLI 工具或管理程序的骨架就很完整了。

cobra 最适合放在哪

如果项目有 CLI 层,cobra 就应该待在入口和命令组织那层。别把业务全塞进每个命令定义里,命令函数仍然应该更多负责“调度”,而不是把所有细节都写成一个超长 Run

什么时候没必要用 cobra

如果你的程序只有一个很简单的入口,甚至没有子命令,没有复杂 flags,也不打算发展成 CLI 工具,那直接用标准库的 flag 包都完全可以。不是所有命令行程序都值得上框架。

小结

cobra 这道菜不是天天吃,但在它出现的场景里通常很顶用:

  • 它擅长组织命令树、flags 和帮助信息
  • 特别适合管理命令、脚手架和 CLI 工具
  • 常和 viper 组合成入口层基础设施
  • 简单程序别为了看起来正规而强上

这一套 Go mod 好菜系列 到这里先告一段落。后面如果继续扩,我会优先考虑再补 validator、jwt、sqlx、ent 这些更贴近常规项目的模块。

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