高性能编程 | 青训营笔记

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

一、本堂课重点内容：

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

二、详细知识点介绍：

• 1. 高质量编程
  • 高质量编程简介
    • 什么是高质量：编写的代码能达到正确可靠、简洁清晰的目标
      • 各种边界条件是否考虑完备
      • 异常情况处理，稳定性保证
      • 易读易维护
    • 编程原则：
      • 简单性
      • 可读性
      • 生产力
  • 编码规范
    • 如何编写高质量Go代码
      • 代码格式
        • 推荐使用gofmt自动格式化代码
        • goimports
      • 注释
        • 注释应该做的
          • 解释代码作用
          • 解释代码如何做的
          • 解释代码实现的原因
          • 解释什么情况下会出错
          • 应提供代码未表达出的上下文信息
        • 既不明显也不简短的公共功能必须予以注释
        • 对库中的任何函数必须进行注释
        • 不需要注释实现接口的方法
      • 命名规范
        • 变量
          • 简洁胜于冗长
          • 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
            • 例如是要勇敢ServeHTTP 而不是SerbeHttp
            • 使用XMLHTTPRequest而不是xmlHTTPRequest
          • 变量距离其被使用的地方越远，需要携带更多的上下文信息
            • 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
        • 函数
          • 函数名尽量不携带包名的上下文信息，因为包名和函数名总是成对出现
          • 函数名尽量简短
          • 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
          • 当名为foo的包某个函数返回类型T时（T并不是Foo），可以在函数名中加入类型信息
        • 包（package）
          • 只由小写字母组成。
          • 不包含大写字母和下划线等字符
          • 不要与标准库同名。例如不要使用sync或者strings
          • 不使用常用变量名作为包名
          • 使用单数而不是复数
          • 谨慎使用缩写
      • 控制流程
        • 避免嵌套，保证正常流程清晰
        • 尽量保持正常代码路径为最小缩进
          • 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
        • 提升代码可维护性和可读性
      • 错误和异常处理
        • 简单错误
          • 简单错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
          • 优先使用error.New来创建匿名变量来直接表示简单错误
          • 如果有格式化的需求，使用fmt.Errorf
        • 错误的Wrop和Unwrap
          • 错误的wrap实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链
          • 在fmt.Error中使用：%w关键字来将一个错误关联至错误链中
        • 错误判定
          • 判断一个错误是否为特定错误，使用errors.ls
          • 不同于使用 ==，使用该方法可以判定错误链上的所有错误是否含有特定的错误
          • 在错误链上获取特定种类的错误，使用errors.As
          • panic
            • 不建议在业务代码中使用panic
            • 调用函数不包含recover会造成程序崩溃
            • 若问题可以被屏蔽或解决，建议使用error代替panic
            • 当程序启动阶段发生不可逆转的错误时，可以在init或main函数中使用panic
          • recover
            • recover只能在被defer的函数中使用
            • 嵌套无法生效
            • 只在当前goroutine生效
            • defer语句是后进先出
            • 如果需要更多的上下文信息，则在recover后在log中记录当前的调用栈
  • 性能优化建议
    • Benchmark
      • 性能表现需要实际数据衡量
      • Go语言提供了支持基准性能测试的benchmark工具
        • go test -bench=. -benchem
    • slice预分配内存
      • 尽可能在使用make()初始化切片时提供容量信息
      • 在大切片上创建小切片可能导致大内存不释放
    • map预分配内存
      • 不断向map中添加元素的操作会触发map的扩容
      • 提前分配好空间可以减少内存拷贝和Rehash的消耗
      • 建议根据实际需求提前预估需要的空间
    • 字符串处理：
      • 使用string.Builder
      • 使用 + 拼接性能最差，string.Builder,byte.Buffer相近，string.Buffer更快
        • 字符串在Go语言中是不可变类型，占用内存大小是固定的
        • 使用 + 每次都要重新分配内存
        • 使用string.Builder，bytes.Buffer底层都是[]byte数组
        • 内存扩容策略，不需要每次拼接重新分配内存
    • 空结构体
      • 空结构体struct{}实例不占据任何的内存空间
      • 可作为各种场景下的占位符使用
        • 节约资源
        • 空结构体本身具备很强的语义，即这里不需要任何值，仅作为占位符
      • 实现Set，可以考虑用map来替代
      • 对于这个场景，只需要用到map的键，而不需要值
      • 即使是将map的值设置为bool类型，也会多占据一个字节空间
    • atomic包
      • 锁的实现是通过操作系统来实现，属于系统调用
      • atomic操作是通过硬件实现，效率比锁高
      • sync.Mutex应该用来保护一段逻辑，不仅仅用于保护一个变量
      • 对于非数值操作，可以使用atomic.Value，能承载一个interface{}

三、课后个人总结：

• 好好学习 天天向上