这是我参与「第三届青训营 -后端场」笔记创作活动的的第4篇笔记

1. 如何编写更简洁清晰的代码
2. 常用Go语言程序优化手段
3. 熟悉Go语言性能分析工具
4. 了解工程中性能优化原则和流程

高质量编程

什么是高质量

编写的代码能够达到正确可靠、简洁清晰的目标可称为高质量代码。

• 各种边界条件是否考虑完备
• 异常情况处理，稳定性保证
• 易读易维护

一些通用的原则

1. 简单性

   • 消除“多余的复杂性”，以简单清晰的逻辑编写代码
   • 不理解的代码无法修复改进

2. 可读性

   • 可维护代码的第一步是确保代码可读

3. 生产力

   • 团队整体工作效率非常重要。

编码规范

如何编写高质量的Go代码

代码格式、注释、命名规范、控制流程、错误和异常处理。

代码格式

推荐使用gofmt 和goimports包，Goland已经内置。

代码注释

注释应该做什么：

1. 注释应该解释代码作用

   • 适合注释公共符号

     • 包中声明的每个公共的符号：变量、常量、函数、结构都需要添加注释
     • 任何既不明显又不简短的公共功能必须予以注释
     • 无论长度或复杂程度如何，对库中的任何函数都必须进行注释
     • 有一个例外，不需要注释实现接口的方法。

2. 注释应该解释代码如何做的

   • 适合注释实现过程

3. 注释应该解释代码实现的原因

   • 适合解释代码的外部因素
   • 提供额外上下文

4. 注释应该解释代码什么情况会出错

   • 适合解释代码的限制条件

好的代码有很多注释，坏的代码需要很多注释。

编码规范-命名规范

1. 简洁胜于冗长
2. 缩略词全大写，但当其位于变量开头且不需要导出时，全小写。
3. 变量距离被使用的地方越远，则需要携带越多的上下文信息

变量名应该包含应有的信息量，若有特定的含义的变量不要使用简单的大类进行命名。比如deadline 是时间，但有特定含义，不能使用t 替换。

对于函数：

1. 函数名不携带包的上下文信息，因为包名和函数名总是成对出现的
2. 函数名尽量简短
3. 当名为foo的包的某个函数返回类型Foo时，可以省略类型信息；当名为foo的包的某个函数返回类型T时，可以在函数名中加入类型信息。

对于包：

1. 只由小写字母组成
2. 简短并且包含一定的上下文信息
3. 不要与标准库同名
4. 不使用常用变量名作为包名
5. 使用单数而不是复数
6. 谨慎地使用缩写

控制流程

1. 线性原理，避免嵌套，保持正常流程清晰

2. 尽量保持正常代码路径为最小缩进

   • 优先处理错误情况、特殊情况，尽早返回或继续循环来减少嵌套

错误和异常处理

对于简单错误：

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

对于错误的Wrap 和Unwrap ：

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

错误判定：

1. 判定一个错误是否为特定错误，使用errors.Is,不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误
2. 在错误链上获取特定种类的错误，使用errors.As

对于panic：

1. 不建议在业务代码中使用panic
2. 调用函数不包含recover会造成程序崩溃
3. 若问题可以被屏蔽或解决，建议使用error代替panic
4. 特殊场景：当程序启动阶段发生不可逆转的错误时，可以在init或main函数中使用panic，尽早暴露出来错误，避免无意义的启动

相应的，对于recover：

1. recover只能在被defer的函数中使用
2. 嵌套无法生效
3. 只在当前goroutine生效
4. defer的语句会在函数返回前调用，且是后进先出，当写多个defer语句时，注意顺序问题
5. 如果需要更多的上下文信息，可以recover后在log中记录当前的调用栈

性能优化建议

Benchmark

如何使用：

1. 性能表现需要实际数据衡量

2. Go语言提供了支持基准性能测试的benchmark工具。

   go test -bench=. -benchmem

slice

1. slice预分配内存，尽可能在使用make()初始化切片时提供容量信息。

2. 在已有切片基础上创建切片，不会创建新的底层数组。原切片较大，代码在原切片基础上新建小切片，原底层数组在内存中有引用，得不到释放。可使用copy函数到一个新的小切片，使得对原底层数组的引用释放。

map

map预分配内存，尽可能在使用make()初始化切片时提供容量信息。提前分配好空间可以减少内存拷贝和Rehash的消耗。

字符串处理

1. 相比于直接使用+，使用strings.Builder拼接字符串性能更好。同时，如果预知字符串长度，也可以使用Grow函数分配，可以更好地提升性能。

   原因：字符串在Go语言中是不可变类型，使用+每次都会重新分配内存；strings.Builder底层是[]byte数组，通过内存扩容策略，不需要每次拼接重新分配内存。

空结构体

使用空结构体节省空间：空结构体struct{}实例不占据任何的内存空间，可作为各种场景下的占位符使用。

比如，使用map来实现set，对于这种场景，只需要用到map的键，而不需要用到值。

atomic包

用于加锁的包。锁的实现是通过操作系统来实现的，属于系统调用。atomic操作是通过硬件实现，效率比锁高。

因此，加锁操作sync.Mutex应该用来保护一段逻辑，而不仅仅用于保护一个变量。保护一个变量考虑使用atomic包。

对于非数值操作，可以使用atomic.Value，能承载一个interface{}