这是我参与「第五届青训营」伴学笔记创作活动的第 3 天
高质量编程
什么是高质量
编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码
- 各种边界条件是否考虑晚辈
- 异常情况处理，稳定性保证
- 易读易维护 生产力:
编程原则
实际应用场景千变万化，各种语言的特性和语法啊各不相同，但是高质量编程遵循的原则是相通的
简单性: 消除"多余的复杂性"，以简单清晰的逻辑编写代码、不理解的代码无法修复改进
可读性: 代码是给人看的，而不是机器、编写可维护代码的第一步是确保代码可读
生产力: 团队整体工作效率非常重要
编码规范
如何编写高质量Go代码，从以下这几个方面着手
代码格式
推荐使用gofmt自动格式化代码
gofmt：GO语言官方提供的工具，能自动格式化Go语言代码为官方统一风格，常见IDE都支持方便的配置
goimports：也是Go语言官方提供的工具，实际等于gofmt加上依赖包管理，自动增删依赖的包引用、将依赖包按字母序排序并分类
注释
注释应该做到：
- 应该解释代码作用
- 应该解释代码如何做的
- 应该解释代码实现的原因
- 注释应该解释代码什么情况会出错
命名规范
- 简洁胜于冗长
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 例如使用ServeHTTP而不是ServeHttp
- 使用XMLHTTPRequest 或者 xmlHTTPRequest
- 变量距离其被使用的地方越远，则需要携带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认初其含义
控制流程
- 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
- 正常流程代码沿着屏幕向下移动
- 提升代码可维护性和可读性
- 故障问题大多出现在复杂的条件语句和循环语句中
错误和异常处理
简单错误
- 简单的错误指的是仅出现一次的错误，且在其它地方不需要捕获该错误
- 优先使用errors.New来创建匿名变量来直接表示简单错误
- 如果有格式化的需求，使用fmt.Errorf
错误的Wrap和Unwrap
- 错误的Wrap实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链
- 在fmt.Errorf中使用
%w关键字来将一个错误关联至错误链中
错误判定
- 判定一个错误是否为特定错误，使用errors.Is，不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误
- 在错误链上获取特定种类的错误，使用errors.As
- 在程序启动阶段发生不可逆转的错误时才使用
panic，但是 Go 可以使用revover语句来从panic中恢复；
性能调优
- 性能优化的前提是满足正确可靠、简洁清晰等质量因素
- 性能优化是综合评估，有时时间效率和空间效率可能对立
Benchmark
如何使用：go test -bench=. -benchmen
- 性能表现需要实际数据衡量
- Go语言提供了支持基准性能测试的benchmark工具
Slice
- 尽可能在使用make()初始化切片时提供容量信息
- 切片本质是一个数组片段的描述
- 包括数组指针
- 片段的长度
- 片段的容量
- 切片操作并不复制切片指向的元素
- 创建一个新的切片会复用原来切片的底层数组
- 切片本质是一个数组片段的描述
- 大内存未是发那个
- 在已有切片基础上创建切片，不会创建新的底层数组
- 场景
- 原切片较大，代码在原切片基础上新建小切片
- 底层数组在内存中有引用，得不到释放
- 可使用copy替代re-slice
Map
- 不断向map中添加元素的操作会触发map的扩容
- 提前分配好空间可以减少内存拷贝和Rehash的消耗
- 建议根据实际需求提前预估好需要的空间
字符串处理
- 使用+拼接性能最差，strings.Builder,bytes.Buffer相近,strings.Buffer更快
- 字符串在Go语言中是不可变类型，占用内存大小是固定的
- 使用+每次都会重新分配内存
- bytes.Buffer转化为字符串时重新申请了一块空间
- strings.Builder直接将底层的[]byte转换成了字符串类型返回
空结构体
- 空结构体struct{}实例不占据任何的内存空间
- 可作为各种场景下的占位符使用
- 节省资源
- 空结构体本身具备很强的语义，即这里不需要任何值，仅作为占位符
atomic包
使用atomic包代替锁
- 锁的实现是通过操作系统来实现，属于系统调用
- atomic操作是通过硬件实现，效率比锁高
- sync.Mutex 应该用来保护一段逻辑，不仅仅用于保护一个变量
- 对于非数值操作，可以使用atomic.Value，能承载一个interface{}
