Go高质量编程与性能调优

这是我参加【第五届青训营】伴学笔记创作活动的第三天

前言

本文记录和整理本人对Go语言高质量编程与性能调优课程内容的个人见识，编写本文目的是方便我自己的复习和查阅。

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

一、本节课重点内容

• 高质量编程
  • 高质量编程简介
  • 编码规范
  • 性能优化建议
• 性能调优实战
  • 性能调优简介
  • 性能分析工具pprof实战
  • 性能调优案例

二、详细知识点介绍

1.1 高质量编程简介

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

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

编程原则：

实际应用场景千变万化，各种语言的特性和语法各不相同，但是高质量编程遵循的原则是相通

简单性:

• 消除"多余的复杂性"，以简单清晰的逻辑编写代码
• 不理解的代码无法修复改进 可读性:
• 代码是写给人看的，而不是机器
• 编写可维护代码的第一步是确保代码可读

生产力:

• 团队整体工作效率非常重要

1.2 编写规范

如何编写高质量的Go代码

• 代码格式
• 注释
• 命名规范
• 控制流程
• 错误和异常处理

1.2.1 编码规范-代码格式

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

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

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

1.2.2 编码规范-注释

简介：

注释应该做的:

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

公共符号始终要注释

• 包中声明的每个公共的符号:变量、常量、函数以及结构都需要添加注释
• 任何既不明显也不简短的公共功能必须予以注释
• 无论长度或复杂程度如何，对库中的任何函数都必须进行注释
• 有一个例外，不需要注释实现接口的方法，具体不要像下面这么做

• 对于公共符号都有注释说明
• 尽管 LimitedReader.Read本身没有注释，但它紧跟LimitedReader结构的声明，明确它的作用

小结：

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

1.2.3 编程规范-命名规范

variable

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

//Bad
for index:=0;index<len(s);index++{
	//do something
}
//Good
for i:=0;i<len(s);i++{
	//do something
}

i和index的作用域范围仅限于for循环内部时，index的额外冗长几乎没有增加对应程序的理解

//Good
func (c *Client)  send(req *Request,deadline time.Time)
//Bad
func (c *Client)  send(req *Request,t time.Time)

• 将deadline替换成t降低了变量名的信息量
• t常代指任意时间
• deadline指截止时间，有特定含义

function

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

package

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

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

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

小结：

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

1.2.4 编码规范-控制流程

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

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

如果两个分支中都包含return语句，则可以去除冗余的else

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

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

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

• 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
• 最常见的正常流程的路径被嵌套在两个if条件内
• 成功的退出条件是return nil，必须仔细匹配大括号来发现
• 函数最后一行返回一个错误，需要追溯到匹配的左括号，才能了解何时会触发错误
• 如果后续正常流程需要增加一步操作，调用新的函数，则又会增加一层嵌套

小结：

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

1.2.5 编码规范-错误和异常处理

简单错误

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

func defaultCheckRedirect(req *Request,via []*Request) error{
	if len(via)>=10{
		return errors.New("stopped after 10 redirects")
	}
	return nil
} //如果via的长度达到10次的时候，停止进程

错误的Wrap 和Unwrap

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

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

错误判定

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

data,err=lockedfile.Read(targ)
if errors.Is(err,fs.ErrNotExist){
	return []byte{},nil
}
return data,err 

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

panic

• 不建议在业务代码中使用panic
• 调用函数不包含recover会造成程序崩溃
• 若问题可以被屏蔽或解决，建议使用error代替panic
• 当程序启动阶段发生不可逆转的错误时，可以在init或mian函数中使用panic

recover

• recover只能在被defer的函数中使用
• 嵌套无法生效
• 只在当前goroutine生效
• defer的语句是后进先出
• 如果需要更多的上下文信息，可以recover后在log中记录当前的调用栈

小结:

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

1.3 性能优化建议

简介

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

1.3.1 性能优化建议-Benchmark

如何使用

• 性能表现需要实际数据衡量
• Go语言提供了支持基准性能测试的benchmark工具

结果说明

1.3.2 性能优化建议-Slice

slice预分配内存 尽可能在使用make()初始化切片时提供容量信息

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

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

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

1.3.3 性能优化建议-Map

map预分配内存

分析

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

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

使用strings.Builder

常见的字符串拼接方式

func Plus(n int,str string) string{
	s:=""
	for i:=0;i<n;i++{
		s+=str
	}
	return s
}

func StrBuilder(n int,str string) string{
	 var builder strings.Builder
	 for i:=0;i<n;i++{
		builder.WriteString(str)
	 }
	 return builder.String()
}

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,byte.Buffer相近，strings.Buffer更快

分析

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

func (b *Buffer) String() string{
	if b==nil{
		return "<nil>"
	}
	return string(b.buf[b.off:])
}

func (b *Builder) String() string{
	return *(*string)(unsafe.Pointer(&b.buf))
}

• bytes.Buffer转化为字符串时重新申请了一块空间
• strings.Builder直接将底层的[]byte 转化成了字符串类型返回

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

使用空结构体节省内存

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

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.3.6 性能优化建议-atomic包

使用atomic包

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

小结:

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

2 简介

性能调优原则

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

2.2 性能分析工具 pprof

说明

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

pprof-功能简介

2.3 性能调优案例

介绍实际业务服务性能优化的案例

对逻辑相对复杂的程序如何进行性能调优

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

总结：

本人对性能分析工具pprof不是很了解，没有做太详细的编写，和如何性能调优，需要自己再学习一下，等以后再添加这部分的编写描述。