高质量编程 & 性能优化学习笔记
目录
高质量编程
编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码
- 各种边界条件是否完备
- 异常情况处理，稳定性保证
- 易读易维护
编程原则
- 简单性
- 消除“多余的复杂性”，以简单清晰的逻辑编写代码
- 不理解的代码无法修复改进
- 可读性
- 代码是写给人看的，而不是机器
- 编写可维护代码的第一步是确保代码可读
- 生产力
- 团队整体工作效率非常重要
编码规范
代码格式
推荐使用gofmt自动格式化代码
goimports实际等于gofmt加上依赖包管理，自动增删依赖的包引用、将依赖包按字母序排序并分类
注释
公共符号始终要注释
- 包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释
- 任何既不明显也不简短的公共功能必须予以注释
- 无论长度或复杂程度如何，对库中的任何函数都必须进行注释
- 有一个例外，不需要注释实现接口的方法
- 注释应该做的
- 解释代码作用
- 解释代码如何做的
- 解释代码实现的原因
- 解释代码什么情况会出错
命名规范
- 简洁胜于冗长
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 例如使用ServeHTTP而不是ServeHttp
- 使用XMLHTTPRequest而不是xmlHTTPRequest
- 变量距离其被使用的地方越远，则需要携带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨别出其含义
function：
- 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
- 函数名尽量简短
- 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
- 当名为foo的包某个函数返回类型T时(T并不是Foo)，可以在函数名中加入类型信息
package：
- 只由小写字母组成，不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息，例如schema、task等
- 不要与标准库同名，例如不要使用sync或strings
以下规则尽量满足，以标准库包名为例 - 不使用常用变量名作为包名，例如使用bufio而不是buf
- 使用单数而不是复数，例如使用encoding而不是encodings
- 谨慎地使用缩写，例如使用fmt在不破坏上下文的情况下比format更加简短
控制流程
- 避免嵌套，保持正常流程清晰
- 尽量保持正常代码路径为最小缩进
- 优先处理错误情况、特殊情况，尽早返回或继续循环来减少嵌套
- 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
- 正常流程代码沿着屏幕向下移动
- 提升代码的可维护性和可读性
- 故障问题大多出现在复杂的条件语句和循环语句中
错误和异常处理
简单错误
- 简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
- 优先使用errors.New()来创建匿名变量来直接表示简单错误
- 如果有格式化的要求，使用fmt.Errorf()
错误的Wrap和Unwrap
- 错误的Wrap实际上是提供一个error嵌套另一个error的能力，从而生成一个error的跟踪链
- 在fmt.Errorf中使用%w关键字来讲一个错误关联至错误链中
Go1.13在errors中新增了三个新API和一个新的format关键字，分别是errors.Is，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的函数中生效
性能优化
性能优化：提升软件系统处理能力，减少不必要的消耗，充分发掘计算机算力
原因：
- 用户体验：带来用户体验的提升
- 资源高效利用：降低成本，提升效率
性能优化的层面：业务代码、SDK、基础库、语言运行时、OS
- 业务层优化
- 针对特定场景，具体问题具体分析
- 容易获得较大性能效益
- 语言运行时优化
- 解决更通用的性能问题
- 考虑更多场景
- Tradeoffs
- 数据驱动
- 自动化性能分析工具–pprof
- 依靠数据而非猜测
- 首先优化最大瓶颈
性能优化与软件质量
- 软件质量至关重要
- 在保证接口稳定的前提下改进具体实现
- 测试用例：覆盖尽可能多的场景，方便回归。用测试驱动开发
- 文档：做了什么，没做什么，能达到怎样的效果
- 隔离：通过选项控制是否开启优化
- 可观测：必要的日志输出
性能优化建议
Benchmark
- 性能表现需要实际数据衡量
- Go语言提供了支持基准性能测试的benchmark工具
Slice
- 尽可能在使用make()初始化切片时提供容量信息
- 切片本质是一个数组片段的描述
- 包括数组指针
- 片段长度
- 片段容量(不改变内存分配情况下的最大长度)
- 切片操作并不复制切片指向的元素
- 创建一个新的切片会复用原来切片的底层数组，在已有切片基础上创建切片，不会创建新的底层数组
- 陷阱：大内存未释放
- 原切片较大，代码在原切片基础上新建小切片
- 原底层数组在内存中有引用，得不到释放
- 可使用copy代替re-slice
Map
- 尽可能在使用make()初始化切片时提供容量信息
- 提前分配好空间可以减少内存拷贝和Rehash的消耗
字符串处理
- 使用+拼接性能最差，string.Builder和bytes.Buffer相近，strings.Buffer更快
- bytes.Buffer转化为字符串时重新申请了一块空间，strings.Builder直接将底层的[]byte转换为字符串类型返回
空结构体
使用空结构体节省内存
- 空结构体struct{}实例不占据任何内存空间
- 可作为各种场景下的占位符使用
- 节省资源
- 空结构体本身具备很强的语义，即这里不需要任何值，仅作为占位符
- 实现Set，可以考虑用Map来代替，
最低0.47元/天 解锁文章
扫一扫
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
