Go 高质量编程和性能调优

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

1 高质量编程

1.1 简介

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

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

在介绍具体建议之前，首先可以看下什么是高质量，实际是个偏主观的标准，个人理解的高质量，要求不多，实际并不容易达到。

• 正确性：是否考虑各种边界条件，错误的调用是否能够处理

• 可靠性：异常情况或者错误的处理策略是否明确，依赖的服务出现异常是否能够处理

• 简洁：逻辑是否简单，后续调整功能或新增功能是否能够快速支持

• 清晰：其他人在阅读理解代码的时候是否能清楚明白，重构或者修改功能是否不会担心出现无法

编程原则：

• 简单性：消除多余的复杂性，以简单清晰的逻辑编写代码；不理解的代码无法修复改进
• 可读性：代码是写给人看的，而不是机器；编写可维护代码的第-步是确保代码可读
• 生产力：团队整体工作效率非常重要

1.2 编码规范

1.2.1 代码格式

首先是推荐使用 go fmt 自动格式化代码，保证所有的 Go 代码与官方推荐格式保持一致而且可以很方便的进行配置，像Goland内置了相关功能，直接开启即可在保存文件的时候自动格式化。

另外可以考虑 go imports，会对依赖包进行管理，自动增删依赖的包引用，按字母序排序分类，具体可以根据团队实际情况配置使用，之所以将格式化放在第一条， 因为这是后续规范的基础， 团队合作 review 其他人的代码时就能体会到这条规范的作用了。

1.2.2 注释

注释应该做的：

• 注释应该解释代码作用
• 注释应该解释代码如何做的
• 注释应该解释代码实现的原因
• 注释应该解释代码什么情况会出错

1.2.3 命名规范

• 简洁胜于冗长

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

  例如使用 ServeHTTP 而不是 SeveHttp

  使用 XMLHTTPRequest 或者 xmlHTTPRequest

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

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

1.2.4 控制流程

• 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支，保持正常流程清晰

• 正常流程代码沿着屏幕向下移动

• 提升代码可维护性和可读性

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

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

  最常见的正常流程的路径被嵌套在两个if 条件内

  成功的退出条件是returnnil，必须仔细匹配大括号来发现函数最后一行

  返回一个错误，需要追溯到匹配的左括号，才能了解何时会触发错误

  如果后续正常流程需要增加一步操作，调用新的函数，则又会增加一层嵌套

1.2.5 错误和异常处理

• 简单错误

  简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误

  优先使用 errors.New 来创建匿名变量来直接表示简单错误 如果有格式化的需求，使用 fmt.Errorf

• 错误的 Wrap 和 Unwrap

  错误的 Wrap 实际上是提供了一个 error 嵌套另一个error 的能力，从而生成一个error 的跟踪链

  在 fmt.Errorf 中使用：%w 关键字来将一个错误关联至错误链中

• 错误判定

  判定一个错误是否为特定错误，使用 errors.Is

  不同于使用 ==，使用该方法可以判定错误链上的所有错误是否含有特定的错误

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

• panic

  不建议在业务代码中使用panic

  调用函数不包含recover会造成程序崩溃若问题可以被屏蔽或解决，建议使用

  error代替panic

  当程序启动阶段发生不可逆转的错误时，可以在init或main函数中使用panic

• recover

  recover 只能在被 defer 的函数中使用

  嵌套无法生效

  只在当前 goroutine 生效

  defer 的语句是后进先出

  如果需要更多的上下文信息，可以 recover 后在log中记录当前的调用栈