简介

编程原则

简单性

• 消除“多余的复杂性”，以简单清晰的逻辑编写代码
• 不理解的代码无法修复改进（难以维护代码，难以排查问题，其他人不太敢动这些代码）

可读性

• 代码是写给人看的
• 编写可维护代码的第一步是确保代码可读（占用别人阅读代码的时间，降低工作效率）

生产力

• 团队整体工作效率非常重要（统一编码规范，方便查找问题，修改代码）

编码规范

注释

注释的作用：

• 解释代码作用
• 解释代码如何做的
• 解释代码实现的原因（解释代码的外部因素，提供额外上下文）
• 解释代码什么情况会出错（解释代码的限制条件）

公共符号需要注释

• 变量，常量，函数以及结构都需要添加注释
• 不明显，不简短的公共功能都需要注释
• 对库中的任何函数都要注释（避免别人错误的使用函数，提高工作效率）
• 不需要注释实现接口的方法（特别是注释去其他地方参考这种类似的，不够直观）

代码格式

推荐使用gofmt自动格式化代码

gofmt: Go语言官方提供的工具，能自动格式化Go代码为官方统一风格

笔者使用的为IDEA编译器 或者使用快捷键Ctrl+Alt+Shift+F实现代码的格式化

- 代码是最好的注释

- 注释应该提供代码未表达出的上下文信息

命名规范

变量命名

• 简洁胜于冗长
• 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
• 变量距离其被使用的地方越远，则需要携带越多的上下文信息（全局变量的名字需要包含更多的上下文信息）

函数命名

• 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现
• 函数名尽量简短
• 当包名和函数返回类型一致时，可以省略类型信息
• 如果包名和函数返回类型不一致时，则可以加入类型信息

包名（package)命名

• 只由小写字母组成，不包含大写字母和下划线等字符
• 简短并包含一定的上下文信息
• 不要与标准库同名（如sync,strings等）

尽量满足：

• 不使用常用变量名作为包名
• 使用单数而不是复数
• 谨慎地使用缩写
• 遵循团队内部的命名规范

- 核心目标是降低阅读理解代码的成本

- 重点考虑上下文信息，设计简洁清晰的代码

控制流程

避免嵌套

明显上面的代码更加复杂，本来完全不需要使用else

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

• 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套

遇到特殊情况的时候，使用特定的if语句，减少代码阅读的难度，正常情况就按照正常的逻辑去处理

• 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
• 正常流程代码沿着屏幕向下移动
• 提升代码可维护性和可读性
• 故障问题大多出现在复杂的条件语句和循环语句中

错误和异常处理

简单错误

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

错误的Wrap和Unwrap

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

错误判定

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

panic

• 不建议在业务代码中使用panic
• 调用函数不包含recover会造成程序崩溃
• 若问题可以被屏蔽或解决，建议使用error代替panic
• 当程序启动阶段发生不可逆转的错误时，可以在init或main函数中使用panic

recover

• recover只能在被defer的函数中使用
• 嵌套无法生效
• 只在当前goroutine中生效
• defer的语句是先进后出
• 如需更多上下文信息，可以recover后在log中记录当前的调用栈

- error尽可能提供简明的上下文信息链，方便定位问题

- panic用于真正异常的情况

- recover生效范围：在当前goroutine的被defer的函数中生效

小结

本篇文章为知识点笔记，来自课程高质量编程简介及编码规范 - 掘金 (juejin.cn)，学到了很多命名的规范和程序流程的规范还有注释等内容，这样写代码可以更好的提高合作的效率，也便于自己以后查看代码，错误处理这一块知识点就不是很理解了，可能是还没有怎么使用过，以后会用的上