本篇文章内容：
如何编写更简洁清晰的代码
常用 Go 语言程序优化建议
一、高质量编程
简介
什么是高质量
—— 编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码
各种边界条件是否考虑完备
异常情况处理，稳定性保证
易读易维护
编程原则
简单性
消除“多余的复杂性”，以简单清晰的逻辑编写代码
难以理解的代码无法修复改进
可读性
代码是给人看的，而不是机器
编写可维护代码的第一步是确保代码可读
生产力
团队整体工作效率非常重要
编码规范
如何编写高质量的 Go 代码
代码格式
注解
命名规范
控制流程
错误和异常处理
编码规范-代码格式
推荐使用 gofmt 自动格式化代码，gofmt是 Go 语言官方提供的工具，能自动格式化 Go 语言代码为官方统一风格。
编码规范-注释
公共符号始终要注释
包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释
任何既不明显也不简短的公共功能必须予以注释
无论长度或复杂程度如何，对库中的任何函数都必须进行注释
注释应该解释代码作用
适合注释公共符号
// Open opens the named file for reading. If successful, methods on // the returned file can be used for reading; the associated file // descriptor has mode O RDONLY. // If there is an error,it will be of type *PathError. func Open(name string) (*File, error) { return OpenFile(name,O_RDONLY,0) }
注释应该解释代码如何做的
适合注释实现过程
//Add the Referer header from the most recent //request URL to the new one,if it's not https->http: if ref := refererForURL(reqs[len(reqs)-1].URL, req.URL); ref != "" { req.Header .Set("Referer"，ref) }
编码规范-命名规范
variable
简介胜于冗长
缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
例如使用 ServeHTTP 而不是 ServeHttp
使用 XMLHTTPRequest 或者 xmlHTTPRequest
变量距离其被使用的地方越远，则需要携带越多的上下文信息
全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
// Good func (c *Client) send(red *Request, deabline 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
命名的核心在于降低阅读理解代码的成本
编码规范-控制流程
线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
正常流程代码沿着屏幕向下移动
提高代码可以维护性和可读性
避免嵌套，保持正常流程清晰
// Bad if foo { return x } else { return nil } // Good if foo { return x } return nil
尽量保持正常代码路径为最小缩进
// Good func OneFunc() error { if err := doSomething(); err != nil { return err } if err := doAnotherThing(); err != nil { return err } return nil // normal case }
编码规范-错误和异常处理
error 尽可能提供简明的上下文信息链，方便定位问题
panic 用于真正异常的情况
recover 生效范围，在当前 goroutine 的被 defer 的函数中生效
错误的 Wrap 和 Unwrap
错误的 Wrap 实际上时提供了一个 error 嵌套另一个 error 的能力，从而生成一个 error 的跟踪链
在 fmt.Errorf 中使用: %w 关键字来将一个错误关联至错误链中
list, -, err := c.GetBytes(cache.Subkey(a.actionID,"srcfiles")) if err != nil { return fmt.Errorf("reading srcfiles list: %w", err) }
错误判定
判定一个错误是否为特定错误，使用 error.ls
不同于使用 == ，使用该方法可以判定错误链上的所有错误是否含有特定的错误
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 []bytef{}, nil } return data, err
panic
不建议在业务代码中使用 panic
调用函数不包含 recover 会造成程序崩溃
若问题可以被屏蔽或解决，建议使用 error 代替 panic
当程序启动阶段发生不可逆转的错误时，可以在 init 或 main 函数中使用 panic
recover
recover 只能在被 defer 的函数中使用
嵌套无法生效
只在当前 goroutine 生效
defer 的语句是后进先出
二、性能调优建议
简介
性能优化的前提是满足正确可靠、简介清晰等质量因素
性能优化是综合评估，有时候时间效率可能对立
针对 Go 语言特性，介绍 Go 相关的性能优化建议
性能优化建议-Benchmark
如何使用
性能表现需要实际数据衡量
Go 语言提供了支持基准性能测试的 benchmark 工具
以计算麦波拉契数列的函数为例，分两个文件，fib.go 编写函数代码,fib test.go编写==benchmark==的逻辑，通过命令运行==benchmark==可以得到测试结果，-benchmem表示也统计内存信息。
性能优化建议-Slice
Slice 预分配内存
尽可能在使用 make() 初始化切片时提供容量信息
func PreAlloc(size int) { data := make([]int, 0, size) for k := 0; k < size;k++ { data = append(data, k) } }
切片本质是一个数组片段的描述
包括数组指针
片段的长度
片段的容量（不改变内存分配情况下的最大长度）
切片操作并不复制切片指向的元素
创建一个新的切片会复用原来切片的底层数组
type slice struct { array unsafe.Pointer len int cap int }
另一个陷阱：大内存未释放
在已有切片基础上创建切片，不会创建新的底层数字
场景
原切片较大，代码在原切片基础上新建小切片
原底层数组在内存中有引用，得不到释放
可使用 copy 替代 re-slice
性能优化建议-Map
map 预分配内存
func Prealloc(size int) { data := make(map[int]int, size) for i := 0; i < size; i++ { data[i] = 1 } }
分析
不断向 map 中添加元素得操作会触发 map 的扩容
提前分配阿红空间可以减少内存拷贝和 Rehash 的消耗
建议根据实际需求提前预估好需要的空间
性能优化建议-字符串处理
使用strings.Builder
使用 + 拼接性能最差，strings.Builder, bytes.Buffer 相近， strings.Buffer 更快
func StrBuilder(n int, str string) string { var builder strings.Builder for i := 0; i < n; i++ { builder.WriteString(str) } return builder.String( ) }
分析
字符串在 Go 语言中是不可变类型，占用内存大小是固定的
使用 + 每次都会重新分配内存
strings.Builder, bytes.Buffer 底层都是 [] byte 数组
内存扩容策略，不需要每次拼接重新分配内存
性能优化建议-空结构体
使用空结构体节省内存
空结构体 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 } }
一个开源实现：github.com/deckarep/go…
性能优化建议- atomic 包
如何使用 atomic 包
type atomicCounter struct { i int32 } func AtomicAddOne(c *atomicCounter) { atomic.AddInt32(&c.i, l) } type mutexCounter struct { i int32 m sync.Mutex } func MtexAddOne(c *mutexCounter) { c.m.Lock( ) c.i++ c.m.Unlock( ) }
锁的实现是通过操作系统来实现，属于系统调用
atomic 操作是通过硬件实现，效率比锁高
sync.Mutex 应该用来保护一段逻辑，不仅仅用于保护一个变量
对于非数值操作，可以使用 atomic.Value，能承载一个 interface{}
小结：
避免常见的性能陷阱可以保证大部分程序的性能
普通应用代码，不要一味地追求程序地性能
越高级地性能优化手段越容易出现问题
在满足正常可靠、简洁清晰地质量要求的前提下提高程序性能
