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

昨天对于Go 语言进阶、依赖管理以及工程实践测试做出总结

今天将对高质量编程的各种原则和规范进行复习和总结，以及对于pprof工具分析代码性能的使用和复习，达到性能调优的目的

一. 高质量编程

1. 高质量编程简介

   什么是高质量

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

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

1.1 编程原则

实际应用场景干变万化，各种语言的特性和语法各不相同

但是高质量编程遵循的原则是相通的

简单性

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

1.2 如何编写高质量的G0代码

代码格式注释

命名规范

控制流程

错误和异常处理

2. 编码规范

2.1 编码规范——代码格式

推荐使用gofmt自动格式化代码

gofmt

G0语言官方提供的工具，能自动格式化G0语言代码为官方统一风格常见IDE都支持方便的配置

goimports

也是G0语言官方提供的工具实际等于gofmt加上依赖包管理自动增删依赖的包引用、将依赖包按字母序排序并分类

2.2 编码规范——注释

公共符号始终要注释

包中声明的每个公共的符号变量、常量、函数以及结构都需要添加注释
任何既不明显也不简短的公共功能必须予以注释
无论长度或复杂程度如何，对库中的任何函数都必须进行注释

简介

注释应该做的
- 注释应该解释代码作用
  - 适合注释公共符号、函数功能
- 注释应该解释代码如何做的
  - 适合注释实现过程
- 注释应该解释代码实现的原因
  - 适合注释代码的外部因素
  - 提供额外上下文
- 注释应该解释代码什么情况会出错
  - 适合解释代码的限制条件

小结

代码是最好的注释
注释应该提供代码末未表达出的上下文信息

2.3 编码规范——命名规范

variable(变量)

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

function

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

package

只由小写字母组成。不包含大写字母和下划线等字符
简短并包含一定的上下文信息。例如schema、task等
不要与标准库同名。例如不要使用sync或者strings

以下规则尽量满足，以标准库包名为例

不使用常用变量名作为包名。例如使用bufio而不是buf
使用单数而不是复数。例如使用encoding而不是encodings
谨慎地使用缩写。例如使用fmt在不破坏上下文的情况下比format更加简短

小结

核心目标是降低阅读理解代码的成本
重点考虑上下文信息，设计简洁清晰的名称
让理解代码更简洁易懂是编码规范的主要目标

2.4 编码规范——控制流程

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

//Bad
if foo {
    return x
} else {
    retrun nil
}
//Good
if foo {
    return x
}
return nil

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

优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套

最常见的正常流程的路径被嵌套在两个仟条件内
成功的退出条件是return nil,必须仔细匹配大括号来发现
函数最后一行返回一个错误，需要追溯到匹配的左括号，才能了解何时会触发错误
如果后续正常流程需要增加一步操作，调用新的函数，则又会增加一层嵌套

//Bad
func OneFunc() err {
    err := doSomething()
    if err == nil {
        err := doAnotherThing()
        if err == nil {
            return nil //normal case
        }
        return err;
    }
    return err
}

调整后

//Good
func OneFunc() err {
    if err := doSomething(); err != nil {
        return err;
    }
    if err := doAnotherThing(); err != nil {
        return err
    }
    return nil //normal case
}

小结

线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
正常流程代码沿着屏幕向下移动
提升代码可维护性和可读性
故障问题大多出现在复杂的条件语句和循环语句中

2.5 编码规范——错误和异常处理

简单错误

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

例如：

func defaultCheckRedirect(req *Request, via []*Request) err {
    if len(via) >= 10 {
        return errors.New("stopped after 10 redirects")
    }
    return nil
}

错误的Wrap和Unwrap

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

Go1.13在errors中新增了三个新APl和一个新的format关键字，分别是errors..Is errors.As,errors.Unwrap以及fmt.Errorf的%w。如果项目运行在小于Go1.13的版本中，导入 golang.org/x/xerrors 来使用

list, _, err := c.GetBytes(cache.Subkey(a.actionID, "srcfiles"))
if err != nil {
    return fmt.Errorf("reading srcfiles list: %w", err)
}

错误判定

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

date, err = lockedfile.Read(targ)
if errors.Is(err, fs.ErrNotExist) {
    //Treat non-existent as empty,to bootstrap the "latest"file
    //the first time we connect to a given database.
    return []byte{},nil
}
return date, err

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

if _, err := os.Open("non_existing"); err != nil {
    var pathError *fs.PathError
    if errors.As(err, &pathError) {
        fmt.Pringtln("Failed at path:",pathError.Path)
    } else {
        fmt.Println(err)
    }
}

panic

不建议在业务代码中使用panic
调用函数不包含recover会造成程序崩溃
若问题可以被屏蔽或解决，建议使用

error代替panic

当程序启动阶段发生不可逆转的错误时，可以在init或main函数中使用panic

func main(){
    //...
    ctx, cancel := context.WithCancel(context.Background())
    client, err := sarama.NewConsumerGroup(strings.Split(brokers, 
","),group,config）
    if err != nil {
        log.Panicf("Error creating consumer group client:%v",err)
    }
}

//Panicf is equivalent to Printf()followed by a call to panic().
func Panicf(format string,v ...interface{}){
    s :fmt.Sprintf(format, v...)
    std.Output(2,s)
    panic(s)
}

recover

recover只能在被defer的函数中使用
嵌套无法生效
只在当前 goroutine 生效
defer 的语句是后进先出

func (s *ss) Token(skipSpace bool, f func(rune) bool) (tok []byte, err error){
    defer func() {
        if e := recover(); e != nil {
            if se, ok := e.(scanError); ok {
                err = se.err
            } else {
                panic(e)
            }
        }
    }
    //...
}

如果需要更多的上下文信息，可以 recover 后在 log 中记录当前的调用栈

func (t *treeFS) Open(name string) (f fs.File, err error){
    defer func(){
        if e := recover(); e !nil {
            f = nil
            err fmt.Errorf("gitfs panic:%v\n%s",e,debug.Stack())
        }
    }()
    //...
}

小结 ,ro尽可能提供简明的上下文信息链，方便定位问题 panic用于真正异常的情况 recover生效范围，在当前goroutine的被defer的函数中生效

3. 性能优化建议

简介

性能优化的前提是满足正确可靠、简洁清晰等质量因素
性能优化是综合评估，有时候时间效率和空间效率可能对立
针对G0语言特性，介绍G0相关的性能优化建议

3.1 性能优化建议——Benchmark

如何使用

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

//form fib.go
func Fib(n int) int {
    if n<2 {
        return n
    }
    return Fib(n-1) + Fib(n-2)
}
// from fib_test.go
func BenchmarkFib10(b *testing.B) {
    // run the Fib function b.N times
    for n := 0; n < b.N; n++ {
        Fib(10)
    } 
}

结果说明

1. BenchmarkFib10-8：`BenchmarkFib10`是测试函数名, - 8表示GOMAXPROCS的值为8
2. 一串数字N：表示一共执行了N次，即b.N的值
3. F ns/op；表示每次执行花费 F ns
4. 0 B/op：表示每次申请多大的内存
5. 0 alloc/op：表示每次执行申请几次内存

3.2 性能优化建议——Slice

slice 预分配内存

尽可能在使用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)
    }
}

运行结果：

slice预分配内存

切片本质是一个数组片段的描述
- 包括数组指针
- 片段的长度
- 片段的容量（不改变内存分配情况下的最大长度）
切片操作并不复制切片指向的元素
创建一个新的切片会复用原来切片的底层数组

另一个陷阱：大内存未释放

在已有切片基础上创建切片，不会创建新的底层数组场景
场景
- 原切片较大，代码在原切片基础上新建小切片
- 原底层数组在内存中有引用，得不到释放
可使用copy替代re-slice

func GetLastByslice(origin []int)[]int {
    return origin[len(origin)-2:]
}
func GetLastByCopy(origin []int)[]int {
    result := make([]int,2)
    copy(result, origin[len(origin)-2:]
    return result
}

func testGetLast(t *testing.T,f func([]int)[]int) {
    result := make([][]int, 0)
    for k := 0; k<100; k++ {
        origin := generatewithCap(128 1024)//1M
        result = append(result, f(origin))
    }
    printMem(t)
    _  = result
}

执行run test -run=. -v后发现第二个方法占用内存明显比第一个占用内存少

3.3 性能优化建议——Map

Map 预分配内存

//未预分配类型
func NoPreAlloc(size int) {
    data make(map[int]int)
    for i := 0; i < size; i++ {
        data[i]1
    }
}

//预分配类型
func PreAlloc(size int) {
    data make(map[int]int, size)
    for i := 0; i < size; i++ {
        data[i]1
    }
}

分析

不断向map中添加元素的操作会触发map的扩容
提前分配好空间可以减少内存拷贝和Rehash的消耗
建议根据实际需求提前预估好需要的空间

3.4 性能优化建议——字符串处理

使用string.Builder

常见的字符串拼接方式

//自然拼接
func Plus(n int,str string)string {
    s := ""
    for i := 0; i < n; i++ {
        s += str
    }
    return s
}
//使用Builder拼接
func strBuilder(n int,str string)string {
    var builder strings.Builder
    for i := 0; i < n; i++ {
        builder.Writestring(str)
    }
    return builder.String()
}
//使用bytes.Buffer 
func ByteBuffer(n int,str string)string {
    buf := new(bytes.Buffer)
    for i := 0; i < n; i++ {
        buf.Writestring(str)
    }
    return buf.String()
}

结果性能差异比较

使用+拼接性能最差，strings.Builder,bytes.Buffer相近strings.Buffer更快分析
字符串在G0语言中是不可变类型，占用内存大小是固定的
使用+每次都会重新分配内存
strings.Builder,bytes.Buffer底层都是[]byte数组
内存扩容策略，不需要每次拼接重新分配内存

//预分配内存stringsBuilder
func PrestrBuilder(n int,str string)string {
    var builder strings.Builder
    builder.Grow(n len(str))
    for i := 0; i < n; i++ {
        builder.Writestring(str)
}
    return builder.String()
}

//预分配内存byteBuffer
func PrebyteBuffer(n int,str string)string {
    buf new(bytes.Buffer)
    buf.Grow(n len(str))
    for i := 0; i < n; i++ {
        buf.Writestring(str)
    }
    return buf.String(
}

性能分析

3.5 性能优化建议——空结构体

使用空结构体节省内存

空结构体struct0实例不占据任何的内存空间
可作为各种场景下的占位符使用
- 节省资源
- 空结构体本身具备很强的语义，即这里不需要任何值，仅作为占位符

func EmptystructMap(n int){
    m make(map[int]struct{})
    for i := 0; i < n; i++
        m[i] = struct{}{}
    }

func BoolMap(n int){
    m make(map[int]bool)
    for i := 0; i < n; i++ {
        m[i] = false
}
}

性能分析

实现Set,可以考虑用map来代替
对于这个场景，只需要用到map的键，而不需要值
即使是将map的值设置为bool类型，也会多占据1个字节空间

一个开源实现：https:/github.com/deckarep/golang-set/blob/main/threadunsafe.go

3.6 性能优化建议——atomic 包

type atomicCounter struct
    i int32
}

func AtomicAddone(c *atomicCounter)
    atomic.AddInt32(&c.i, 1)
}

使用atomic包

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

小结

避免常见的性能陷阱可以保证大部分程序的性能
普通应用代码，不要一味地追求程序的性能
越高级的性能优化手段越容易出现问题
在满足正确可靠、简洁清晰的质量要求的前提下提高程序性能

二. 性能调优实战

1. 性能优化简介

性能调优原则

要依靠数据不是猜测
要定位最大瓶颈而不是细枝末节
不要过早优化
不要过度优化

2. 性能分析工具 pprof 实战

2.1 性能分析工具 pprof

说明

希望知道应用在什么地方耗费了多少CPU、Memory
pprof是用于可视化和分析性能分析数据的工具
pprof功能简介
pprof排查实战
pprof的采样过程和原理

2.2 性能分析工具 pprof功能简介

2.3 性能分析工具 pprof-排查实战

搭建pprof实践项目

GitHub(来自Wolfogre)
github.com/wolfogre/go…
项目提前埋入了一些炸弹代码，产生可观测的性能问题

前置准备

下载项目代码，能够编译运行

会占用1CPU核心和超过1GB的内存

浏览器查看指标

地址：localhost:6060/debug/pprof

CPU排查

终端输入 go tool pprof "http://localhost:6060/debug/pprof/profile?seconds=10"后会显示为下面的样子然后可以输入：

命令：top
查看占用资源最多的函数

图中参数：
flat：当前函数本身的执行耗时
flat%： flat 占 CPU总时间的比例
sum%：上面每一行的 flat% 总和
cum：指当前函数本身加上其调用函数的总耗时
cum%：cum 占CPU 总时间的比例

Flat =Cum,函数中没有调用其他函数
Flat ==0,函数中只有其他函数的调用

命令：list
根据指定的正则表达式查找代码行

命令：web
调用关系可视化

Heap-堆内存

go tool pprof -http=:8080 'http://localhost:6060/debug/pprof/heap

可视化查看堆内存

参数解读(当前：inuse_space)
alloc_objects；程序累计申请的对象数
alloc_space：程序累计申请的内存大小
inuse_objects：程序当前持有的对象数
inuse_space：程序当前占用的内存大小

goroutine-协程

go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/goroutine"

由上到下表示调用顺序
每一块代表一个函数，越长代表占用CPU的时间更长
火焰图是动态的，支持点击块进行分析

mutex-锁

go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/mutex"

block-阻塞

go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/block'

2.4 性能分析工具pprof-.采样过程和原理

CPU

采样对象：函数调用和它们占用的时间
采样率：100次/秒，固定值
采样时间：从手动启动到手动结束

graph TD
开始采样 --> 设定信号处理函数  --> 开启定时器 
停止采样 -->  取消信号处理函数 --> 关闭定时器

操作系统
- 每 10 ms向进程发送一次SIGPROF信号
进程
- 每次接收到SIGPROF会记录调用堆栈
写缓冲
- 每100ms读取已经记录的调用栈并写入输出流

Heap-堆内存

采样程序通过内存分配器在堆上分配和释放的内存，记录分配/释放的大小和数量
采样率：每分配512KB记录一次，可在运行开头修改，1 为每次分配均记录
采样时间：从程序运行开始到采样时
采样指标alloc space,alloc objects,inuse_space,inuse objects
计算方式：inuse=alloc-free

Goroutine-协程&ThreadCreate-线程创建

Goroutine
- 记录所有用户发起且在运行中的goroutine(即入口非runtime?开头的)runtime.main的调用栈信息
ThreadCreate
- 记录程序创建的所有系统线程的信息

flowchart LR
id1([Goroutine:])
A[Stop The World] --> B[遍历allg切片] --> C[输出创建g的堆栈] --> D[Start The World]
id2([ThreadCreate:])
E[Stop The World] --> F[遍历allm链表] --> G[输出创建m的堆栈] --> H[Start The World]

Block-阻塞&Mutex-锁

阻塞操作
- 采样阻塞操作的次数和耗时
- 采样率：阻塞耗时超过阈值的才会被记录,1为每次阻塞均记录

flowchart TB
阻塞操作 --上报调用栈和消耗时间--> Profiler --采样--> 遍历阻塞记录 --> 统计阻塞次数和耗时
Profiler --> 时间未到阈值则丢弃

锁竞争
- 采样争抢锁的次数和耗时
- 采样率：只记录固定比例的锁操作，1为每次加锁均记录

flowchart TB
锁竞争操作 --上报调用栈和消耗时间--> Profiler --采样--> 遍历锁记录 --> 统计锁竞争次数和耗时
Profiler --> 比例未命中则丢弃

小结

掌握常用pprof工具功能
灵活运用pprof工具分析解决性能问题
了解pprof的采样过程和工作原理

3. 性能调优实践

3.1 简介

介绍实际业务服务性能优化的案例对逻辑相对复杂的程序如何进行性能调优

业务服务优化
基础库优化
Go 语言优化

3.2 业务服务优化

基本概念

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

流程

建立服务性能评估手段
分析性能数据，定位性能瓶颈
重点优化项改造
优化效果验证

建立服务性能评估手段

服务性能评估方式
- 单独benchmark无法满足复杂逻辑分析
- 不同负载情况下性能表现差异
请求流量构造
- 不同请求参数覆盖逻辑不同
- 线上真实流量情况
压测范围
- 单机器压测
- 集群压测
性能数据采集
- 单机性能数据
- 集群性能数据