Go语言高质量编程与性能调优 | 青训营笔记

这是我参与「第五届青训营 」伴学笔记创作活动的第 6 天

高质量编程与性能调优 | 青训营笔记

1. 高质量编程

1.1 什么是高质量

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

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

1.2 编程原则

1. 简单性
   • 消除"多余的复杂性"，以简单清晰的逻辑编写代码
   • 不理解的代码无法修复改进
2. 可读性
   • 代码是写给人看的，而不是机器
   • 编写可维护代码的第一步是确保代码可读
3. 生产力
   • 团队整体工作效率非常重要

1.3编码规范

如何编写高质量的Go代码

• 代码格式：推荐使用gofmt自动格式化代码
  • gofmt: Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格，常见IDE都支持方便的的配置
  • goimports：Go语言官方提供的工具，实际等于gofmt加上依赖包管理，自动增删依赖的包引用、将依赖包按字母排序并分类
• 注释：解释代码作用、解释代码实现过程、解释代码实现的原因、解释代码什么情况会出错
  • 公共符号始终要注释
  • 包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释
  • 任何既不明显也不简短的公共功能必须予以注释
  • 无论长度或复杂程度如何，对库中的任何函数都必须进行注释
• 命名规范
  • 变量名
    • 简洁胜于冗长
    • 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
      • 例如使用ServerHTTP而不是ServerHttp
      • 使用XMLHTTPRequest或者xmlHTTPRequest
    • 变量距离其被使用的地方越远，则需要携带越多的上下文信息
      • 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
  • 函数名
    • 函数名不携带包名的上下文你信息，因为包名和函数名总是成对出现的
    • 函数名尽量简洁
    • 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
    • 当名为foo的包某个函数返回类型T时（T并不是Foo），可以在函数名加入类型信息
  • package
    • 只由小写字母组成。
    • 简短并包含一定的上下文信息。
    • 不要与标准库同名
    • 不使用常用变量名作为包名
    • 使用单数而不是复数
    • 谨慎使用缩写
• 控制流程
  • 避免嵌套，保证正常流程清晰
  • 尽量保持正常代码路径为最小缩进
• 错误和异常处理
  • 优先使用errors.New创建匿名变量来直接表示简单错误
  • 错误的Wrap实际上时提供了一个error嵌套另一个error的能力，从而生成了一个error的跟踪链
  • 在fmt.Errorf中使用：%w关键字将一个错误关联至错误链中
  • 使用errors.As获取错误链上特定种类的错误
  • recover只能在被defer的函数中使用，嵌套中无法生效、只在当前goroutine生效，defer语句是后进先出

2. 性能调优实战

2.1 如何衡量性能

• 性能表现需要实际数据衡量
• Go语言提供了支持基准性能测试的benchmark工具go test -bench=. -benchmem

2.2 性能优化建议

• slice预分配内存
  • 尽可能在使用make()初始化切片时提供容量信息
• map预分配内存
• 使用strings.Builder进行字符串处理
• 使用空结构体节省内存
• 使用atomic包

2.3 性能调优原则

• 依靠数据而不是猜测
• 定位最大瓶颈而不是细枝末节
• 不过早优化
• 不过度优化
• 使用pprof工具进行优化