三.高质量编程与性能调优实战

3.1.高质量编程

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

需要考虑:

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

编程原则:

1. 简单性

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

2. 可读性

   1. 代码是写给别人看的, 而不是机器
   2. 编写可维护代码的第一步是确保代码可读

3. 生产力

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

编码规范:

1. 代码格式

• 可以使用 gofmt 自动格式化代码

2. 注释

• 注释应该解释代码作用

• 注释应该解释代码如何做的

• 注释应该解释代码实现的原因

• 注释应该解释代码什么情况会出错

3. 命名规范

• 简洁胜于冗长

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

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

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

  • 变量在其名字中需要更多的上下文信息, 使得在不同地方可以轻易辨认出其含义

4. 控制流程

• 避免嵌套, 保持正常流程清晰
• 尽量保持正常代码路径为最小缩进

5. 错误和异常处理

• 简单错误

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

• 错误的 Wrap 和 Unwarp

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

• 错误判断

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