高质量编程与性能调优 | 青训营笔记

miopass
47 阅读5分钟

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

3.1高质量编程

编程原则

简单性

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

可读性

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

生产力

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

注释

  • 包中声明的每个公共的符号: 变量、常量、函数以及结构都需要添加注释
  • 任何既不明显也不简短的公共功能必须予以注释
  • 无论长度或复杂程度如何，对库中的任何函数都必须进行注释
  • 注释应该解释代码是如何做的
  • 注释应该解释代码实现的原因
  • 注释应该解释代码什么时候会出错

小结：

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

代码格式

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

goimports

相当于gofmt + 依赖包管理

自动增删依赖包并按字母序排序

命名规范

变量

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

例如只对于一个简单的for循环，直接用 i 会比 index 好

函数

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

包

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

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

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

核心的目标在于降低阅读代码的成本

控制流程

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

就是优先退出的代码（异常）

  • 尽量走直线，避免复杂嵌套分支
  • 希望正常流程沿着
  • 提升代码的可维护性和可读性

简单错误

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

错误的warp和unwrap

warp提供了一个error嵌套另一个error的能力，形成一个error的跟踪链

在fmt.Errorf中使用 %w 关键字将一个错误关联到错误链中

errors.Is

判定一个错误是否为特定错误，使用errors.Is 不同于使用==,使用该方法可以判定错误链上的所有错误是否含有特定的错误 如果有格式化的需求，使用fmt.Errorf

image-20230116183711734

errors.As

在错误链上获取特定的错误

image-20230116183827980

panic

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

4.1 性能优化

如何判断一段代码的性能

有基本的性能测试用具 benchmark

命令：

go test -bench=. -benchmem

性能优化的建议

slice

1、如果能够提前定义切片的大小，最好提前定义，以免后期扩容拷贝数组导致性能下降

2、如果需要得到原切片的一部分

return origin[len(origin)-2 :] //这会得到一个新切片，导致内存的重复占用

copy(result,origin[len(origin)-2 :]) //这样新的切片的大小会小很多

map

map也可以预分配内存

make(map[int]int,size)

strings.Builder

由于字符串是不可变类型，所以直接用+操作会新建一份字符串

而 stringbuilder 的底层是[]byte数组，不需要重新分配内存，就可以节省很多性能

bytes.Buffer最后返回的时候会重新复制一份buffer，而stringBuilder是直接把底层的数据转成字符串，所以 stringBuilder会比bytes.Buffer更加快一点

stringbuilder也支持预分配，如下

car builder strings.Builder
builder.Grow()

空结构体

image-20230117183136156

如果实现set（不排序，仅仅去重） 可以直接把值定义为空结构体以节省内存

多线程：atiomic包

多线程的int ，如果用atiomic包下的atomic.AddInt32 性能会比加锁优异很多

因为锁的实现是操作系统调用实现

而atiomic包是根据硬件底层实现的

小结

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

性能分析工具：

pprof是用于可视化和分析性能分析数据的工具

github.com/wolfogre/go…

go tool pprof "http://localhost:6060/debug/pprof/profile?seconds=10"

然后根据top指令列出最消耗资源的函数

image-20230117211637947

image-20230117211702240

最后用 list 指令列出消耗资源的方法，成功排查

可以使用网页终端进行排查

go tool pprof -http=:8083 "http://localhost:6060/debug/pprof/heap"

avatar
文章
阅读
粉丝