这是我参与「第五届青训营」伴学笔记创作活动的第3天
一、高质量编程
高质量编程简介
1.编码规范
2.性能优化建议
3.性能调优实战
4.性能调优简介
5.性能分析工具pprof实战
6.性能调优案例
什么是高质量？
——编写的代码能够达到正确可靠。简洁清晰的目标可称之为高质量代码
各种边界条件是否考虑完备
异常情况处理，稳定性保证
易读易维护
编程原则
简单性
消除“多余的复杂性”，以简单清晰的逻辑编写代码
不理解的代码无法修复改进 可读性
代码是写给人看的，而不是机器
编写可维护代码的第一步是确保代码可读
生产力
团队整体工作效率非常重要
二、编码规范
如何写出高质量的Go代码
代码格式
注释
命名规范
控制流程
错误和异常处理
编码规范——注释
公共符号始终要注释
包中声明的每个公共的符号:变量、常量、函数以及结构都需要添加注释
任何既不明显也不简短的公共功能必须予以注释
无论长度或复杂程度如何，对库中的任何函数都必须进行注释
有一个例外：不需要注释实现接口的方法，具体不要想下面这样做
// Read implements the io. Reader interface
func (r *FileReader) Read(buf [ ]byte) ( int, error)
编码规范——代码格式
推荐使用gofmt自动格式化代码
gofmt
GO语言官方提供的工具，能自动格式化Go语言代码为官方统-风格常见IDE都支持方便的配置
goimports
也是Go语言官方提供的工具
实际等于gofmt加上依赖包管理
自动增删依赖的包引用、将依赖包按字母序排序并分类
编码规范——注释
简介 注释应该做的
1.注释应该解释代码作用
2.注释应该解释代码如何做的
3.注释应该解释代码实现的原因
4.注释应该解释代码什么情况会出错
好的代码有很多注释，坏代码需要很多注释
适合注释的公共符号（注释说明）
适合注释的过程（主要是注释功能）
注释代码实现的原因，为什么这么做，提供额外上下文
注释，代码的限制条件，在什么情况下会出错
// LimitReader returns a Reader that reads from r
// bat stops with EOF after n bytes.
// The underlying implementation is a *LimitedReader
func LittReader(r Reader, m int64) Reader { return &LimitedReader(r, n) }
// A LimitedReader reads from R but limits the amount of
// data returned to just N bytes. Each call to Read
// updates N to reflect the new amount remaining.
// Read returns EOF when N <o 0 or when the underlying R returns EOF
type LimitedReader struct{
R Reader // underlying reader
N int64 // max bytes remaiging
}
func (l *LimitedReader) Read(p []byte) (n int, err error){
if l.N<=0{
return 0, EOF
}
if int64(len(p)) > l.N{
p = p[0:l.N]
}
n, err = l.R.Read(p)
l.N -- int64(n)
return
}
以上代码为正确案例
公共符号始终要注释
对于公共符号都有注释说明
尽管LimitedReader.Read本身没有注释，但它紧跟LimitedReader结构的声明，明确它的作用
注意：注释应该提供代码未表达出的上下文的信息
编码规范-命名规范
variable
简洁胜于冗长
缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
例如使用ServeHTTP而不是ServeHttp
使用XML HTTPRequest或者xmlHTTPRequest
变量距离其被使用的地方越远，则需要携带越多的上下文信息
全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
function
函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
函数名尽量简短
当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
当名为foo的包某个函数返回类型T时(T并不是Foo) ，可以在函数名中加入类型信息
package
只由小写字母组成。不包含大写字母和下划线等字符
简短并包含一定的上下文信息。例如schema、task 等
不要与标准库同名。例如不要使用sync或者strings
以下规则尽量满足，以标准库包名为例
不使用常用变量名作为包名。 例如使用bufio而不是buf
使用单数而不是复数。例如使用encoding而不是encodings
谨慎地使用缩写。例如使用fmt在不破坏上下文的情况下比format更加简短
小结
核心目标是降低阅读理解代码成本
重点考虑上下文信息，设计简介清晰的名称
编码规范——控制流程
避免嵌套，保持正常流程清晰
尽量保持正常代码路径最小为缩进
小结
线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
正常流程代码沿着屏幕向下移动
提升代码可维护性和可读性
故障问题大多出现在复杂的条件语句和循环语句中
三、编码规范错误和异常处理
简单错误
简单的错误指的是仅出现一次的错误， 且在其他地方不需要捕获该错误优先使用errors.New来创建匿名变量来直接表示简单错误
如果有格式化的需求，使用fmt.Errorf
例如：
func defaultCheckRedirect(req *Request, via []*Request) error {
if len(via) >=10{ h
return errors. New("stopped after 10 redirects")
}
return nil
}
复杂错误
错误的Wrap和Unwrap
错误的Wrap实际上是提供了一个error 嵌套另一个
error的能力，从而生成一个error的跟踪链
在fmt.Errorf中使用: %w关键字来将一个错误关联至
错误链中
Go1.13在errors中新增了三个新API和一个新的format关键字，分别是errors.lsverrors.As,errors.Unwrap以及fmt.Errorf的%W。如果项目运行在小于Go1.13的版本中，导入 golang.org/x/xerrors来使用
list, _, err := C.GetBytes( cache . Subkey(a.actionID; "srcfilbs"))iferr!=nil{
return fmt .Errorf("reading srcfiles list: %w"，err)
}
错误判定
判定一个错误是否为特定错误，使用errors.Ils
不同于使用==,使用该方法可以判定错误链上的所有错误是否含有特定的错误
data, 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 data, err
在错误链上获取特定种类的错误，使用errors.As
err := os.Open("non-existing"); err != nil {
var pathError ★fs. PathError
if errors.As(err, &pathError) {
fmt.Println("Failed at poth:", pathError.Path)
} else {
fmt. Println(err)
}
}
panic
不建议在业务代码中使用panic
调用函数不包含recover会造成程序崩溃若问题可以被屏蔽或解决，建议使用
error代替panic
当程序启动阶段发生不可逆转的错误时，可以在init 或main函数中使用panic
recover
recover只能在被defer的函数中使用嵌套无法生效
只在当前goroutine生效
defer的语句是后进先出
如果需要更多上下文的信息，可以recover后在log中记录当前的调用栈
四、编码规范错误和异常处理
小结
error尽可能提供简明的上下文信息链，方便定位问题
panic用于真正异常的情况
recover生效范围，在当前goroutine的被defer的函数中生效
程序的输出是什么?
func main() {
if true {
defer fmt.Printf("1")
//defer语句会在函数返回前调用
} else {
defer fmt.Printf("2")
//多个defer语句是后进先出
}
defer fmt.Printf("3")
}
输出结果为3、1
性能优化建议
性能优化的前提是满足正确可靠、简洁清晰等质量因素
性能优化是综合评估，有时候时间效率和空间效率可能对立。
针对Go语言特性，介绍Go相关的性能优化建议
性能优化建议—Benchmark
如何使用
性能表现需要实际数据衡量
Go语言提供了支持基准性能测试的benchmark工具
测试性能命令 go test -bench=,-benchmen
性能优化建议——Slice
slice 预分配内存
尽可能在使用make( )初始化切片时提供容量信息
切片本质是一个数组片段的描述
包括数组指针
片段的长度
片段的容量(不改变内存分配情况下的最大长度).
切片操作并不复制切片指向的元素
创建一个新的切片会复用原来切片的底层数组
另一个陷阱:大内存未释放
在已有切片基础上创建切片，不会创建新的底层数组
场景
原切片较大，代码在原切片基础上新建小切片
原底层数组在内存中有引用，得不到释放
可使用copy替代re- slice
命令为go test -run=,-v
性能优化建议——map
map预分配内存
分析
不断向map中添加元素的操作会触发map的扩容
提前分配好空间可以减少内存拷贝和Rehash的消耗
建议根据实际需求提前预估好需要的空间
性能优化建议—字符串处理
使用 strings.Builder
使用+拼接性能最差，strings.Builder, bytes.Buffer 相近，strings.Buffer 更快
分析
字符串在Go语言中是不可变类型，占用内存大小是固定的
使用+每次都会重新分配内存
strings.Builder, bytes.Buffer 底层都是Dbyte数组
内存扩容策略，不需要每次拼接重新分配内存
bytes.Buffer转化为字符串时重新申请了一块空间
strings.Builder直接将底层的[]byte转换成了字符串类型返回
使用空结构体节省内存
空结构体struct}实例不占据任何的内存空间可作为各种场景下的占位符使用
节省资源
空结构体本身具备很强的语义，即这里不需要任何值，仅作为占位符
性能优化建议-空结构体
使用空结构体节省内存（map空结构）
实现Set, 可以考虑用map来代替
对于这个场景，只需要用到map的键，而不需要值
即使是将map的值设置为bool类型，也会多占据1个字节空间
一个开源实现: github.com/deckarep/go…
性能优化建议- -atomic包
使用atomic包
锁的实现是通过操作系统来实现，属于系统调用
atomic操作是通过硬件实现，效率比锁高
sync.Mutex 应该用来保护一段逻辑，不仅仅用于保护一个变量
对于非数值操作，可以使用atomic.Value,能承载一个interfacef{}
小结
避免常见的性能陷阱可以保证大部分程序的性能
普通应用代码，不要- -味地追求程序的性能
越高级的性能优化手段越容易出现问题
在满足正确可靠、简洁清晰的质量要求的前提下提高程序性能
