高质量编程 ｜ 青训营笔记

行下星暇
79 阅读8分钟

这是我参与「第五届青训营 」伴学笔记创作活动的第 17 天

一、重点内容：

  • 高质量编程-编码规范
  • 高质量编程-性能优化指南
  • 高质量编程-性能分析工具

二、详细知识点介绍：

1. 高质量编程-编码规范

高质量代码概念

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

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

编程原则

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

  • 简单性

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

  • 可读性

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

  • 生产力

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

注释

公共符号始终要注释

  • 包中声明的每个公共的符号:变量、常量、函数以及结构都需要添加注释
  • 任何既不明显也不简短的公共功能必须予以注释
  • 无论长度或复杂程度如何,对库中的任何函数都必须进行注释

例外：不需要注释实现接口的方法。具体不要像下面这样做

image.png

如何编写高质量的Go代码

1、代码格式

gofmt

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

goimports

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

2、注释

注释的运用

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

variable

  • 简洁胜于冗长
  • 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
    • 例如使用ServeHTTP而不是ServeHttp
    • 使用XMLHTTPRequest或者xmHTTPRequest
  • 变量距离其被使用的地方越远，则需要携带越多的上下文信息
    • 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
image.png

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

image.png

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

function

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

package

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

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

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

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

image.png

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

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

  • 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
image.png
  • 最常见的正常流程的路径被嵌套在两个if条件内
  • 成功的退出条件是return nil，必须仔细匹配大括号来发现
  • 函数最后一行返回一个错误，需要追溯到匹配的左括号，才能了解何时会触发错误
  • 如果后续正常流程需要增加一步操作，调用新的函数，则又会增加一层嵌套
5、错误和异常处理

简单错误

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

错误的Wrap和 Unwrap

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

错误判定

  • 判定一个错误是否为特定错误，使用errors.ls
  • 不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误
image.png
  • 在错误链上获取特定种类的错误，使用errors.As
image.png

panic

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

recover

  • recover只能在被defer 的函数中使用
  • 嵌套无法生效
  • 只在当前goroutine生效
  • defer的语句是后进先出
  • 如果需要更多的上下文信息，可以recover后在 log中记录当前的调用栈
image.png

2. 高质量编程-性能优化指南

目的

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

如何使用

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

slice预分配内存

  • 尽可能在使用make()初始化切片时提供容量信息
image.png image.png
  • 切片本质是一个数组片段的描述
    • 包括数组指针
    • 片段的长度
    • 片段的容量(不改变内存分配情况下的最大长度)
  • 切片操作并不复制切片指向的元素
  • 创建一个新的切片会复用原来切片的底层数组

大内存未释放

  • 在已有切片基础上创建切片，不会创建新的底层数组
  • 场景
    • 原切片较大,代码在原切片基础上新建小切片
    • 原底层数组在内存中有引用，得不到释放
  • 可使用copy替代 re-slice

map预分配内存

分析

  • 不断向map中添加元素的操作会触发map 的扩容
  • 提前分配好空间可以减少内存拷贝和 Rehash的消耗
  • 建议根据实际需求提前预估好需要的空间

使用strings.Builder

常见的字符串拼接方式

image.png

使用strings.Builder

image.png

  • 使用＋拼接性能最差，strings.Builder，bytes.Buffer相近，strings.Buffer 更快

  • 分析

    • 字符串在Go语言中是不可变类型，占用内存大小是固定的
    • 使用＋每次都会重新分配内存
    • strings.Builder，bytes.Buffer底层都是[]byte 数组
    • 内存扩容策略，不需要每次拼接重新分配内存

  • bytes.Buffer 转化为字符串时重新申请了一块空间

  • strings.Builder直接将底层的[]byte转换成了字符串类型返回

使用空结构体节省内存

  • 空结构体struct实例不占据任何的内存空间
  • 可作为各种场景下的占位符使用
    • 节省资源
    • 空结构体本身具备很强的语义，即这里不需要任何值，仅作为占位符
image.png
  • 实现Set，可以考虑用map来代替
  • 对于这个场景，只需要用到map 的键，而不需要值
  • 即使是将map 的值设置为bool类型，也会多占据1个字节空间

使用atomic包

  • 锁的实现是通过操作系统来实现,属于系统调用
  • atomic操作是通过硬件实现，效率比锁高
  • sync.Mutex应该用来保护一段逻辑，不仅仅用于保护一个变量
  • 对于非数值操作，可以使用atomic.Value，能承载一个interfacel

3. 高质量编程-性能分析工具

性能调优原则

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

pprof

pprof 功能简介
image.png
pprof 排查实战

1.浏览器查看指标

2.CPU

image.png

3.Heap-堆内存

4.goroutine-协程

  • 由上到下表示调用顺序
  • 每一块代表一个函数，越长代表占用CPU的时间更长
  • 火焰图是动态的,支持点击块进行分析

三、课后个人总结：

通过本章高质量编程的学习，我清楚了高质量代码的概念以及Go语言的高质量代码的编写，在章节学习中，性能分析方面的模块是比较复杂的，我也了解到了性能分析的工具pprof；在开发中，高质量代码对于编码者和看的人都是有益的。

avatar
文章
阅读
粉丝