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

小徐天天开心
72 阅读5分钟

1 高质量编程简介

  • 什么是高质量——编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码
  • 各种边界条件是否考虑完备
  • 异常情况处理，稳定性保证
  • 易读易维护
  • 简单性、可读性、生产力

2 编码规范

如何编写高质量的 Go 代码

2.1 代码格式

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

2.2 注释

  • 公共符号始终要注释
    • 对于公共符号都有注释说明
    • 尽管 LimitedReader.Read 本身没有注释，但它紧跟 LimitedReader结构的声明，明确它的作用
  • 注释应该做的
    • 注释应该解释代码作用
      • 适合注释公共符号
    • 注释应该解释代码如何做的
      • 适合注释实现过程
    • 注释应该解释代码实现的原因
      • 适合解释代码的外部因素
      • 提供额外上下文
    • 注释应该解释代码什么情况会出错
      • 适合解释代码的限制条件

小结：

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

2.3 命名规范

variable

  • 简洁胜于冗长
  • 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
    • 例如使用 ServeHTTP 而不是 ServeHttp
    • 使用 XMLHTTPRequest 或者 xmIHTTPRequest
  • 变量距离其被使用的地方越远，则需要携带越多的上下文信息
    • 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
//Bad
for index := 0; index < len(s); index++ {
        //do something
}
//Good
for i := 0; i < len(s); i++ {
        //do something
}
  • i 和 index 的作用域范围仅限于 for 循环内部时
  • index 的额外冗长几乎没有增加对于程序的理解
//Good
func (c *Client) send( req *Request, deadline time.Time)
//Bad
func (c *Client) send( req *Request,t time.Time)
  • 将 deadline 替换成 t 降低了变量名的信息量
  • t 常代指任意时间
  • deadline 指截止时间，有特定的含义

function

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

package

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

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

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

小结：

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

2.4 控制流程

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

// Bad
if foo {
    return x
} else {
    return nil
}
// Good
if foo {
    return x
}
return nil
  • 如果两个分支中都包含return语句，则可以去除冗余的else

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

  • 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套

小结：

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

2.5 错误和异常处理

简单错误

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

错误的 Wrap 和 Unwrap

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

错误判定

  • 在错误链上获取特定种类的错误，使用errors.As

panic

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

recover

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

小结：

  1. error 尽可能提供简明的上下文信息链，方便定位问题
  2. panic 用于真正异常的情况
  3. recover 生效范围，在当前 goroutine 的被 defer 的函数中生效

3 性能优化建议

  • 避免常见的性能陷阱可以保证大部分程序的性能
  • 普通应用代码，不要一味地追求程序的性能
  • 越高级的性能优化手段越容易出现问题
  • 在满足正确可靠、简洁清晰的质量要求的前提下提高程序性能
avatar
文章
阅读
粉丝