这是我参加【第三届青训营-后端场】笔记创作活动的第二篇笔记
本次课的学习目的是什么？
- 如何编写更简洁清晰的代码
- 常用go语言程序优化手段
- 熟悉go程序性能分析工具
- 了解工程中性能优化的原则和流程
高质量编程
编程原则：
简单性
- “消除多余的复杂性”，以简单清晰的逻辑编写代码
- 不理解的代码无法修复改进
可读性
- 代码是写给人看的，而不是机器
- 编写可维护代码的第一步是确保代码可读生产力
- 团队整体工作效率非常重要
编码规范
代码格式
推荐使用gofmt自动格式化代码
gofmt
go语言官方推荐的工具，能自动格式化go语言为官方统一风格，常见IDE都支持方便的配置
goimports
也是go语言官方提供的工具 实际等于gofmt加上依赖包管理，自动增删依赖的包的引用，将依赖按字母排序按并分类
注释
注释应该解释代码作用：适合注释公共符号
注释应该解释代码如何做的：适合注释实现过程
注释应该解释代码实现的原因：适合解释代码的外部因素和提供额外上下文
注释应该解释代码什么情况会出错：适合解释代码的限制条件
公共符号始终要注释
包中声明的N个公共的符号:
- 变量、常量、函数以及结构都需要添加注释
- 任何既不明显也不简短的公共功能必须予以注释
- 无论长度或复杂程度如何,对库中的任何函数都必须进行注释。
小结： 代码是最好的注释，注释应该提供代码为表达出的上下文信息
命名规范
- 简洁胜于冗长
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 例如使用ServeHTTP而不是 ServeHttp
- 使用XMLHTTPRequest或者xmlHTTPRequest
- 变量距离其被使用的地方越远，则需要携带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
function
- 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的·函数名尽量简短
- 当名为foo 的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
- 当名为 foo 的包某个函数返回类型T时(T并不是 Foo)，可以在函数名中加入类型信息
package
- 只由小写字母组成。不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息。例如schema、task等
- 不要与标准库同名。例如不要使用sync或者strings
以下规则尽量满足，以标准库包名为例
- 不使用常用变量名作为包名。例如使用bufio而不是 buf
- 使用单数而不是复数。例如使用encoding 而不是encodings
- 谨慎地使用缩写。例如使用fmt在不破坏上下文的情况下比 format 更加简短
小结
- 核心目标是降低阅读理解代码的成本
- 重点考虑上下文信息，设计简洁清晰的名称
控制流程
- 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
- 正常流程代码沿着屏幕向下移动
- 提升代码可维护性和可读性
- 故障问题大多出现在复杂的条件语句和循环语句中
错误和异常处理
简单错误
- 简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
- 优先使用errors.New来创建匿名变量来直接表示简单错误
- 如果有格式化的需求，使用fmt.Errorf
错误的Wrap和Unwrap
- 错误的Wrap实际上是提供了一个error嵌套另一个error的能力，从而生成一个error 的跟踪链
- 在 fmt.Errorf中使用:%w关键字来将一个错误关联至错误链中
错误判定
- 判定一个错误是否为特定错误，使用errors.ls
- 不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误
- 在错误链上获取特定种类的错误，使用errors.As
panic
- 不建议在业务代码中使用panic
- 调用函数不包含recover 会造成程序崩溃
- 若问题可以被屏蔽或解决，建议使用error代替panic
- 当程序启动阶段发生不可逆转的错误时，可以在init或 main函数中使用panic
recover
- recover只能任被 defer的函数中使用
- 嵌套无法生效
- 只在当前goroutine生效
- defer的语句是后进先出
- 如果需要更多的上下文信息，可以recover后在 log中记录当前的调用栈
性能优化
BenchMark
命令：
go test -bench=. -benchmem
slice预内存分配
尽可能在使用make()初始化切片时提供容量信息
map预内存分配
不断向map中添加元素的操作会触发map的扩容，提前分配好空间可以减少内存拷贝和Rehash的消耗，建议根据实际需求提前预估好需要的空间
使用strings.Builder
字符串拼接使用+性能最差，strings.Builder,bytes.Buffer相近，strings.Buffer更快
使用空结构体节省内存
- 空结构体struct坍实例不占据任何的内存空间
- 可作为各种场景下的占位符使用
- 节省资源
- 空结构体本身具备很强的语义，即这里不需要任何值，仅作为占位符 使用atomic包
- 锁的实现是通过操作系统来实现，属于系统调用
- atomic操作是通过硬件实现，效率比锁高
- sync.Mutex应该用来保护一段逻辑，不仅仅用于保护一个变量
- 对于非数值操作，可以使用atomic.Value，能承载一个interface{}
小结
- 避免常见的性能郜陷阱可以保证大部分程序的性能
- 普通应用代码，不要一味地追求程序的性能
- 越高级的性能优化手段越容易出现问题
- 在满足正确可靠、简洁清晰的质量要求的前提下提高程序性能
