这是我参与「第五届青训营 」伴学笔记创作活动的第 4天
学习内容主要为：高质量编程和性能调优实战。

高质量编程

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

简介

编程原则
简单性 以简单清晰的逻辑编写代码

可读性 编写可维护代码的第一步是确保代码可读

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

编码规范

编写高质量代码需要注意的编码规范：

代码格式

注释

命名规范

控制流程

错误和异常处理

注释

公共符号始终要注释
包中声明的每个公共的符号: 变量、常量、函数以及结构都需要添加注释
任何既不明显也不简短的公共功能必须予以注释
无论长度或复杂程度如何，对库中的任何函数都必须进行注释
注释的作用
注释应该解释代码作用
注释应该解释代码如何做的
注释应该解释代码实现的原因
注释应该解释代码什么情况会出错

代码格式

推荐使用 gofmt 自动格式化代码
gofmt ：Go语言官方提供的工具，能自动格式化 Go 语言代码为官方统一风格常见IDE都支持方便的配置
goimports：也是 Go 语言官方提供的工具实际等于 gofmt 加上依赖包管理 Goland 自动增删依赖的包引用、将依赖包按字母序排序并分类

命名规范

variable

简洁胜于冗长
缩略词全大写，但位于变量开头且不需导出时，使用全小写
变量距其被使用的地方越远，则需要携带的上下文信息越多

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

如果两个分支中都包含return语句，则可以去除冗余的else

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

优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套

// Bad 
func OneFunc() error {
    err := doSomething() 
    if err == nil {
        err := doAnotherThing()
        if err == nil {
            return nil // normal case

        }
        return err
    } 
    return err
}

最常见的正常流程的路径被嵌套在两个 if 条件内
成功的退出条件是 return nil，必须仔细匹配大括号来发现
函数最后一行返回一个错误，需要追溯到匹配的左括号，才 能了解何时会触发错误
如果后续正常流程需要增加一步操作，调用新的函数，则又 会增加一层嵌套

错误和异常处理

error 尽可能提供简明的上下文信息链，方便定位问题
panic 用于真正异常的情况
recover 生效范围，在当前 goroutine 的被 defer 的函数中生效