GO语言高质量编程｜青训营笔记这是我参与「第五届青训营」伴学笔记创作活动的第 3 天我将主要介绍如下知识点：Go 语言

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

1. 概述

我将主要介绍如下知识点:

Go 语言编码规范
Go 语言性能优化建议

2. 编码规范

2.1 高质量编程简介

首先可以看下什么是高质量——编写的代码能够达到正确可靠、简洁清晰的目标

实际是偏主观的标准，但实际上也并不容易达到：

正确性：考虑各种边界条件，正常处理错误的调用

可靠性：明确异常情况或者错误的处理策略，稳定性保证

简洁清晰性：易读易维护

2.2 代码格式

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

下图是 Goland 默认配置，快捷键是 Ctrl + Alt + L

2.3 注释

注释应该做的：

解释代码作用

解释代码如何做的

解释代码实现的原因

解释代码什么情况会出错

Go官方推荐使用行注释来注释整个方法和语句

// Printf formats according to a format specifier and writes to standard output.
// It returns the number of bytes written and any write error encountered.
func Printf(format string, a ...any) (n int, err error) {
	return Fprintf(os.Stdout, format, a...)
}

2.4 命名规范

变量命名：

缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 例如使用 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 循环内部，

故用 i 作为变量名比 index 好些(因为此处 index 的额外冗长几乎没有增加对于程序的理解)

函数命名：

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

来做道题：

http 包中创建服务的函数如何命名更好？

func Serve(I net. Listener， handler Handler) error

func ServeHTTP(I net.Listener， handler Handler) error

答：应选第一个，因为函数名不携带包名的上下文信息

包的命名：

只由小写字母组成，不包含大写字母和下划线等字符
简短并包含一定的上下文信息
不要和标准库同名

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

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

2.5 控制流程

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

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

// 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
}

2.6 错误和异常处理

简单错误：

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

错误的 Wrap 和 Unwarp：

对于复杂的错误，有时候并不能简单描述，错误的 Wrap(包装) 提供了一个error嵌套另一个error的能力，生成一个error的跟踪链，同时结合错误的判定方法来确认调用链中是否有关注的错误出现
在 fmt.Errorf 中使用 %w 关键字来将一个错误关联至其错误链中

错误判定：

判定一个错误是否为特定错误，使用 errors.Is
不同于直接使用 == ，使用该方法可以判断错误链上的所有错误是否含有特定的错误
在错误链上获取特定种类的错误，使用 errors.As

panic：

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

recover：

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

小结：

error 尽可能提供简明的上下文信息链，方便定位问题

panic 用于真正异常的情况

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

3. 性能优化建议

3.1 Slice 预分配内存

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

func PreAlloc(size int) {
    data := make([]int, 0, size)
    for k := 0; k < size; k++ {
        data = append(data, k)
    }
}

分析：

切片本质是一个数组片段的描述

包括数组指针

片段的长度

片段的容量(不改变内存分配情况下的最大长度)

切片操作并不复制切片指向的元素

创建一个新的切片会复用原来切片的底层数组

因此，为了避免内存发生拷贝，如果能够知道最终的切片的大小，预先设置 cap 的值能够避免额外的内存分配，获得更好的性能

type slice struct {
    array unsafe.Pointer
    len int
    cap int
}

注意：在已有切片基础上创建切片，不会创建新的底层数组，这可能会导致内存泄漏发生，此时可 copy 代替 re-slice

3.2 map 预分配内存

func PreAlloc(size int) {
    data := make(map[int]int, size)
    for i := 0; i < size; i++ {
        data[i] = 1
    }
}

分析：

不断向 map 中添加元素的操作会触发 map 的扩容

提前分配好空间可以减少内存拷贝和 Rehash 的消耗

建议根据实际需求提前预估好需要的空间

3.3 字符串 strings.Builder 拼接

建议使用 strings.Builder 拼接字符串
使用 + 拼接性能最差， strings.Builder，bytes.Buffer 相近，strings.Builder 更快

分析：

字符串在 Go 语言中是不可变类型，占用内存大小是固定的

使用 + 每次都会重新分配内存

string.Builder，bytes.Buffer 底层都是 []byte 数组

内存扩容策略，不需要每次拼接重新分配内存

3.4 空结构体

使用空结构体节省内存
空结构体 struct{} 实例不占据任何的内存空间
可作为各种场景下的占位符使用

4. 总结

高质量的代码能够完成功能，但是在大规模程序部署的场景，仅仅支持正常功能还不够，我们还要尽可能的提升性能，节省资源成本！

参考：

字节内部课：GO高质量编程与性能调优