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

XL来
106 阅读4分钟

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

这是我参与「第五届青训营 」伴学笔记创作活动的第 5 天

  • 如何编写更简洁清晰的代码
  • 常用Go语言程序优化手段
  • 熟悉Go程序性能分析工具
  • 了解工程中性能优化的原则和流程

1. 高质量编程

1.1 高质量

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

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

简单性

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

可读性

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

生产力

  • 团队整体工作效率非常重要

1.2 编码规范

1.2.1 编码规范-代码格式

推荐使用fofmt自动格式化代码

gofmt

Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格

goimports

也是Go语言官方提供的工具，实际等于gofmt加上依赖包管理

自动增删依赖的包引用、将依赖包按字母序排序并分类

1.2.2 编码规范-注释

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

注释应该做的:

  • 解释代码作用 适合注释公共符号
  • 解释代码如何做的 适合注释实现过程
  • 解释代码实现的原因 解释代码外部因素，提供额外上下文
  • 解释代码什么情况会出错 解释代码的限制条件

代码是最好的注释，注释应该提供代码未表达出的上下文信息

1.2.3 编码规范-命名规范

变量命名

  • 简洁胜于冗长

  • 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写

    • 例如使用ServeHTTP而不是ServeHttp
    • 使用XMLHTTPRequest或者xmlHTTPRequest

  • 变量距离其被使用的地方越远，则需要携带越多的上下文信息

    • 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
//i和index的作用域范围仅限于for循环内部时，index的额外冗长几乎没有增加对于程序的理解，所以没必要
//Bad
for index:=0;index<len(s);index++{
}
//Good
for i:=0;i<len(s);i++{
}

//将deadline替换成t降低了变量名的信息量，t常代指任意时间，deadline指截止时间，有特定含义
//Good
func (c *Client) send(req *Request,deadline time.Time)
//Bad
func (c *Client) send(req *Request,t time.Time)

函数命名

  • 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
  • 函数名尽量简短
  • 当函数返回类型和包名一致的时候可以省略信息，反之则可加入类型信息

包名

  • 只有小写字母组成，不包含大写字母和下划线邓子富
  • 简短并包含一定的上下文信息
  • 不要与标准库同名
  • 单数而不是复数
  • 谨慎使用缩写

核心目标是降低阅读理解的代码成本，重点考虑上下文信息，设计简洁清晰的名称

1.2.4 编码规范-控制流程

  • 线性原理，避免嵌套，保持正常流程清晰

  • 尽量保持正常代码路径为最小缩进

    • 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
  • 提升代码可维护性和可读性

故障问题大多出现在复杂的条件语句和循环语句中

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

简单错误

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

错误的Wrap和Unwrap

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

Go1.13新增，如果Go版本小于1.13导入golang.org/x/xerrors来使用

错误判定

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

panic

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

recover

  • recover只能在被defer的函数中使用，defer的语句是后进先出
  • 只在当前goroutine生效
  • 嵌套无法生效
  • 如果需要更多的上下文信息，可以recover后在log中记录当前的调用栈
avatar
文章
阅读
粉丝