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

GO编程规范&性能分析调优笔记

一、高质量编程

特点：简单性、可读性、生产力。

1.1 代码格式

使用gofmt自动格式化代码（已安装，可取GOPATH下的bin目录查看是否安装）

1.2 注释

【作用】

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

【何时加注释】

包中声明的每个公共的符号:变量、常量、函数以及结构都需要添加注释
- 注意，一些让参考其他文档的注释就可以删掉，注释应该提供代码为表达出的上下文信息
任何既不明显也不简短的公共功能必须予以注释
无论长度或复杂程度如何,对库中的任何函数都必须进行注释

1.3 命名规范

【变量名】

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

【函数名】

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

【包名】

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

1.4 控制流程

避免嵌套，保持正常流程清晰
尽量保持正常代码路径为最小缩进（优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套）

1.5 错误和异常处理

error 尽可能提供简明的上下文信息链，方便定位问题
panic 用于真正异常的情况（但是不建议使用panic，若问题可以被屏蔽或解决，建议使用error 代替 panic）
recover 注意该函数的生效范围，在当前goroutine的被defer的函数中生效

二、性能调优

2.1 调优的小tips

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

【优化小点】

slice切片尽量预分配内存。
slice切片注意大内存未释放的问题。
- 在已有切片基础上创建切片，不会创建新的底层数组。因此若原切片较大，代码在原切片基础上新建小切片，原底层数组在内存中有引用，得不到释放
- 解决方法：可使用copy替代 re-slice
map 尽量预分配内存(同样用make()来提前分配空间)。
string拼接时的性能：
使用空结构体节省内存
- 实现Set，可以考虑用map来代替
- 对于这个场景，只需要用到map的键，而不需要值
- 即使是将map 的值设置为bool类型，也会多占据1个字节空间
针对一个变量，使用atomic包来代替sync.Mutex锁（用于保护一段逻辑）

2.2 性能优化分析工具

常用pprof工具，下面我们看看pprof的排查实战，以这个演示文件为主：程序演示

我们通过import "net/http/pprof" //自动注册pprof的handler到http server

随后创造协程启动分析网页

    go func() {
        if err := http.ListenAndServe(":6060", nil); err != nil {
            log.Fatal(err)
        }
        os.Exit(0)
    }()

最后根据URL：http://localhost:6060/debug/pprof/，即可打开网页中pprof的分析。

allocs: 内存分配情况
block: 阻塞情况
cmdline: 程序的启动命令
goroutine: 所有当前goroutine的堆栈跟踪
- 常常使用火焰图
  - 由上到下表示调用顺序
  - 每一块代表一个函数，越长代表占用CPU的时间更长
  - 火焰图是动态的，支持点击块进行分析，当想要分析某一个特定函数的情况时，就可以点击进去
heap: 代码的内存情况。您可以指定gcGET参数以在获取堆样本之前运行gc。
- 【常用网页测试方法】例如：go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/heap"
- 相当于profile那里先采集后web，但是这样会集成很多ui,可以选择生成火焰图、top或者list等多个方式
  - 例如sample栏可以选择不同的采样类型，查看是否有异常占用内存的
    - alloc_objects：程序累计申请的对象数
    - inuse_objects：程序当前持有的对象数
    - alloc space：程序累计申请的内存大小
    - inuse space：程序当前占用的内存大小
mutex: 争用互斥锁持有者的堆栈跟踪
profile: CPU配置文件。可以在秒GET参数中指定持续时间。获取配置文件后，使用go工具pprof命令调查配置文件。如在终端使用：go tool pprof http://localhost:6060/debug/pprof/profile?seconds=10 //采集十秒，采集完后进入pprof界面，
- 随后使用top便可查看占用资源最多的函数。
  - flat:当前函数本身的执行耗时
  - flat% flat占 CPU总时间的比例
  - sum%上面每一行的flat%总和
  - cum 指当前函数本身加上其调用函数的总耗时
  - cum% cum占 CPU总时间的比例
- 使用list + 函数名也可以查看特定函数内具体代码行的执行时间
- 使用web命令，会以视图的形式打开函数的调用关系以及其占用CPU的时间
threadcreate: 导致创建新操作系统线程的堆栈跟踪
trace: 当前程序的执行轨迹。可以在秒GET参数中指定持续时间。获取跟踪文件后，使用go工具跟踪命令来调查跟踪。

2.3 性能调优案例

基本概念

服务:能单独部署，承载一定功能的程序

依赖:Service A的功能实现依赖Service B的响应结果，称为Service A依赖Service B
调用链路:能支持一个接口请求的相关服务集合及其相互之间的依赖关系
基础库:公共的工具包、中间件

常见问题

我们常常可以通过火焰图来查看一个或者某个函数中出现的常见问题。

使用库不规范（日志库（打很多无用的东西）& json库等.. ）
高并发场景优化不足（对比高CPU占用和低CPU占用的火焰图，分析哪些函数or库在大流量时上涨得比较明显，比较占用资源）

GO编程规范&性能分析调优笔记 | 青训营笔记