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

一、高质量编程

编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码。
条件：

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

编程原则：

• 简单性：消除多余的复杂性，以清晰简单的逻辑编写代码；不理解的代码无法修复改进。
• 可读性：代码是写给人看的，而不是机器；编写可维护代码的第一步是确保代码可读。
• 生产力：团队整体工作效率非常重要。

1、编码规范

1.1、代码格式

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

• gofmt：Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格。
• goimports：Go语言官方提供的工具，实际等于gofmt加上依赖包管理，自动增删依赖的包引用，将依赖包按字母序排序并分类。

1.2、注释

一个好的代码注释应该做的。

• 解释代码作用，注释公共符号。
• 解释代码如何做的，注释实现过程。
• 解释代码实现的原因，注释适合解释代码的外部因素。
• 解释代码什么情况会出错，注释解释代码的限制条件。

公共符号始终要注释：

• 包中声明的每个公共的符号：变量、常量、函数以及结构都需要注释。
• 任何既不明显也不简短的公共功能必须注释。
• 无论长度或复杂程度如何，对库中的任何函数都必须注释。
• 一个例外：不需要注释实现接口的方法。

1.3、命名规范

变量

• 简洁胜于冗长。
• 缩略词全大写，当其位于变量开头且不需要导出时，使用全小写。如ServeHTTP而不是ServeHttp；XMLHTTPRequest或xmlHTTPRequest。
• 变量距离其被使用的地方越远，则需要携带越多的上下文信息，尤其是全局变量。

函数

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

包

• 只由小写字母组成，不包含大写字母和下划线等字符。
• 简短并包含一定的上下文信息，如schema、task等。
• 不要和标准库同名，如不要使用sync或者strings。
• 不使用常用变量名作为包名，如使用 bufio 而不是 buf。
• 使用单数而不是复数，如使用 encoding 而不是 encodings。
• 谨慎的使用缩写，如使用 fmt 在不破坏上下文的情况下比 fotmat 更简短。

1.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 // normal case
        }
        return err
    }
    return err
}

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

1.5、错误和异常处理

简单错误

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

错误的Wrap和Unwrap

• 错误的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中记录当前的调用栈来获得更多的上下文信息。

二、性能调优

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

原则：

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

建议：

• 使用 Benchmark 进行基准性能测试。
• slice预分配内存，尽可能在使用make()初始化切片时提供容量信息。
• 创建一个新的切片会复用原来切片的底层数组，可用copy代替re-slice。
• map预分配内存，不断向map中添加元素的操作会触发map扩容，提前分配豪空间可以减少内存拷贝和Rehash的消耗。
• 多个字符串拼接时，使用strings.Builder比直接使用+或使用bytes.Buffer更快。
• 空结构体struct{}实例不占据任何的内存空间，可作为各种场景下的占位符使用。
• 锁的实现是通过OS来实现，属于系统调用，atomic操作时通过硬件实现，效率比锁高。