Go语言编程规范 - GoLang - 开发测试记录

Go语言代码的自动格式化

我们先了解一下一个基本知识，Go语言是一个自带格式化工具的语言，通过 gofmt将代码格式化为统一的一致的格式。Go 将gofmt作为其官方工具链的核心部分，这不仅仅是语言的一个小特性，而是其哲学和成功的关键支柱之一。这种“自带电池”的设计带来了诸多深远的好处。

强制统一的代码风格（Enforced Uniform Style）

这是最直接和最大的好处。gofmt强制执行一种官方的、规范的代码格式。在整个Go生态系统中，几乎所有代码都遵循相同的风格。

消除无意义的争论：在其它语言中，团队经常需要花费大量时间讨论代码风格（如括号位置、缩进、空格等）。Go通过“一种标准，全员遵守”的方式，彻底消除了这类争论，让开发者能更专注于逻辑和设计。
降低阅读门槛：当你阅读任何Go项目（无论是标准库、知名框架还是同事的代码）时，其格式都是高度一致的。这极大地降低了理解和熟悉新代码的成本。

提升开发效率和体验

自动化，解放双手：开发者无需手动调整代码格式。在保存文件时（现代编辑器/IDE通常集成了gofmt在保存时自动运行），代码会自动被格式化，节省了大量时间和精力。
简化代码审查（Code Review）：在Review代码时，评审者无需再关注缩进、空格等风格问题，可以集中精力审查代码的逻辑、架构、性能和正确性。很多团队甚至会在CI/CD流水线中集成gofmt检查，确保所有提交的代码都是格式化过的。

简化语言设计和工具开发

语法设计限制：Go语言的设计者在设计新特性时，必须考虑“这个特性能否被gofmt很好地格式化”。这反过来约束了语法不能设计得过于复杂和灵活，保持了语言的简洁性。
工具链更容易开发：因为代码格式是规范且可预测的，所以基于AST（抽象语法树）的分析工具、重构工具、插件等更容易编写。工具开发者不需要处理无数种代码风格变体。

作为教学和学习的利器

对于Go语言的初学者来说，gofmt是一个非常好的老师。初学者写出的代码可能格式混乱，但只要运行一次gofmt，就能立刻看到“Go语言官方推荐”的代码应该长什么样。这加速了学习过程，帮助新人快速养成好的编码习惯。

代码 diff 更清晰

当多人协作时，版本控制系统的diff功能非常重要。如果只是因为格式不同（比如多了几个空格）而导致diff结果充满无关更改，会很难发现真正的逻辑变更。统一的格式确保了diff结果只显示真正的逻辑修改，使代码变更历史更加清晰。假设在没有gofmt的情况下，不同开发者可能会写出不同风格的代码。将格式化工具内置并强制推行，是Go语言一项非常成功的设计决策。它远不止是一个“美化代码”的工具，而是一种通过技术手段强制实现共识、提升协作效率、简化语言复杂性的哲学体现。它让Go社区避免了“风格战争”，让开发者能更专注于解决实际问题，从而为语言的成功和生态的繁荣做出了巨大贡献。

编码规范

在Internet上流行一批现有的Go语言编码规范，也被称之为代码风格。代码风格的目的通常是让代码容易阅读和易于维护。在极限编程中非常强调“代码集体所有权”，如果一个代码团队内的开发成员都可以独立编写和维护，谁都可以修改任何代码，每个人修复不限于自己的代码问题，那么这个代码就是好代码，反之就有待于改进。

首先我们搞一些他山之石来帮助我们预先了解和深入学习，例如《Effective Go》、《Google Go 编程规范》；
虽然在Go官网中的代码示例是一个值得学习的例子，但它并非都是好的（例如单字母的变量在当前函数或者小型函数中可能没有歧义或阅读困难，但在代码仓库中就很难“见名知意”），我们需要取之精华，祛除糟粕；
写代码不是用来炫技，而是创造价值；

命名

名称不能太宽泛，例如utility、tool、data、info等一个单词表示。
包名称应该是一个好名字，简短、简洁、有意义。包名最好是小写的单个单词名称，不需要下划线或混合大写字母，如果需要多个单词则都使用小写且不使用分隔符；可以使用目录来划分层级。
名称不建议使用缩写，除非是共识的缩写名称，如果缩写有歧义则避免使用
在 Effitive Go 中，建议函数名、接口名使用驼峰命名法而不是蛇形命名法↗️。文件的命名可以使用蛇形命名法。
函数名应该尽可能使用动词+名词结构

注释

Go 提供了 C 风格的 /* */ 块注释和 C++ 风格的行注释。行注释是常态，块注释主要显示为包注释，但在表达式中或禁用大量代码很有用。
在包名、函数、接口、结构体、结构体中的方法等处必须设置注释；
变量和常量可以设置注释也可以不设置，具体要看它是否是可以外部调用的以及它的名字能否准确表达出它的意思；

Linter

golangci-lint