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

九月Sepnine
90 阅读6分钟

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

高质量编程

什么是高质量？

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

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

如何编写高质量Go代码

  • 注释

    1. 公共符号（首字母大写）始终要注释（有一个例外：不需要注释实现接口的方法）

    2. 注释应该解释代码的作用

    3. 注释应该解释代码如何做的

    4. 注释应该解释代码实现的原因

    5. 注释应该解释代码什么情况会出现错误

    6. 代码是最好的注释，注释应提到代码无法展现出来的信息

  • 代码格式

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

    2. 可以使用goimports。实际上goimports = gofmt + 依赖包管理

  • 命名规范

    • 变量命名

    1. 简洁胜于冗(rong)长

    2. 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写

      • 例如使用ServeHTTP 而不是ServeHttp
      • 使用XMLHTTPRequest或者xmlHTTPRequest

    3. 变量距离其被使用的地方越远，则需要携带越多的上下文信息

      • 全局变量需要在其名字中添加更多的上下文信息，使其在不同地方可以轻易辨别出其含义

    • 函数命名

    1. 函数名不携带包名的上下文信息，因为包名与函数总是成对出现

    2. 函数名尽量简短

    • package

    1. 只有小写字母组成，不包含大写字母与下划线
    2. 简短并包含一定的上下文信息。
    3. 不要与标准库同名
    4. 不适用常用变量名作为包名
    5. 使用单数而不使用复数

  • 控制流程

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

错误与异常处理

  • 简单错误

简单错误指仅出现一次的错误，且在其他地方不需要捕获该错误

​ 优先使用errors.New()来创建匿名变量来直接表示简单错误，如果有格式化需求，则使用fmt.Errorf()

  • 错误的Wrap和Unwrap

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

  • 错误判定

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

  • panic

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

  • recover

    • recover只能在被defer的函数中使用

    • 嵌套无法生效

    • 只在当前goroutine生效

    • defer的语句是后进先出的

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

  • 总结

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

性能优化

性能优化建议

  • slice预分配内存

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

  • 大内存未释放

在已有切片的基础上创建切片，不会创建新的底层数组

​ 也就是原本的切片slice很大，然后调用slice[1,4]对切片进行截取。此时原来的数组在内存中有引用，得不到释放，会造成内存占用。可以使用copy代替原数组。

  • map预分配内存

向map不断添加元素的操作会触发map的扩容，提前分配内存可以减少内存拷贝与Rehash的消耗

  • 使用strings.Builder或者bytes.Buffer

使用 + 进行字符串拼接性能很差，每次拼接都许哟啊重新分配内存

strings.Builder与bytes.Buffer底层都是[]byte数组，由于内存扩容策略，不许哟啊每次拼接重新分配内存

  • 空结构体

空结构体struct{}实例不占用任何内存空间

可以作为占位符使用，从而节约资源

例如： 可以将map作为set使用，只需将所有的value都设置为struct{}。即使使用bool也会占用1字节

  • 使用atomic包

atomic包的效率要比加锁高：atomic的效率高是由于其 实现基于硬件，但是mutexlock是基于操作系统，基于操作系统的会消耗更多的资源

sync.Mutex应该用来保护一段逻辑，不仅仅用来保护一个变量

对于非数值操作可以使用atomic.Value，能承载一个interface{}

性能调优原则

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

性能分析工具pprof

我们希望知道应用在什么地方耗费了多少CPU,Memory

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

pprof排查实战

启动项目go-pprof-pratice并访问http://localhost:6060/debug/pprof

通过资源监视器可以看到当前的项目占用2.77的内存，是本机占用最大的。

image.png

项目的控制台输入：

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

image.png 然后使用topN命令 查看占用资源情况

image.png

从上图可以发现，Eat函数占用CPU总时间的比例高达99.26%,因此是Eat出现问题。

image.png

其中

image.png

可以得到

  • Flat == Cum,函数中没有调用其他函数
  • Flat == 0 ,函数中只调用了其他函数

使用list命令根据指定的正则表达式查找代码行

list Eat

根据下图可以看到性能消耗都在for循环中

image.png

此时我们已经定位到出现问题的代码。我们直接将其注释。

func (t *Tiger) Eat() {
	log.Println(t.Name(), "eat")
	//loop := 10000000000
	//for i := 0; i < loop; i++ {
	//	// do nothing
	//}
}

此后发现该项目的CPU占用从2.77 -> 0.01

image.png

实际分析排查过程

avatar
文章
阅读
粉丝