1 高质量编程

1.1 什么是高质量？

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

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

1.2 编程原则

实际应用场景千变万化，各种语言的特性和语法各不相同，但是高质量编程遵循的原则是相通的。编写高质量代码实际上可以遵循一个统一的原则：保证代码的简单性、可读性，提高团队生产力。

简单性

• 消除“多余的复杂性”，用最简单清晰的逻辑编写代码。
• 不理解的代码无法修复改进。

可读性  

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

生产力

• 编程更多的是团队合作，因此团队整体的工作效率非常重要。

1.3 编码规范

如何编写高质量的 Go 代码？

代码格式

推荐使用 Gofmt 自动格式化代码。

• Gofmt：Go 语言官方提供的工具，能自动格式化 Go 语言代码为官方统一风格，常见 IDE 都支持方便的配置。
• Goimports：也是 Go 语言官方提供的工具，实际等于 Gofmt 加上依赖包管理，自动增删依赖的包引用、将依赖包按字母序排序并分类。

注释应该做的

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

小结： 代码是最好的注释；注释应该提供代码未表达出的上下文信息。

命名规范

• 变量的命名：简洁胜于冗长。缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写。变量距离其被使用的地方越远，需要携带的信息就需要越多。
• 函数的命名：函数名不必携带包名的上下文信息。函数名需要尽可能地简短。当函数返回类型与包名相同时，可以省略类型信息。
• 包的命名：包名仅由小写字母组成。包名简短且包含一定的上下文信息。不要与标准库同名。

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

1.4 控制流程

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

1.5 错误和异常处理

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

1.6 性能优化建议

• 避免常见的性能陷阱可以保证大部分程序的性能。
• 普通应用代码，不要一味地追求程序的性能。
• 越高级的性能优化手段越容易出现问题。
• 在满足正确可靠、简洁清晰的质量要求的前提下提高程序性能。

二、性能调优实战

2.1 性能调优原则

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

2.2 性能分析工具 pprof

熟练使用 pprof 工具排查性能问题并了解其基本原理。

基础库优化

适应范围更广，覆盖更多服务

AB 实验 SDK 的优化：

• 分析基础库核心逻辑和性能瓶颈
  • 完善改造方案
  • 数据按需获取、
  • 数据序列化协议优化
• 内部压测验证
• 推广业务服务落地验证

优化方式

• 优化内存分配策略
• 优化代码编译流程，生成更高效的程序
• 内部压测验证
• 推广业务服务落地验证

总结

• 性能评估要依靠数据，用实际的结果做决策
• 对于pprof工具，可以通过分析实际的程序，熟悉相关功能，理解好基本原理，后续能够更好的解决性能问题
• 在真正的服务性能调优流程中，链路会很长，重点是要保证正确性，不影响功能，同时定位好问题