高质量编程

所谓高质量编程，起始就是编写的代码能够达到正确可靠、简洁清晰的条件

边界条件的考虑完备性
- 在编程中，常常会遇到越界的问题，以及存在判断条件少了或者是多了一个等于号造成边界条件出错。
异常情况的处理，使得程序稳定性得到保证
- 各种异常诸如文件打开失败，下标越界，除以0的问题都会产生异常。
易读易维护
- 可读性以及容易维护是编程中必备的能力，这样在团队合作中代码才能更好的被其他人所理解。

编程原则

- 简单性
 - 可读性
 - 生产力

如何编写高质量的Go代码？

代码格式
- 推荐使用gofmt自动格式化代码
注释
- 解释代码作用
  - 适合注释公共符号
- 解释代码如何做的
  - 适合注释实现过程
- 解释代码实现的原因
  - 适合解释代码的外部因素
  - 提供额外上下文
- 解释代码什么情况会出错
  - 适合解释代码的限制条件
代码是最好的注释

注释应该提供代码为表达出的上下文信息
命名规范
- variable：简洁胜于冗长
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
```
     例如：ServeHTTP而不是ServerHttp
     使用XMLHTTPRequest或者xmlHTTPRequest
```
- 变量距离其被使用地方越远，则需要携带越多的上下文信息。例如全局变量。
  - 在for循环中没有必要把下标设置成过长的，因为作用域只在for内，过长造成冗余
- 函数或方法（function）
  - 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
  - 函数名尽量简短
  - ```
   当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
```
  - 当名为foo的包某个函数返回类型T时(T并不是Foo)，可以在函数名中加入类型信息
- 包（package）
  - 只由小写字母组成。不包含大写字母和下划线等字符
  - 简短并包含一定的上下文信息。例如schema、task等 - 不要与标准库同名。例如不要使用sync或者strings
- 以下规则尽量满足，以标准库包名为例
不使用常用变量名作为包名。例如使用bufio而不是buf

使用单数而不是复数。例如使用encoding而不是encodings

谨慎地使用缩写。例如使用fmt在不破坏上下文的情况下比format更加简短
控制流程
- if-else 避免嵌套，保持正常流程清晰
```
// bad
if foo {
    return x
} else {
    return nil
}
// good
if foo {
    return x
}
return nill
```
- 优先处理错误或者特殊情况，尽早跳出循环来减少嵌套
  - 线性原则：代码尽量走直线（就是一直往下走）
  - 不要出现从第几百行代码跳出嵌套跳回第二行的这种情况。
  - 故障问题大多数都出现在复杂的嵌套语句中
错误和异常处理
- 简单错误：指的是只会出现一次且在代码其他地方不需要捕获的错误
  - 可以用errors.New来创建匿名变量来直接表示简单错误（其实就相当于其它语言中throw一个异常）
  - 如果有格式化的需求，使用fmt.Errorf
- 错误的Wrap和Unwrap
  - 错误的Wrap实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链
  - 在fmt.Errorf中使用%w关键字来将一个错误关联至错误链中
- 错误判定
  - 判定一个错误是否为特定错误，使用errors.Is
  - 不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误
  - 在错误链上获取特定种类的错误，使用errors.As，能将error取出来
- panic
  - 不建议在业务代码中使用panic，panic通俗一点来说就是程序宕机
  - 调用函数不包含recover会造成程序崩溃
  - 若问题可以被屏蔽或解决，建议使用error代替panic
  - 当程序启动阶段发生不可逆转的错误时，可以在init或main函数中使用panic
- recover
  - recover只能在被defer的函数中使用
  - 嵌套无法生效
  - 只在当前goroutine生效
  - defer的语句是后进先出(defer语句会在函数返回前调用，所以遵循后进先出原则)
  - 如果需要更多的上下文信息，可以recover后再log中记录当前的调用栈

高质量编程简介及编码规范 | 青训营

高质量编程

编程原则