1. 高质量编程

1.1 简介

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

编程原则

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

1.2 编码规范

1.2.1 代码格式

使用gofmt自动格式化Go语言代码为官方统一格式
goimports = gofmt + 依赖包管理（自动增删依赖包引用、将其按字母顺序排序归类）

1.2.2 注释

注释作用

解释代码作用
- 注释公共符号，如公开的函数，变量，结构体等
- 不要对显而易见的内容进行注释，如IsEmpty()
解释代码实现过程
- 尽量贴切以及具体
解释代码实现的原因
- 解释代码的外部因素
- 提供额外上下文，解释代码为什么需要这样做
解释代码出错的情况
- 解释代码的限制条件，无法处理的情况等

注意点：

任何既不明显也不简短的公共功能必须予以注释
无论长度或复杂程度如何对库中的任何函数都必须进行注释
不要注释说去看其他地方的文档

1.2.3命名规范

变量

简洁胜于冗长，与变量的含义越贴切越好
- 如简单循环体内的使用i而不是index
缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 例如使用 ServeHTTP 而不是 ServeHttp
- 使用 XMLHTTPRequest 或者 xmlHTTPRequest
变量距离其被使用的地方越远，则需要携带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义

函数

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

包

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

1.2.4 控制流程

避免嵌套，去除冗余的else

// Bad 
if foo {
   return x
}else{
    return nil
}

// Good
if foo{
    return x
}
return nil

尽量保持正常代码路径为最小缩进
- 优先处理错误和特殊情况，尽早返回或跳过循环，来减少else嵌套

// Bad
err := doSomething()
if err == nil {
    err = doAnotherThing()
    if err == nil {
        return nil
    }
    return err
}
return err

// Good
err := doSomething()
if err != nil{
    return err
}

err = doAnotherThing()
if err != nil{
    return err
}

return nil

1.2.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

只能在被 defer 的函数中使用recover
嵌套无法生效
只在当前goroutine生效
defer 的语句是后进先出
如果需要更多的上下文信息，可以 recover 后在debug.Stack()中记录当前的调用栈

func (s *ss) Token( skipSpace bool， f func(rune) bool)
(tok []byte, err error) {
    defer func() {
        if e := recover(); e != nil {
            if se, ok := e.(scanError); ok {
                err = se.err
            } else {
                panic(e)
            }
        }
    }()
}

Go语言入门-高质量编程 | 青训营笔记

1. 高质量编程

1.1 简介

1.2 编码规范

1.2.1 代码格式

1.2.2 注释

1.2.3命名规范

1.2.4 控制流程

1.2.5 错误和异常处理