1. 高质量编程

1.1 简介

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

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

编程原则

实际应用场景千变万化，各种语言的特性和语法各不相同但是高质量编程遵循的原则是相通的

简单性

• 消除“多余的复杂性”，以简单清晰的逻辑编写代码

• 不理解的代码无法修复改进

可读性

• 代码是写给人看的，而不是机器
• 编写可维护代码的第一步是确保代码可读生产力
• 团队整体工作效率非常重要

1.2 编码规范

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

1.2.1 编码规范-注释

公共符号始终要注释

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

1.2.2 编码规范-命名规范

variable

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

function

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

package

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

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

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

1.2.3 编码规范-控制流程

避免嵌套，保持正常流程清晰

• 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
• 正常流程代码沿着屏幕向下移动
• 提升代码可维护性和可读性
• 故障问题大多出现在复杂的条件语句和循环语句中

1.2.4 编码规范-错误和异常处理

简单错误

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

错误的Wrap和Unwrap

• 错误的Wrap实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链
• 在fmt.Errorf 中使用: %w关键字来将一个错误关联至错误链中
• Go1.13在errors中新增了三个新API和一个新的format关键字，分别是errors.ls errors.As,errors.Unwrap以及fmt.Errorf的%w。如果项目运行在小于Go1.13的版本中，导入golang.org/x/xerrors来使用

panic

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

recover

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