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

高质量编程简介

• 高质量：编写的代码能够达到正确可靠、简洁清晰、无性能隐患的目标就能称之为高质量代码
• 高质量代码的特点
  1. 简洁：逻辑简单，后续调整或新增功能能够快速支持
  2. 可读：其他人阅读理解代码时能够清楚明白，能够有效进行重构与修改
  3. 正确：各种边界条件考虑完备，能够处理错误的调用
  4. 稳定：具有完善的异常或错误的处理策略，针对出现的异常能够妥善处理
• 编程原则

  1. 简单性

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

     在实际工程项目中，复杂的程序逻辑会让人害怕重构和优化，因为无法明确预知调整造成的影响范围

     • 难以理解的逻辑，排查问题时也难以定位，不知道如何修复

  2. 可读性

     • 代码是写给人看的，而不是机器

     在项目不断迭代的过程中，大部分工作是对已有功能的完善或扩展，很少会完全下线某个功能，对应的功能代码实际会生存很长时间。已上线的代码在其生命周期内会被不同的人阅读几十上百次，难以理解的代码会占用后续每一个程序员的时间

  3. 生产力

     • 编程在当前更多是团队合作，因此团队整体的工作效率是非常重要的一方面

     为了降低新成员上手项目代码的成本，Go语言甚至通过工具强制统一所有代码格式。

     编码在整个项目开发链路中的一个节点，遵循规范，避免常见缺陷的代码能够降低后续联调、测试、验证、上线等各个节点的出现问题的概率，就算出现问题也能快速排查定位。

编码规范

• 使用gofmt自动格式化代码

• 使用goimports对依赖包进行管理

• VSCode中go语言插件的format设置

• 注释的作用

  • 注释应该解释代码作用
    • 适当注释公共符号，但避免对显而易见的内容进行说明
  • 注释应该解释代码如何做的
    • 对不明显的逻辑进行说明
  • 注释应该解释代码实现的原因
    • 解释代码的外部因素
    • 提供额外上下文
  • 注释应该解释代码什么情况会出错
    • 适当解释代码的限制条件

• 命名规范

  1. var
     • 简洁胜于冗长
     • 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
     • 变量距离其使用的地方越远，则需要携带越多的上下文信息
  2. function
     • 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
     • 函数名尽量简短
     • 当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义
     • 当名为 foo 的包某个函数返回类型 T 时（T 并不是 Foo），可以在函数名中加入类型信息
  3. package
     • 只由小写字母组成。不包含大写字母和下划线等字符
     • 简短并包含一定的上下文信息。例如 schema、task 等
     • 不要与标准库同名。例如不要使用 sync 或者 strings

控制流程

• 避免嵌套，保持正常流程清晰
• 如果两个分支中都包含 return 语句，则可以去除冗余的 else
• 尽量保持正常代码路径为最小缩进，优先处理错误情况/特殊情况，并尽早返回或继续循环来减少嵌套，增加可读性

错误和异常处理

• 简单错误处理：优先使用errors.New来创建匿名变量来直接表示该错误。有格式化需求时使用fmt.Errorf
• 错误的Wrap和Unwrap：在fmt.Errorf中使用%w关键字来将一个错误wrap至其错误链中
• 错误判定：
  1. 使用errors.Is可以判定错误链上的所有错误是否含有特定的错误。
  2. 在错误链上获取特定种类的错误，使用errors.As
• panic
  • 不建议在业务代码中使用panic
  • 如果当前goroutine 中所有deferred函数都不包含recover就会造成整个程序崩溃
  • 当程序启动阶段发生不可逆转的错误时，可以在init或main函数中使用panic
• recover
  • recover只能在被defer的函数中使用，嵌套无法生效，只在当前goroutine生效
  • 如果需要更多的上下文信息，可以recover后在log中记录当前的调用栈。