0005.高质量编程简介及编码规范 ｜ 青训营笔记

[TOC]

一、这节课你将获得什么

• Go语言基础

• 如何用 Go编写程序

如何编写更简洁洁晰的代码 常用Go语言程序优化手段 熟悉Go程序性能分析工具 了解工程中性能优化的原则和流程

二、高质量编程

1.高质量编程简介

(1)什么是高质量

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

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

(2)编程原则

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

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

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

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

2.编码规范

(1) 如何编写高质量的 Go代码

• 代码格式
• 注释
• 命名规范
• 控制流程
• 错误和异常处理

(2)注释

①注释应该做的:

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

②==公共符号始终要注释==

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

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

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

==有一个例外，不需要注释实现接口的方法==

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

(3)代码格式

推荐使用gofmt自动格式化代码 gofmt Go语言官方提供的工具，能自动格式化 Go语言代码为官方统一风格 常见IDE都支持方便的配置

goimports 也是 Go语言官方提供的工具 实际等于gofmt加上依赖包管理goimports 自动增删依赖的包引用、将依赖包按字母序排序并分类

(4)命名规范

①variable

• 简洁胜于冗长

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

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

②function

• 函数名不携带包名的上下交信息，因为包名和函数名总是成对出现的
• 函数名尽量简短
• 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
• 当名为 foo的包某个函数返回类型T时 (T并不是Foo)，可以在函数名中加入类型信息

③package

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

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

• 不使用常用变量名作为包名。例如使用 bufio而不是buf
• 使用单数而不是复数。例如使用encoding 而不是 encodings
• 谨慎地使用缩写。例如使用 fmt 在不破坏上下文的情况下比format 更加简短

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

(5)控制流程

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

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

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

• 最常见的正常流程的路径被嵌套在两个 if条件内
• 成功的退出条件是 return nil，必须仔细匹配大括号来发现
• 函数最后一行返回一个错误，需要追溯到匹配的左括号，才能了解何时会触发错误
• 如果后续正常流程需要增加一步操作，调用新的函数，则又会增加一层嵌套

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

(6)错误和异常处理

①简单错误

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

②错误的 Wrap和 Unwrap

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

Go1.18 在 erors 中新增了三个新API和一个新的format关键字，分别是errors.ls errors.As,errors.Unwrap 以及 fmt.Errorf 的 %w。如果项目运行在小于 Go1.13的版本中，导入golang.org/x/xerrors来使用。

③错误判定

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

在错误链上获取特定种类的错误，使用errors.As

④panic

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

⑤recover

• recover 只能在被 defer 的函数中使用
• 嵌套无法生效
• 只在当前 goroutine 生效
• defer的语句是后进先出

如果需要更多的上下文信息，可以 recover 后在 log 中记录当前的调用栈

⑥小结

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

三、性能优化建议

1.简介

• 性能优化的前提是满足正确可靠、简洁清晰等质量因素
• 性能优化是综合评估，有时候时间效率和空间效率可能对立
• 针对 Go 语言特性，介绍 Go 相关的性能优化建议

2.性能优化建议-Benchmark

如何使用

• 性能表现需要实际数据衡量
• Go语言提供了支持基准性能测试的benchmark工具

3.性能优化建议-Slice

• 切片本质是一个数组片段的描述 包括数组指针 片段的长度
• 片段的容量(不改变内存分配情况下的最大长度
• 切片操作并不复制切片指向的元素
• 创建一个新的切片会复用原来切片的底层数组

4.小结

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