高质量编程

简介

什么是高质量代码？

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

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

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

  • 易读易维护

编程原则

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

以下引用Go语言开发者Dave Cheney的观点

简单性

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

  • 不理解的代码将导致无法进行修复改进

可读性

  • 代码是给人看而不是给机器看

  • 编写可维护的代码首先要确保代码的可读性

生产力

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

编码规范

代码格式

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

  • goimports能够自动增删依赖的包引用，将依赖包按字母序排序分类

可直接在IDE中设置，以下为GoLand中的配置，可在保存时自动格式化代码

注释

注释应该解释代码作用

如对于公共符号（公开的常量名，变量名，函数名等）

注释应该解释代码是怎样工作的

对于实现过程的注释，

注释应该解释代码实现的原因

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

注释应该解释代码什么情况下会出错

适合注释代码的限制条件，

公共符号始终要注释

包中声明的每个公共符号：变量、常量、函数以及结构体都需要添加注释

Google Style 指南中有两条规则

  • 任何既不明显也不简短的公共功能必须予以注释

  • 无论长度或复杂程度如何，对库中的任何函数都必须进行注释

对于公共符号都要注释说明，如下图的尽管LimitedReader.Read本身没有注释，但它紧跟LimitedReader的结构体的声明，明确了它的作用

命名规范

变量

  • 简洁胜于冗长

  • 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写

    • 例如使用ServeHTTP而不是ServeHttp

    • 使用XMLHTTPRequest或者xmlHTTPRequest

  • 变量距离其被使用的地方越远，越需要携带越多的上下文信息

    • 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易便认出其含义

上述代码中i和index的作用域范围仅限于for循环内部时，index的额外冗长几乎没有增加对于程序的理解

上述代码中，将deadline替换成t降低了变量名的信息量，t常指代任意时间，deadline指截止时间，有特定的含义。

函数提供给外部调用时，签名的信息很重要，要将自己的功能准确表现出来，自动提示一般也会提示函数的方法签名，通过参数名能更好的理解功能很有必要，可以节省时间。

函数

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

  • 函数名要尽量简短

  • 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义

  • 当名为foo的包某个函数返回类型T时，可以在函数名中加入类型信息

对于上述问题，在调用http包的Serve方法时，通常使用代码http.Serve，已经携带有包名信息，无需再次添加冗余信息。

包名

  • 只由小写字母组成，不包含大写字母和下划线等字符

  • 简短并包含一定的上下文信息，例如schema、task等等

  • 不要与标准库同名。例如不要使用sync或者strings

以下规则尽量满足，以标准库包名为例

  • 不适用常用变量名作为包名。例如使用bufio而不是buf

  • 使用单数而不是复数。例如使用encoding而不是encodings

  • 谨慎使用缩写。例如fmt在不破坏上下文情况下比format更好

控制流程

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

如果两个分支中都包含return语句，则可以去除冗余的else

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

错误和异常处理

性能优化建议

性能调优实战

简介

性能分析工具

性能调优案例