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

一、高质量编程简介以及编码

1. 课程目标

1）如何编写更简洁清晰的代码常用

2）Go 语言程序优化手段熟悉

3）Go 程序性能分析工具

4）了解工程中性能优化的原则和流程

2. 简介

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

✨ 各种边界条件是否考虑完备

✨ 异常情况处理，稳定性保证

✨ 易读易维护

（2）编程原则

✨ 实际应用场景千变万化，各种语言的特性和语法各不相同但是高质量编程遵循的原则是相通的

✨ 简单性

🌹 消除“多余的复杂性”，以简单清晰的逻辑编写代码

🌹 不理解的代码无法修复改进

✨ 可读性

🌹 代码是写给人看的，而不是机器

🌹 编写可维护代码的第一步是确保代码可读

✨ 生产力

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

（3）编码规范

✨ 代码格式

🌹 gofmt 自动格式化代码

🌹 goimports = gofmt+依赖包管理

✨ 注释

🌹 解释代码作用

🌹 解释代码是如何做的

🌹 代码实现的原因

😋 适当解释代码的外部因素
😋 提供额外的上下文

🌹 代码什么情况会出错

😋 适当解释代码的限制条件

🌹 小结

😋 代码就是最好的注释
😋 注释应该提供代码未表达出的上下文信息

✨ 命名规范

🌹 变量

😋 简洁胜于冗长

😋 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
 🤠 例如使用 ServeHTTP 而不是 ServeHttp
 🤠 使用 XMLHTTPRequest 或者 xmIHTTPRequest

😋 变量距离其被使用的地方越远，则需要携带越多的上下文信息
 🤠 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义

🌹 函数

😋 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的

😋 函数名尽量简短

😋 函数名不建议出现包名（冗余）
 🤠 当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义
 🤠 当名为 foo 的包某个函数返回类型 T 时 (T 并不是 Foo)，可以在函数名中加入类型信息

🌹 包

😋 只由小写字母组成。不包含大写字母和下划线等字符
😋 简短并包含一定的上下文信息。例如 schema、task 等
😋 不要与标准库同名。例如不要使用 sync 或者 strings

🌹 小结

😋 核心目标是降低阅读理解代码的成本
😋 重点考虑上下文信息，设计简洁清晰的名称

✨ 控制流程

🌹 避免嵌套，保持正常流程清晰

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

😋 即优先处理错误情况/特殊情况，尽早返回或继续循环还减少嵌套
😋 进来就判断合不合法就对了

🌹 小结

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

✨ 错误和异常处理

🌹 简单错误

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

🌹 错误的 Wrap 和 Unwrap

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

🌹 错误的判断

😋 判定一个错误是否为特定错误，使用 errors.ls
😋 不同于使用 ==，使用该方法可以判定错误链上的所有错误是否含有特定的错误

🌹 panic

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

🌹 recover

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

🌹 小结

😋 error 尽可能提供简明的上下文信息链，方便定位问题
😋 panic 用于真正异常的情况
😋 recover 生效范围，在当前 goroutine 的被 defer 的函数中生效