简介
编程原则
实际应用场景千变万化，各种语言的特性和语法各不相同但是高质量编程遵循的原则是相通的.
简单性
- 消除“多余的复杂性”，以简单清晰的逻辑编写代码
- 不理解的代码无法修复改进
可读性
- 代码是写给人看的，而不是机器
- 编写可维护代码的第一步是确保代码可读
生产力
- 团队整体工作效率非常重要
编码规范
注释
注释应该做的
- 注释应该解释代码作用
- 注释应该解释代码如何做的
- 注释应该解释代码实现的原因
- 注释应该解释代码什么情况会出错
公共符号始终要注释
- 包中声明的每个公共的符号:变量、常量、函数以及结构都需要添加注释
- 任何既不明显也不简短的公共功能必须予以注释
- 无论长度或复杂程度如何,对库中的任何函数都必须进行注释
- 例外: 不需要注释实现接口的方法
// Read implements the io.Reader interface
func (r *FileReader) Read(buf []byte) (int, error)
代码格式
- 用gofmt自动格式化代码
- goimports = gofmt + 依赖包管理 自动增删依赖的包引用、将依赖包按字母序排序并分类
命名规范
变量
- 简洁
- 缩略词大写, 但当其位于变量开头且不需要导出时,使用全小写
- 变量距离其被使用的地方越远, 约需要携带上下文信息
函数
- 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
- 函数名尽量简短
- 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
- 当名为foo的包某个函数返回类型T时(T并不是Foo)，可以在函数名中加入类型信息
包
- 只由小写字母组成。不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息。例如schema、task等
- 不要与标准库同名。例如不要使用sync或者strings
以下规则尽量满足，以标准库包名为例
- 不使用常用变量名作为包名。例如使用bufio而不是buf
- 使用单数而不是复数。例如使用encoding而不是encodings
- 谨慎地使用缩写。例如使用fmt在不破坏上下文的情况下比 format更加简短
控制流程
- 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
- 正常流程代码沿着屏幕向下移动
- 提升代码可维护性和可读性
- 故障问题大多出现在复杂的条件语句和循环语句中
错误和异常处理
简单错误
- 优先使用errors.New来创建匿名变量来直接表示简单错误
- 如果有格式化的需求，使用 fmt.Errorf
func defaultCheckRedirect(req *Request, via []*Request) error {
if len(via) >= 10 {
return errors. New( "stopped after 10 redirects" )
}
return nil
}
复杂错误
- 错误的Wrap 实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链
- 在fmt.Errorf 中使用:%w关键字来将一个错误关联至错误链中
list,_,err := c.GetBytes(cache.Subkey( a.actionID，"srcfiles"))
if err != nil {
return fmt.Errorf( "reading srcfiles list: %w" , err )
}
错误判定
- 判定一个错误是否为特定错误，使用errors.ls
不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误
- 在错误链上获取特定种类的错误,使用errors.As
panic
- 不建议在业务代码中使用panic
- 调用函数不包含recover会造成程序崩溃
- 若问题可以被屏蔽或解决，建议使用error代替 panic
- 当程序启动阶段发生不可逆转的错误时,可以在 init 或 main函数中使用panic
recover
- recover只能在被defer的函数中使用
- 嵌套无法生效
- 只在当前goroutine生效
- defer的语句是后进先出
- **如果需要更多的上下文信息,可以recover后在log中记录当前的调用栈
小结
- error尽可能提供简明的上下文信息链，方便定位问题
- panic用于真正异常的情况
- recover生效范围，在当前goroutine的被defer的函数中生效
