本文永久链接 – https://tonybai.com/2025/09/17/some-things-i-keep-repeating-about-go

大家好,我是Tony Bai。

在阔别公众视野数年后,Go 社区的传奇人物 Dave Cheney 终于重返 GopherCon Europe 的舞台,发表了一场备受瞩目的复出首谈(注:我印象中的回归首谈^_^)。这场题为《那些我反复强调的 Go 编程之事》的演讲,没有追逐时髦的技术热点,而是选择回归编程的本源,分享了他十五年 Go 编程生涯中,那些被反复实践、验证并沉淀下来的核心理念。

本文将和大家一起深入解读这场演讲的三大核心支柱:命名、初始化与流程控制、以及辅助函数,并探讨为何这些看似简单的模式,却是编写可读、可维护、可测试 Go 代码的基石。

引言:一位 Go “哲人”的回归与沉淀

对于许多 Go 开发者而言,Dave Cheney 的名字不仅代表着一位高产的贡献者,更像是一位编程哲学的布道者。在他“消失”的几年里,社区依旧在流传和实践着他提出的诸多模式。因此,当他重返 GopherCon Europe 2025的舞台时,整个社区都在好奇:他反复强调的那些 Go 编程理念,变了吗?

答案既是“没有”,也是“更加深刻了”。

正如他在开场时所言,这次演讲是他对自己为多家公司编写了超过十年 Go 代码的经验总结,是他对 Peter Bourgon 经典演讲《Ways to do things》的致敬,更是一次对他自己编程风格的提纯与升华。他所分享的,正是那些在无数次代码审查、项目重构和生产救火中,被他反复提及、反复实践的编程模式。这些“重复之事”,构成了他编程哲学的坚实内核。

支柱一:命名 —— 程序的灵魂与第一印象

“我们应该执着地、狂热地关注程序中使用的每一个名字。” 演讲开篇,Dave 便直指编程的核心——命名。它涵盖了变量、常量、包、类型、方法和函数,是代码清晰度的源头。

告别“短标识符”的圣战

对于 Go 社区经久不衰的“短标识符 vs. 长标识符”之争,Dave 引用了 Andrew Gerrand 的智慧之言,并将其作为命名第一法则:

“最好的标识符,是能够描述其存在理由的最短的那个。”

这意味着,名称的长度应与其生命周期和作用域成正比。一个只活几行的循环变量用 i 即可,而一个贯穿整个包的重要配置,则需要一个描述性的全名。

重要的部分放前面

“你不是在写惊悚小说”,Dave 强调,标识符中最重要的、最独特的部分应该放在前面,而不是让读者猜到最后。特别是在同一作用域内有多个同类事物时,清晰的前缀至关重要。

包内外视角的二元性与一致性约定

一个常见的问题是,包的作者和消费者对“好名字”的看法不同。在包内,request 可能是一个合理的变量名;但在包外,它变成了 completion.Request,显得冗长。

Dave 提出的解决方案是建立一致的缩写约定

  1. 全局约定:例如,req 永远指代 *http.Request。
  2. 包内约定:对于 completion.Request,在包内统一使用一个独特的缩写,如 creq,并将其用作接收器名、参数名和局部变量名
// 外部调用
func DoSomething(creq *completion.Request) {}

// 包内实现
func (creq *Request) Do() {}

这样,无论读者身处包内还是包外,creq 这个标识符的含义都是稳定且可预测的。

让名字代替注释

Dave 引用了 Kate Gregory 在《Beautiful C++》中的观点:如果你能给一个标识符起一个足够好的名字,你可能就不需要为它写注释了。一个名字本身就应该能自我解释。

他举了一个反例:一个名为 Validate 的函数,却没有返回 error。这本身就是一个“代码异味”(code smell),即便加上注释 // Validate validates the graph,这种“说了两遍”的重复也无法掩盖其名不副实的问题。经过检查,这个函数实际做的是“扁平化图节点”,一个更准确的名字 FlattenNodes 就能让注释变得多余。

有时,最好的名字就是没有名字

对于那些生命周期极短、仅用于临时数据传递的类型,最好的名字可能就是没有名字。例如,在处理 HTTP 请求时,如果需要先将 JSON 解码到一个中间结构体再进行验证,完全可以使用匿名结构体

var payload struct {
    Name string json:"name"
    // ...
}
if err := json.NewDecoder(r.Body).Decode(&payload); err != nil {
    // ...
}

为这个只在此函数中存活一次的类型绞尽脑汁想一个名字(如 requestClient),是完全不必要的认知负担。

支柱二:初始化与流程控制 —— 对 if-else 的厌恶

“if 很糟糕,else 更糟糕”,这是 Dave 对流程控制的核心观点。他认为,我们应该尽一切努力减少甚至消除代码中的 if-else 结构,尤其是那些用于延迟初始化的模式。

假装 Go 拥有不可变性:一次且仅一次的初始化

一个常见的反模式是“声明-后初始化”:

var thing Thing
if os.Getenv("ENV") == "prod" {
    thing = NewRealThing()
} else {
    thing = NewMockThing()
}

这不仅创造了一个 thing 未被初始化的“危险”中间状态,也增加了代码的认知负荷。Dave 的解决方案是:默认初始化,然后覆盖

thing := NewMockThing() // 默认初始化
if os.Getenv("ENV") == "prod" {
    thing = NewRealThing() // 在特定条件下覆盖
}

更进一步,将这个选择逻辑封装进一个辅助函数 NewThing() 中,这不仅让调用点的代码变得干净(thing := NewThing(isProd)),还将这个选择逻辑变成了一个可独立测试的单元。

“保持靠左” (Keep to Left) 与 switch 的偏爱

这两个由 Matt Ryer 提出的模式,被 Dave 奉为圭臬:

  • 保持靠左:即使用“防卫语句”(Guard Clauses)或前置条件检查,在函数开头处理掉所有错误和异常情况并提前返回。这能让成功路径(Happy Path)始终贴近编辑器的左侧边缘,避免代码陷入层层嵌套的 if-else “深渊”。
  • 用 switch 代替 if-else:对于选择逻辑,switch 语句通常比 if-else 链更清晰,因为它明确地表达了“基于某个值进行选择”的意图,并且更易于未来扩展(只需增加 case)。

main.run 模式:让 main 不再特殊

main 函数是每个 Go 程序的入口,但它也是最“奇怪”的函数:它不能返回 error,并且隐式地依赖于大量的全局状态(操作系统环境、标准输入输出、命令行参数等),这使得它极难测试。

Dave 强烈推荐 main.run 模式,其应用非常简单:
1. 创建一个新的、普通的 Go 函数,例如 run。
2. 将 main 函数中的所有核心逻辑都移入 run 函数。
3. 将所有之前隐式依赖的全局状态,作为参数显式地传递给 run 函数。
4. 让 run 函数返回一个 error。

func main() {
    // main 函数只负责处理最终的错误并退出
    if err := run(os.Stdout, os.Args); err != nil {
        fmt.Fprintf(os.Stderr, "error: %v\n", err)
        os.Exit(1)
    }
}

// run 函数现在是一个纯粹的、可测试的 Go 函数
func run(stdout io.Writer, args []string) error {
    // ... 你的所有核心逻辑
    // ... 检查前置条件,构建状态
    // ... 进入主循环
    // ... 遇到任何问题,只需 return err
    return nil
}

这个简单的重构,让程序的核心逻辑变得完全可测试,并且可以在测试中并行运行,极大地提升了开发和维护的效率。Dave 提到,这个模式曾帮助他的团队解决了一个棘手的问题:日志系统初始化失败,导致程序在尝试记录“日志初始化失败”这个错误时直接崩溃。

支柱三:辅助函数 (Helpers) —— 语言的延伸与表达力的提升

贯穿整个演讲的,是 Dave 对使用辅助函数的强烈推崇。他认为,辅助函数是我们扩展项目“内部语言”最强大的工具。

辅助函数的价值

  • 为匿名模式命名:像 pointer.To[T] 这样的泛型函数,为“获取一个值的指针”这个 Go 语法不支持的、在处理 Protobuf 时反复出现的模式,赋予了一个清晰的名字,避免了为每个字段都声明一个临时变量的繁琐。
  • 封装重复逻辑与避免否定:将 if err != nil && !errors.Is(err, context.Canceled) 这样的过滤逻辑,封装进一个 ignoreCancel(err) 辅助函数中,让调用点的意图一目了然。同样,对于布尔检查,if req.StreamIsFalse() 显然比 if !req.Stream 更易于朗读和理解。
  • 提升表达力 (Nicity):创建像 to.JSON(w, data) 这样的辅助函数,可以像 Ruby on Rails 一样,用更符合领域语言的方式来编写代码。这不仅是语法糖,它还能隐藏一些必要的细节(如设置 Content-Type 头),确保一致性和正确性。
  • 延迟求值:在测试中断言失败时,我们常常希望打印出失败时的详细上下文,例如完整的 HTTP 响应体。一个常见的错误是直接将 dumpBody(resp) 作为断言失败时的消息参数。这会导致 dumpBody 无论测试成功与否都会被调用,从而消耗掉响应体。通过将 dumpBody 封装进一个实现了 fmt.Stringer 接口的辅助类型中,我们可以实现延迟求值——只有在断言失败、需要打印消息时,其 String() 方法才会被调用。

内部包(internal)的妙用

Dave 建议,我们可以在项目内部的 internal 目录下创建像 to、is、list 这样的包,用来存放这些辅助函数和类型。这不仅能避免污染公共 API,还能为项目创建一套强大的、可复用的“内部标准库”。

核心:尊重人类的认知极限——神奇数字 7±2

为什么这些看似微小的细节——命名、if-else、辅助函数——如此重要?Dave 引用了著名的认知心理学结论:人类的短期记忆(working memory)只能同时处理 7±2 个信息单元。

这意味着,当我们的代码迫使读者同时记住太多事情时,他们的认知负荷就会超载,理解代码的难度就会急剧增加。

  • 一个 if status >= 400 的判断,需要大脑同时处理“大于”和“等于”两个概念。而 if status > 399 则只占用一个认知单元。
  • 一个层层嵌套的 if-else 结构,每深一层,就需要读者在记忆中压入一个新的上下文。
  • 一个需要大段注释才能解释的函数,说明其名字和签名本身就消耗了大量的认知资源。

所有这些模式——更短但精确的名字、消除 if-else、将逻辑封装进辅助函数——其最终目的都是一致的:减少读者在理解每一行代码时,需要装入短期记忆中的“东西”的数量。

小结:语言影响思维

演讲的最后,Dave 引用了“萨丕尔-沃尔夫假说”来升华他的核心论点(注:笔者在GopherChina 2017年大会上的演讲《Go coding in go way》也引用了此观点,记得那年Dave也参加了Gopher China,就坐在我的前面^_^):

“你使用的语言,直接影响你思考问题的方式。”

通过创建新的名词(类型)和动词(辅助函数),我们实际上是在扩展和塑造我们项目的内部语言。当这门内部语言变得更优雅、更精确、认知负荷更低时,我们对问题的思考也会变得更清晰、更深入。

一个难以命名的函数,或一段需要大段注释来解释的逻辑,都是设计需要改进的强烈信号。它在“恳求你进行重构”。

最终,我们编写的代码,不仅是给机器执行的指令,更是写给未来自己和同事的“信”。而 Dave Cheney 的这些建议,正是帮助我们写好这封“信”,使其清晰、优雅、易于理解的宝贵指南。


你的Go技能,是否也卡在了“熟练”到“精通”的瓶颈期?

  • 想写出更地道、更健壮的Go代码,却总在细节上踩坑?
  • 渴望提升软件设计能力,驾驭复杂Go项目却缺乏章法?
  • 想打造生产级的Go服务,却在工程化实践中屡屡受挫?

继《Go语言第一课》后,我的《Go语言进阶课》终于在极客时间与大家见面了!

我的全新极客时间专栏 《Tony Bai·Go语言进阶课》就是为这样的你量身打造!30+讲硬核内容,带你夯实语法认知,提升设计思维,锻造工程实践能力,更有实战项目串讲。

目标只有一个:助你完成从“Go熟练工”到“Go专家”的蜕变! 现在就加入,让你的Go技能再上一个新台阶!


商务合作方式:撰稿、出书、培训、在线课程、合伙创业、咨询、广告合作。如有需求,请扫描下方公众号二维码,与我私信联系。

© 2025, bigwhite. 版权所有.

Related posts:

  1. 对一段有关Go Code Block和变量作用域的代码的简要分析
  2. 聊聊Go语言的控制语句
  3. 组织Golang代码
  4. 重度使用Go的“后遗症“,你有吗?
  5. 十分钟入门Go语言