这是我参与[第五届青训营]伴学笔记创作活动的第3天
一.本堂课重点内容
- 高质量编程简介
- 编码规范
二.详细知识点介绍
1.高质量编程简介
什么是高质量编程？编写的代码能够达到正确可靠，简洁清晰的目标可称之为高质量编程。 这句话看似简单，但达到要求却是一种挑战。除此之外，高质量编程还应具有以下特点
- 各种边界条件是否考虑完备
- 异常情况处理，稳定性保证
- 易读易维护
每种编程语言的应用场景千变万化，语言特点和语法也各不相同。但是，高质量编程遵循的原则却是相通的。
编写高质量代码需要有简单性。所谓简单性，就是消除多余复杂的代码，以简单清晰的逻辑编写代码。还需要有可读性，代码是写给人看的而不是机器看的，只要能完成功能，机器是不会管你的代码写法，而代码的维护却需要由人来看，可读性高的代码，让人维护起来也会感到神清气爽。
2.编码规范
如何编写高质量的Go代码？
代码格式
一个漂亮的代码格式就像人的容貌一般，给人的第一印象好与不好，便在此处。为了代码的脸，可以使用gofmt来自动格式化代码，他可以保证所有go代码与官方推荐格式保持一致。
注释
好的代码有很多注释，坏的代码需要很多注释。
注释应该解释代码的作用。比如注释公共符号，对外提供的函数注释描述它的功能和用途。 另外，注释还应该避免啰嗦，对显而易见的代码不需要注释。
注释应该解释代码如何做的，注释是对代码中复杂的，并不明显的逻辑进行说明，适合注释实现过程。对于显而易见的流程，注意不要用自然语言直接翻译代码作为注释，信息冗余还好，有时候表述不一定和代码一致。
注释应该解释代码实现的原因，注释可以解释代码的外部因素，这些因素脱离上下文很难理解，便可以用注释来提供额外上下文。
注释应该解释代码什么情况会出错，注释可以提醒使用者一些潜在的限制条件或者无法处理的情况，例如函数的注释中可以说明是否存在性能隐患，输入的限制条件，可能存在哪些错误情况，让使用者无需了解实现细节。
最后比较大的一方面是公共符号的注释，Google Style指南中有两条规则
1.任何既不明显也不简短的公共功能必须予以注释
2.无论长度或复杂程度如何，对库中的任何函数必须进行注释
但是有一个例外，不需要注释实现接口的方法。
小结
- 代码是最好的注释
- 注释应该提供代码未表达出的上下文信息
命名规范
- 变量命名
简洁胜于冗长，对于没有实际意义的变量，可以简略它的命名
但是对于一些有实际意义的变量，需要简单明了
缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 例如使用ServerHTTP,而不是ServerHttp
- 使用XMLHTTPRequest或者xmlHTTPRequest
变量距离其使用的地方越远，越要携带更多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
- 函数名命名
- 包的命名
小结
- 核心目标是降低阅读理解代码的成本
- 重点考虑上下文信息，设计简洁清晰的名称
控制流程
避免嵌套，保持流程清晰。例如，两个分支中都包含return语句，可以取出冗余的else
尽量保持正常代码为最小缩进，优先处理错误情况，特殊情况，尽早返回或继续循环来减少嵌套
小结
- 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
- 正常流程代码沿着屏幕向下移动
- 提升代码可维护性和可读性
- 故障问题大多出现在复杂的条件语句和循环语句中
错误和异常处理
- 简单错误
简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误。可优先使用errors.New来创建匿名变量来直接表示简单错误，如果有格式化的需求，使用fmt.Errorf
- 错误的Wrap和UnWrap
错误的Wrap实际上是提供了一个error嵌套跟另一个error的能力，从而生成一个error的跟踪链，在fmt.Errorf中使用：%w关键字来将一个错误关联至错误链中。
- 错误判定
判断一个错误是否为特定错误，用error.Is,不同于 == ，使用该方法可以判定错误链上的所有错误是否含有特定的错误
在错误链上获得特定种类的错误，使用
error.As,它跟is的区别是，as可以提出调用链中指定的错误并返回给定义好的变量，可以打印出便于后续处理
- panic
在业务中不建议使用panic,调用函数不包括recover会造成一个程序的崩溃，若问题可以被屏蔽或解决，建议使用error代替panic,当程序启动阶段发生不可逆转的错误时，可以在init或者main函数中使用panic
- recover
recover只能在被defer的函数中使用，而且只在当前的goroutine生效，recover使嵌套无法生效
如果需要更多的上下文信息，可以在recover后在log中记录当前的调用栈
小结
- error尽可能提供简明的上下文信息链，方便定位问题
- panic用于真正异常的情况
- recover生效范围，在当前的goroutine的被defer的函数中生效
3.个人总结与体会
此篇课程学习了如何高质量的编写代码和了解了一些编码时的规范，让自己写代码时可以更加的规范，写出真正的高质量代码，对以后的工作和团队合作都非常有帮助
4.引用
字节內部课 - 高质量编程简介及代码规范
