学习目标

学习高质量编程的定义和原则，了解代码格式、注释、命名规范、控制流程、错误和异常处理五方面的常见编码规范。

什么是高质量？

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

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

编程原则

简单性

• 消除“多余的复杂性”，以简单清晰的逻辑编写代码
• 不理解的代码无法修复改进

可读性

• 代码是给人看的，而不是机器
• 编写可维护代码的第一步是确保代码可读

如何编写高质量的Go代码

注意以下几点：

• 代码格式
• 注释
• 命名规范
• 控制流程
• 错误和异常处理

代码格式

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

注释

注释的作用：

• 解释代码的作用
• 解释代码是如何做的
• 解释代码实现的原因
• 解释代码什么情况会出错

好的代码有很多注释，坏代码需要很多注释。

命名规范

变量（variable）

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

函数或方法（function）

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

包（package）

• 只由小写字母组成。不包含大写字母和下划线等字符
• 简短并包含一定的上下文信息。例如schema、task等
• 不要与标准库同名。例如不要使用sync或者strings
  

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

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

控制流程

• 避免嵌套，保持正常流程清晰
• 尽量保持正常代码路径为最小缩进
  • 优先处理错误情况、特殊情况，尽早返回或继续循环来减少嵌套

错误和异常处理

简单错误

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

错误的Wrap和Unwarp

• 错误的Wrap实际上是提供了一个error嵌套另一个 error的能力，从而生成一个error的跟踪链
• 在fmt.Errorf中使用：%w关键字来将一个错误关联至 错误链中

错误判定

error

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

panic

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

recover

• recover只能在被defer的函数中使用
• 嵌套无法生效
• 只在当前goroutine生效
• defer的语句是后进先出

如果需要更多的上下文信息，可以在recover后在log中记录当前的调用栈

总结

要能灵活运用上面提到的各种方法论，需要进行大量的编码实践。