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

高质量编码和规范

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

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

注释

哪些地方需要注释

• 包中声明的每个公共的符号:变量、常量、函数以及结构都需要添加注释
• 对库中的任何函数都必须进行注释 注释应该怎么写
• 注释应该解释代码作用
• 注释应该解释代码如何做的
• 注释应该解释代码实现的原因
• 注释应该解释代码什么情况会出错

命名规范

变量

• 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
  • 例如使用ServeHTTP而不是ServeHttp
  • 使用XMLHTTPRequest或者xmlHTTPRequest
• 变量距离其被使用的地方越远，则需要携带越多的上下文信息
  • 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义

函数

• 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的,如http包中不建议出现ServerHTTP函数，而应该写成Server，因为在调用时http.ServerHTTP包名函数名重复
• 当名为foo 的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
• 当名为foo的包某个函数返回类型T时(T并不是Foo)，可以在函数名中加入类型信息 包
• 只由小写字母组成。不包含大写字母和下划线等字符
• 简短并包含一定的上下文信息。例如schema、task等
• 不要与标准库同名。例如不要使用sync或者strings
• 不使用常用变量名作为包名。例如使用bufio而不是buf
• 使用单数而不是复数。例如使用encoding而不是encodings
• 谨慎地使用缩写。例如使用fmt在不破坏上下文的情况下比 format更加简短

错误与异常处理

简单错误——指的是仅出现一次的错误，且在其他地方不需要捕获该错误

• 优先使用errors.New来创建匿名变量来直接表示简单错误
• 如果有格式化的需求，使用fmt.Errorf

错误的包装和解包（Wrap和Unwrap）

• 错误的Wrap 实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链
• 在fmt.Errorf中使用%w关键字来将一个错误关联至错误链中
• 判定一个错误是否为特定错误，使用errors.ls
• 不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误

data, err = lockedfile.Read(targ)
if errors.Is(err, fs.ErrNotExist) {
}

• 在错误链上获取特定种类的错误，使用errors.As

_, err = os.Open("non-existing")
if err != nil {
    var pathError *fs.Path.Error
    if errors.As(err, &pathError) {  
    } 
}

panic
少用

性能优化

Go语言提供了支持基准性能测试的benchmark工具

//from fib_test.go
func BenchmarkFib10(b *testing.B) {
    for i := 0; i < b.N; i++ {
       Fib(100)
    }
}

运行go test -bench=. -benchmem

性能优化建议

Slice

• 尽可能在使用make()初始化切片时提供容量信息，避免额外的扩容和复制
• 可使用copy替代 re-slice
  • 在已有切片基础上创建切片，不会创建新的底层数组。因此当原切片较大，代码在原切片基础上新建小切片。原底层数组在内存中有引用，得不到释放

Map

• 预分配内存
  • 不断向map中添加元素的操作会触发map的扩容
  • 提前分配好空间可以减少内存拷贝和rehash的消耗 字符串
• 使用strings.Builder
  • 字符串在Go语言中是不可变类型，占用内存大小是固定的
  • 使用＋每次都会重新分配内存
  • strings.Builder，bytes.Buffer底层都是byte数组
  • 内存扩容策略，不需要每次拼接重新分配内存

性能优化分析工具——pprof

希望知道应用在什么地方耗费了多少CPU、Memory pprof是用于可视化和分析性能分析数据的工具 功能简介

实战排查
运行命令

go tool pprof "http://localhost:6060/debug/pprof/profile?seconds=10"

输入命令top，查看最耗时的几个函数

• flat——当前函数本身的执行耗时
• flat%——flat占CPU总时间的比例
• sum%——上面每一行的flat%总和
• cum——指当前函数本身加上其调用函数的总耗时
• cum%——cum占CPU总时间的比例
  Eat函数耗时最多 输入命令list Eat，查看每一句代码的用时

查看堆内存

查看协程