[ Go语言高质量编程 | 青训营课程笔记 ]

这是我参与「第五届青训营」伴学笔记创作活动的第 5天 内容： 如何编写更简洁清晰的代码 常用Go语言程序优化手段 熟悉Go语言性能分析工具 了解工程中性能优化的原则和流程

01.高质量编程

1.1高质量编程简介

正确性:是否考虑各种边界条件，错误的调用是否能够处理。 可靠性:异常情况或者错误的处理策略是否明确，依赖的服务出现异常是否能够处理。 简洁:逻辑是否简单，后续调整功能或新增功能是香能够快速支持。 清晰:其他人在阅读理解代码的时候是否能清楚明白，重构或者修改功能是否不会担心出现无法预料的问题。

编程原则：简单性、可读性、生产力（团队整体工作效率非常重要）

1.2编码规范

几个注意的地方：

1.2.1代码格式

推荐使用gofmt自动格式化代码，保证所有Go代码与官方推荐格式保持一致。 goimports 会对依赖包进行管理，自动增删依赖包的引用。

1.2.2注释

注释应该解释代码作用（适合注释公共符号） 注释应该解释代码如何做的（适合注释实现过程） 注释应该解释代码实现的原因（适合解释代码的外部因素及提供额外上下文） 注释应该解释代码什么情况会出错（适合解释代码的限制条件）

公共符号始终要注释： ①包中声明的每个公共的符号:变量、常量、函数以及结构都需要添加注释。 ②任何既不明显也不简短的公共功能必须予以注释。 ③无论长度或复杂程度如何，对库中的任何函数都必须进行注释。（例外：不需要注释实现接口的方法，不要无法提供有用信息的注释）

【代码是最好的注释，注释应该提供代码未表达出的上下文信息】

1.2.3命名规范

variable： ·简洁胜于冗长 ·缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写 ·例如使用ServeHTTP而不是ServeHttp ·使用XMLHTTPReauest或老xmlHTTPReruect5279 ·变量距离其被使用的地方越远，则需要携带越多的上下文信息 ·全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义

function： ·函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的 ·函数名尽量简短 ·当名为foo 的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义 ·当名为foo 的包某个函数返回类型T时(T并不是Foo)，可以在函数名中加入类型信息

package： ·只由小写字母组成。不包含大写字母和下划线等字符 ·简短并包含一定的上下文信息。例如schema、task 等 ·不要与标准库同名。例如不要使用sync或者strings 以下规则尽量满足，以标准库包名为例 ·不使用常用变量名作为包名。例如使用bufio 而不是 buf ·使用单数而不是复数。例如使用encoding而不是encodings ·谨慎地使用缩写。例如使用fmt在不破坏上下文的情况下比 format 更加简短

小结： 核心重点是降低阅读理解代码的成本 重点考虑上下文信息，设计简洁情绪的名称

1.2.4控制流程

避免嵌套，保持正常流程清晰 尽量保持正常代码路径最小缩进

1.2.5错误和异常处理

简单错误 ·简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误 ·优先使用errors.New来创建匿名变量来直接表示简单错误 ·如果有格式化的需求，使用fmt.Errorf

错误的 Wrap和Unwrap ·错误的Wrap 实际上是提供了一个error嵌套另一个error 的能力，从而生成一个 error 的跟踪链 ·在 fmt.Errorf 中使用: %w关键字来将一个错误关联至 错误链中

错误判定 ·判定一个错误是否为特定错误，使用errors.ls ·不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误

panic ·不建议在业务代码中使用panic ·调用函数不包含recover会造成程序崩溃 ·若问题可以被屏蔽或解决，建议使用error 代替panic ·当程序启动阶段发生不可逆转的错误时，可以在 init 或 main 函数中使用panic