day03 Go 高质量编程&性能优化 ｜青训营笔记

075
61 阅读5分钟

day03 Go 高质量编程&性能优化

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

高质量——正确可靠，简洁清晰

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

编码规范

公共符号要注释

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

推荐使用gofmt 自动格式化代码 go imports 实际等于gofmt加上依赖包管理，自动增删依赖的包引用，将依赖包按字母排序并分类

注释

注释的作用

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

特别：公共符号始终要注释

命名规范

变量命名 variable

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

函数命名

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

包命名

package

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

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

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

控制流程

避免嵌套 举例

if foo{
   return x
}else{
   return nil
}

if foo{
   return x
}
return nil

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

小结

  • 线性原理 处理逻辑尽量走直线 避免复杂的嵌套分支
  • 正常流程代码沿着屏幕向下移动
  • 提升代码可维护性和可读性
  • 故障问题大多出现在复杂的条件语句和循环语句中

错误和异常处理

简单错误

  • 简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
  • 优先使用 errors.New 来创建匿名变量来直接表示简单错误
  • 如果有格式化的需求，使用fmt.Errorf
if len(via)>=10{
   return errors.New("stopped after 10 redirects")
}
return nil

错误的Warp 和 Unwrap

  • 错误的Warp 实际上是提供了一个error 嵌套另一个error的能力，从而生成一个error的跟踪链
  • 在fmt.Errorf 中使用：%w关键字来将一个错误关联至错误链中
list,_,err :=c.GetBytes(cache.Subkey(a.actionID,"srcfiles"))
if err!=nil{
   return fmt.Errorf("reading srcfiles list: %w",err)
}

错误判定 errors.is errors.As

panic

使用场景：当程序启动阶段发生不可逆转的错误时，可以在int或main函数中使用panic

调用函数不包含recover 会造成程序崩溃

func Panicf(format string,v ...interface{}){
   s:=fmt.Sprintf(format,v...)
   std.Output(2,s)
   panic(s)
}
recover
  • recover 只能在被defer 的函数中使用
  • 嵌套无法生效
  • 只在当前goroutine 生效
  • defer的语句是后进先出
defer func(){
   if e := recover(); e!=nil{
      f=nil
      err=fmt.Errorf("gitfs panic: %v\n%s",e,debug,Stack())
   }
}

recover可以在log中记录当前的调用栈，获取更多的上下文信息

性能优化 指南

Benchmark

位于同一个 package 内的测试文件以 _test.go 结尾 创建文件 main_test.go go test -bench=.-benchmem 命令运行 也可以直接运行

package main

import "testing"

func BenchmarkFib20(b *testing.B) {
	for n := 0; n < b.N; n++ {
		Fib(20)
	}

}
func Fib(n int) int {
	if n < 2 {
		return n
	}
	return Fib(n-1) + Fib(n-2)
}

slice

slice 预分配内存 尽可能在使用make() 初始化切片时提供容量信息

data:= make([]int,0)
data:=make([]int,0,size) //good

slice 底层

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

容量不足，先扩容，再复制数组

另外一个问题 ：大内存未释放

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

map

map 预分配内存即确定容量

data :=make(map[int]int)
data :=make(map[int]int,size)

减少rehash和内存拷贝

字符串处理

strings.Builder 拼接时间消耗最少

  • string.Builder 直接将底层的[]byte 转换成了字符串类型返回
  • bytes.Buffer 转化为字符串时重新申请了一块空间

空结构体的使用

空结构体 struct{} 不占内存

func EmptyStructMap(n int){
       m:=make(map[int]struct{})
       for i :=0;i<n;i++{
            m[i]=struct{}{}
       }
}
  • 实现Set,可以考虑用map来代替
  • 对于这个场景，只需要用到map的键，而不需要值
  • 即使是将map的值设置为bool类型，也会多占据1个字节空间

atomic 包

type atomicCount struct{
     i int32
}
func AtomicAddOne(c *atomicCounter){
       atomic.AddInt32(&c.i,1)
}

atomic 操作是通过硬件实现，效率比锁高 对于非数值操作，可以使用atomic.Value，能承载一个 interface{}

性能优化分析工具

原则

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

性能分析工具 pprof

截屏2023-01-17 下午4.15.08.png 项目 github.com/wolfogre/go… 访问 http://localhost:6060/debug/pprof/

命令 go tool pprof "http://localhost:6060/debug/pprof/profile?seconds=10" 结果出来后 输入top 查看消耗资源

截屏2023-01-17 下午4.24.52.png

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

list 根据指定的正则表达式查找代码行 web 调用关系可视化 通过web命令将profile文件以svg的文件格式写入图形，然后在web浏览器中将其打开

PS D:> go tool pprof profile
Type: cpu Time: Oct 13, 2020 at 12:49am (CST) Duration: 30s, Total samples = 20ms (0.067%) Entering interactive mode (type "help" for commands, "o" for options) (pprof) web (pprof)
如果出现错误 “Could not execute dot; may need to install graphviz” 那么要安装 graphviz组件

heap 堆内存

go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/heap" 采样完成后 浏览器会自动弹出页面

goroutine 协程

go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/goroutine"

goroutine 锁

go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/mutex"

block go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/block"

实战

cpu

  • 采样对象：函数调用和它们占用的时间
  • 采样率：100次/秒，固定值
  • 采样时间：从手动启动到手动结束 截屏2023-01-17 下午7.24.57

heap

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

Goroutine & thread

截屏2023-01-17 下午7.44.03.png

block & mutex

截屏2023-01-17 下午7.44.03.png

案例

基本概念

截屏2023-01-17 下午7.47.06.png

流程

  • 建立服务性能评估手段
  • 分析性能数据，定位性能瓶颈
  • 重点优化项改造
  • 优化效果验证

建立服务性能评估手段

截屏2023-01-17 下午7.47.06.png

avatar
文章
阅读
粉丝