高质量编程与性能调优实战 | 青训营

用户8813732181612
30 阅读6分钟

一、高质量编程

1、什么是高质量？

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

2、编程原则

（1）简单性

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

（2）可读性

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

（3）生产力

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

3、编码规范

（1）注释

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

image.png

（2）代码格式

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

gofmt是Go语言官方提供的工具，常见IDE都支持方便地配置。

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

(3)命名规范

①变量variable

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

②函数Function

  • 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
  • 函数名尽量简短
  • 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
  • 当名为foo的包某个函数返回类型T时（T并不是Foo），可以在函数名中加入类型信息
    For exmple：
    http包中创建服务的函数命名，相比于func ServeHTTP(I net.Listener,handler Handler) error，func Serve(I net.Listener,handler Handler) error更好。

③包package

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

（3）控制流程

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

若两个分支都包含return，可以去除冗余的else

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

优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套。

（4）错误和异常处理

①简单错误

指的是只出现一次的错误，且在其他地方不需要捕获该错误。

  • 优先使用error.New来创建匿名变量来直接表示简单错误
  • 若有格式化需求，则使用fmt.Errorf

image.png

②错误的Wrap和Unwrap

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

image.png

③错误判定

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

image.png

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

image.png

④panic

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

image.png

⑤recover

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

image.png

4、性能优化建议

（1）Benchmark

image.png

代码写好以后，通过go test -bench=. -benchmem评估当前程序执行的性能。

image.png

（2）Slice

①slice预分配内存

尽可能在使用make()初始化切片时就提供容量信息。

image.png

原因：

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

【注】当执行append操作时容量不够，底层数组会先进行扩容再将内容添加到数组中。

type slice struct{
    array unsafe.Pointer
    len int
    cap int
}

②另一个陷阱：大内存未释放

  • 在已有切片基础上创建切片，不会创建新的底层数组
  • 场景
    A.原切片较大，代码在原切片的基础上新建小切片 B.原底层数组在内存中有应用，得不到释放
  • 解决方法：可使用copy替代re-slice

（3）Map

①Map预分配内存

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

（4）字符串处理

①使用strings.Builder

使用+拼接性能最差，strings.Bulider,bytes.Buffer相近，strings.Buffer更快

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

（5）空结构体

①使用空结构体节省内存

  • 空结构体struct{}实例不占据任何的内存空间
  • 可作为各种场景下的占位符使用
    A.节省资源 B.空结构体本身具有很强的语义，即不需要任何值，仅作为占位符

image.png

（6）atomic包

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

image.png

二、性能调优实战

1、性能分析工具pprof

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

image.png

2、pprof的采样过程和原理

（1）CPU

  • 采样对象：函数调用和它们占用的时间
  • 采样率：100次/s，固定值
  • 采样时间：从手动启动到手动结束

image.png

  • 操作系统：每10ms向进程发送一次SIGPROF信号
  • 进程：每次接收到SIGPROF会记录调用堆栈
  • 写缓冲：每100ms读取已经记录的调用栈并写入输出流

image.png

（2）Heap堆内存

  • 采样程序通过内存分配器在堆上分配和释放的内存，记录分配/释放的大小和数量
  • 采样率：每分配512KB记录一次，可在运行开头修改，1为每次分配均记录
  • 采样时间：从程序运行开始到采样时
  • 采样指标：alloc_space,alloc_objects,inuse_space,inuse_objects
  • 计算方式：inuse=alloc-free

（3）Goroutine协程＆ThreadCreate线程创建

image.png

  • Goroutine:记录所有用户发起且在运行中的协程（即入口非runtime开头的）runtime.main的调用栈信息
  • ThreadCreate:记录程序创建的所有系统线程的信息

三、第三天学习心得

节奏好快节奏好快，我感觉每门课程跨度都好大TAT,必须自己下来恶补更多的Go语言相关的知识，不能懒惰不能开摆！！

avatar
文章
阅读
粉丝