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

简介

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

各种边界条件是否考虑完备

异常情况处理，稳定性保证

易读易维护

编程规则

简单性

消除“多余的复杂性”，以简单清晰的逻辑编写代码。不理解的代码无法修复改进

可读性

代码是写给人看的，而不是机器 · 编写可维护代码的第一步是确保代码可读

生产力

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

编码规范-注释

公共符号始终要注释

包中声明的每个公共的符号:变量、常量、函数以及结构都需要添加注释

任何既不明显也不简短的公共功能必须予以注释

无论长度或复杂程度如何,对库中的任何函数都必须进行注释

注释应该做的

注释应该解释代码作用-公共符号

注释应该解释代码如何做的-额外信息

注释应该解释代码实现的原因-提供额外上下文

注释应该解释代码什么情况会出错-限制条件

代码是最好的注释,注释应该提供额外上下文信息

编码规范-代码格式

使用gofmt自动格式化代码

goimports自动管理依赖包

编码规范-命名规范

variable

简洁胜于冗长

缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写

ServerHTTP而不是ServerHttp

使用XMLHTTPRequest或者xmlHTTPRequest

变量距离其被使用的地方越远，则需要携带越多的上下文信息

全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义

function

函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的

函数名尽量简短

当名为foo 的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义

当名为foo的包某个函数返回类型T时(T并不是 Foo)，可以在函数名中加入类型信息

package

只由小写字母组成。不包含大写字母和下划线等字符

简短并包含一定的上下文信息。例如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

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

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

小结

error 尽可能提供简明的上下文信息链，方便定位问题panic 用于真正异常的情况

recover生效范围，在当前goroutine 的被defer的函数中生效

性能优化建议

简介

性能优化的前提是满足正确可靠、简洁清晰等质量因素性能优化是综合评估，有时候时间效率和空间效率可能对立

性能优化建议-Benchmark如何使用

性能表现需要实际数据衡量

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

func BenchmarkFib10(b *testing.B) {
    // run the Fib function b.N times
    b.ResetTimer()
    for n := 0; n < b.N; n++ {
        Fib(10)
    }
}

go test -bench=. -benchmem

性能优化建议-Slice

slice 预分配内存

尽可能在使用make()初始化切片时提供容量cap 信息

data := make( [ ]int，0 , size)

map预分配内存

使用strings.Builder拼接字符串

也可以预分配内存Grow()

使用空结构体节省内存

空结构体struct

实例不占据任何的内存空间可作为各种场景下的占位符使用。节省资源

空结构体本身具备很强的语义，即这里不需要任何值，仅作为占位符

性能优化建议-atomic包

atomic包性能强于锁

使用atomic包

锁的实现是通过操作系统来实现，属于系统调用

atomic操作是通过硬件实现，效率比锁高

sync.Mutex应该用来保护一段逻辑，不仅仅用于保护一个变量

对于非数值操作，可以使用atomic.Value，能承载一个 interface{}

小结

避免常见的性能陷阱可以保证大部分程序的性能

普通应用代码,不要一味地追求程序的性能

越高级的性能优化手段越容易出现问题

在满足正确可靠、简洁清晰的质量要求的前提下提高程序性能

案例实战

使用pprof进行性能调优