这是我参与「第三届青训营 -后端场」笔记创作活动的第3篇笔记

什么是高质量

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

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

简单性

• 消除多余的复杂代码，用简单清晰的逻辑编写代码
• 不理解的代码无法被后续修复改进

可读性

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

编写代码的规范

• 代码格式
• 注释
• 命名规范
• 控制流程
• 错误和异常处理

注释

• 应该解释代码的作用

• 应该解释代码是如何实现的

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

• 应该解释代码什么情况下会异常

命名规范

• 简洁胜于冗长
• 缩略词全大写，当位于变量开头且不需要导出时，使用全小写
• 变量距离其被使用的地方越远，则需要携带更多的上下文信息
• 全局变量在名字中需要更多的上下文信息，使其在不同地方可以轻易辨认出含义

控制流程

• 避免嵌套，保持正常流程清晰
• 尽量用return代替else分支
• 尽量保持正常代码路径为最小缩进
• 处理逻辑尽量走直线，避免复杂的嵌套分支
• 正常流程的代码沿着屏幕向下移动
• 提升代码可维护性和可读性
• 故障问题大多数都出现在复杂的条件语句和循环语句中

错误和异常处理

• 简单错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
• 简单错误优先使用errors.New创建匿名变量来直接表示
• 复杂错误一般使用Wrap和Unwrap
• 错误的Wrap实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链
• 不建议在业务代码中使用panic

性能调优原则

• 要依靠数据不要猜测
• 要定位最大瓶颈而不是细枝末节
• 不要过早优化
• 不要过度优化