Go性能优化 | 字节青训营
高质量编程
编写的代码能够达到正确可靠、简洁清晰的目标可称为高质量代码
- 各种边界条件是否考虑完备
- 异常情况处理，稳定性保证
- 易读易维护
高质量编程简介
编程原则
-
简单性
- 消除“多余的复杂性”，以简单清晰的逻辑编写代码
- 不理解的代码无法修复改进
-
可读性
- 代码是写给人看的，而不是机器
- 编写可维护代码的第一步是确保代码可读
-
生产力
- 团队整体工作效率非常重要
如何编写高质量的Go代码
-
代码格式
-
- 推荐使用
gofmt自动格式化代码
- 推荐使用
-
注释
-
- 注释应该做的：
-
- 解释代码作用
- 解释代码如何做的
- 解释代码实现的原因
- 解释代码什么情况会出错
- 公共符号始终要注释
- 有一个例外，不需要注释实现接口的方法。
-
命名规范
-
- 以下是变量命名
-
- 简介胜于冗长
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
-
- 例如使用ServeHTTP而不是ServeHttp
- 使用XMLHTTPRequest或者xmlHTTPRequest
- 变量距离其被使用的地方越远，则需要携带越多的上下文信息
-
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
- 以下是函数命名
- 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
- 函数名尽量简短
- 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
- 当名为foo的包某个函数返回类型T时(T并不是Foo)，可以在函数名中加入类型信息
-
控制流程
-
- 避免嵌套，保持正常流程清晰
- 尽量保持正常代码路径为最小缩进，优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
-
错误和异常处理
-
- 简单错误
-
- 简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
- 优先使用errors.New来创建匿名变量来直接表示简单错误
- 如果有格式化的需求，使用fmt.Errorf
- 错误的Wrap和Unwrap
-
- 错误的Wrap实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链
- 在fmt.Errorf中使用:
%w关键字来将一个错误关联至错误链中
- 错误判定
-
- 判定一个错误是否为特定错误，使用errors.Is
- 不同于使用
==，使用该方法可以判定错误链上的所有错误是否含有特定的错误 - 在错误链上获取特定种类的错误，使用errors.As
- panic
-
- 不建议在业务代码中使用panic
- 调用函数不包含recover会造成程序崩溃
- 若问题可以被屏蔽或解决，建议使用error代替panic
- 当程序启动阶段发生不可逆转的错误时，可以在init或main函数中使用panic
- recover
-
- recover只能在被defer 的函数中使用
- 嵌套无法生效
- 只在当前goroutine生效
- defer的语句是后进先出
- 如果需要更多的上下文信息，可以recover后在log中记录当前的堆栈
编码规范
defer会在函数返回前调用，并且在同一函数中多个defer后进先出
性能优化建议
性能表现需要实际数据衡量
Go语言提供了支持基准性能测试的benchmark工具
slice预分配内存
- 尽可能在使用make()初始化切片时提供容量信息
map预分配内存
使用strings.Builder
- 常见的字符串拼接方式
使用空结构体节省内存
- 空结构体struct{}实例不占据任何的内存空间
- 可作为各种场景下的占位符使用
-
- 节省资源
- 空结构体本身具备很强的语义，即这里不需要任何值，仅作为占位符
使用atomic包
- 锁的实现是通过操作系统来实现，属于系统调用
- atomic操作是通过硬件实现，效率比锁高
- sync.Mutex应该用来保护一段逻辑，不仅仅用于保护一个变量
- 对于非数值操作，可以使用atomic.Value，能承载一个interface{}
性能调优实战
性能调优简介
性能调优原则
- 要依靠数据不是猜测
- 要定位最大瓶颈而不是细枝末节
- 不要过早优化
- 不要过度优化
