后端与 Golang | 青训营笔记

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

高质量编程

1. 简介

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

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

• 编程原则

1. 简单性

• 除多余的复杂性，以简单清晰的逻辑编写代码
• 不理解的代码无法修复改进

2. 可读性

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

3. 生产力

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

2. 编码规范

• 如何编写高质量的go代码

1. 代码格式
2. 注释
3. 命名规范
4. 控制流程
5. 错误和异常处理

1. 代码格式

• gofmt
• goimports

2. 注释

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

3. 命名规范

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

4. 控制流程

• 避免嵌套，保持正常流程清晰
• 尽量保持正常代码路径为最小缩进
• 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支

5. 错误和异常处理

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