这是我参与「第三届青训营 -后端场」笔记创作活动的的第2篇笔记

高质量编程和性能调优实战

1.高质量编程

1.1 简介

什么是高质量？

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

正确性：各种边界条件是否考虑完备
可靠性：异常情况处理，稳定性保证
简洁：逻辑简单，后续调整功能或者新增功能是否能够快速支持
清晰：其他人阅读代码是否能够清楚明白，重构或者修改功能是否不会担心无法预料的问题

编程原则

简单性：消除多余的复杂性，以简单清晰的逻辑编写代码
可读性：确保代码可读性高
生产力：团队整体工作效率非常重要

1.2 编码规范

1.2.1 代码格式

推荐使用gofmt自动格式化代码，在goland中设置

1.2.2 注释

解释代码作用
解释代码是如何做的
解释代码实现的原因
解释代码什么情况下会出错

Good code has lots of comments, bad code requires lots of comments. 好的代码有很多注释，坏代码需要很多注释代码是最好的注释
注释应该提供代码未表达出的上下文信息

1.2.3 命名规范

变量名 variable

简洁胜于冗长
缩略词全大写，但其位于变量开头且不需要导出时使用全小写
使用ServerHTTP而不是ServerHttp
使用XMLHTTPRequest或xmlHTTPREquest
尽量携带较多的上下文信息

函数名 function

函数名不携带包名的上下文信息，因为包名和函数名总是成对出现
函数名尽可能短
当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
当名为foo的包的某个函数返回类型T时（T并不是Foo），可以在函数名中加入类型信息

包名 package

只由小写字母组成。不包含大写字母和下线等字符
简短并包，含一定的上下文信息。例如schema、task等
不要与标准库同名。例如不要使用sync或者strings
以下规则尽量满足，以标准库包名为例
不使用常用变量名作为包名。例如使用bufio而不是buf
使用单数而不是复数。例如使用encoding而不是encodings
谨慎地使用缩写。例如使用fmt在不破坏上下文的情况下比format更加简短

命名规范核心目标是降低阅读理解代码的成本
重点考虑上文信息，设计简洁清晰的名称

1.2.4 控制流程

避免嵌套，保持正常流程清晰

尽量保持正常代码路径为最小缩进

1.2.5 错误和异常处理

简单错误

仅出现一次，在其他地方不需要捕获该错误
优先使用errors.New来创建匿名变量来直接表示简单错误
如果有格式化的需求，使用fmt.Errorf

错误的Wrap和Unwarp
错误的wrap是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链
在fmt.Errorf中使用：%w关键字来将一个错误关联至错误链中

错误判定
使用errors.Is判定一个错误是否为特定错误
不同于==，使用该方法可以判定错误链上的所有错误是否含有特定的错误

errors.As方法，用于在错误链上获取特定种类的错误
和Is方法的区别在于as方法会提取调用链中指定类型的错误，并将错误赋值给定义好的变量，方便处理

panic
panic是比错误更严重的问题，它表示程序无法正常工作了。在业务中不建议使用panic，因为panic发生后，会向上传播至调用栈顶，如果当前goroutine中所有defered函数都不包含recover就会造成整个程序崩溃。若问题可以解决，建议用error代替panic。当程序启动阶段发生不可逆转的错误时，可以在init或main函数中使用panic
recover

recover只能在被defer的函数中使用
嵌套情况下无法生效
只在当前goroutine生效
defer语句是后进先出
如果需要更多的上下文信息，可以在recover后的log中记录当前的调用栈小结
error尽可能提供简明的上下文信息链，方便定位问题
panic用于真正异常的情况
recover生效范围，在当前goroutine的被defer中生效

1.3 性能优化

1.3.1 性能优化建议-Benchmark

//性能测试函数
func Division(a, b float64) (float64, error) {
   if b == 0 {
      return 0, errors.New("除数不能为0")
   }

   return a / b, nil
}

//Benchmark测试函数
func Benchmark_Division(b *testing.B) {
   for i := 0; i < b.N; i++ { //use b.N for looping
      Division(4, 5)
   }
}

测试结果 go test -bench=. -benchmem

1.3.2 性能优化建议-slice

1.3.3 性能优化建议-map

尽可能在使用make初始化时提供容量信息

func NoPreAlloc(size int) {
   data := make([]int, 0)
   for k := 0; k < size; k++ {
      data = append(data, k)
   }
}
func PreAlloc(size int) {
   data := make([]int, 0, size)
   for k := 0; k < size; k++ {
      data = append(data, k)
   }
}

func BenchmarkNoPreAlloc(b *testing.B) {
   for i := 0; i < b.N; i++ { //use b.N for looping
      NoPreAlloc(6)
   }
}

func BenchmarkPreAlloc(b *testing.B) {
   for i := 0; i < b.N; i++ { //use b.N for looping
      PreAlloc(6)
   }
}

1.3.4 性能优化建议-字符串处理

使用预分配同样也可以优化

1.3.5 性能优化建议-空结构提

使用空结构体节省内存

空结构体实例不占据任何内存空间
可作为各种场景下的占位符使用
实现set可以考虑用map键代替，只需要用到map的键，而不需要值

1.3.6 性能优化建议-使用atomic包

锁的实现是通过操作系统实现，属于系统调用
atomic操作通过硬件实现，效率比索高
sync.Mutex应该用来保护一段逻辑，不仅仅用于保护一个变量
对于非数值操作，可以使用atomic.Value，能承载一个interface{}

2 性能调优实战

2.1 性能分析工具pprof

pprof是用于可视化和分析性能、分析数据的工具，可以查看应用在什么地方耗费了多少CPU、Memory

2.2 应用排查实战

2.2.1 CPU资源占用分析

运行程序后访问pprof网页 http://localhost:6060/debug/pprof/allocs?debug=1
使用命令 go tool pprof "http://localhost:6060/debug/pprof/profile?seconds=10" top命令查看占用资源最多的函数 list命令根据指定的正则表达式查找代码行 web命令调用关系可视化
如果报下面的错误是因为电脑没有安装gvedit导致的
进入gvedit官网graphviz.gitlab.io/_pages/Down… 下载稳定版即可。