Golang高质量编程与性能调优实战

1.1 简介

高质量：编写的代码能否达到正确可靠、简洁清晰的目标

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

编程原则

• 简单性
  • 消除多余的重复性，以简单清晰的逻辑编写代码
  • 不理解的代码无法修复改进
• 可读性
  • 代码是写给人看的，并不是机器
  • 编写可维护代码的第一步是确保代码可读
• 生产力
  • 团队整体工作效率非常重要

1.2 编码规范

如何编写高质量的Go代码

1.2.1 代码格式

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

主要有两种：

• gofmt
• goimports实际上等于gofmt加上依赖包管理，自动增删依赖包的引用、将依赖包按字母序排序并分类

1.2.2 注释

注释的作用

• 解释代码作用：适合注释公共符号

• 解释代码如何做的：适合注释实现过程

• 解释代码实现的原因：适合解释代码的外部因素，提供额外的上下文

• 解释代码什么情况会出错：适合解释代码的限制条件

• 公共符合始终要注释：

  • 包中声明的每个公共的符号、常量、变量、函数以及结构都需要添加注释
  • 任何公共功能都必须予以注释
  • 库中的任何函数都要进行注释
  • 不需要注释实现接口的方法

1.2.3 命名规范

变量：

• 简洁胜于冗长
• 缩略词全大写，但是其位于变量开头且不需要导出时，使用全小写
  • 使用ServerHTTP而不是ServerHttp
  • 使用XMLHTTPRequest 或者xmlHTTPRequest
• 变量距离被使用的地方越远，需要携带越多的上下文信息

函数：

• 函数名不携带包名的上下文信息
• 尽量简短
• 名为foo的包某个函数返回类型Foo时，可以省略类型信息
• 名为foo的包返回类型T时，可以加入类型信息

package

• 只由小写字母组成。不包含大写字母和下划线等字符
• 简短并包含一定的上下文信息。例如schema、task等
• 不要与标准库同名。例如不要使用sync 或者strings
• 以下规则尽量满足，以标准库包名为例
  • 不使用常用变量名作为包名。例如使用bufio 而不是 buf
  • 使用单数而不是复数。例如使用encoding 而不是encodings
  • 谨慎地使用缩写。例如使用fmt在不破坏上下文的情况下比 format更加简短

小结

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

• 重点考虑上下文信息，设计简洁清晰的名称

1.2.4 控制流程

• 避免嵌套，保证正常流程清晰。比如如果两个分支都有return，那么第二个的else的应当省略

• 尽量保持正常代码路径为最小缩进：优先处理错误或特殊情况，尽早返回或继续循环来减少嵌套

总结

• 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支

• 正常流程代码沿着屏幕向下移动

• 提高代码的维护性和可读性

• 故障问题大多出现在复杂的条件/循环语句里

1.2.5 错误和异常处理

简单错误

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

错误的Wrap和Unwrap

实际上是提供了error嵌套另一个error的