Go语言规范与性能调优 | 青训营笔记

用户3212461687729
45 阅读7分钟

这是我参与「第五届青训营 」伴学笔记创作活动的第4天，今天主要学习了go语言开发中的规范，以及代码性能提升和错误排查的技术。

高质量编程

编码规范

代码格式

使用gofmt自动格式化代码

注释

注释应该做到

  • 解释代码的作用
  • 解释代码的逻辑
  • 解释代码实现的原因
  • 解释代码出错的情况

命名规范

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

控制流程

  • 避免嵌套，保持正常流程清晰，例如去掉不必要的else
  • 尽量保持正常代码路径为最小缩进，能对称就对称
  • 故障问题的大多出现在复杂的条件语句和循环语句中，尽量化简

错误和异常处理

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

  • 优先使用errors.New来创建匿名变量来直接表示简单错误

  • 如果有格式化需求，请使用fmt.Errorf

    • // 一个例子
func defaultCheckRedirect(req *Request, via []*Request) error {
    if len(via) >= 10 {
        // 使用errors.New
        return errors.New("stopped after 10 redirects.")
    }
    return nil  // 去掉不必要的else
}
复制代码

    • 错误的Wrap与Unnwrap：

      • 错误的Wrap实际上是提供了一个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.ls，不同于使用==，该方法可以判定错误链上的所有错误是否含有特定的错误

        // 一个例子
data, err = lockedfile.Read(targ)
if errors.Is(err, fs.ErrNotExist) {
    return []byte{}, nil
}
return data, err
复制代码

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

        // 一个例子
if _, err := os.Open("non-existing"); err != nil {
    var pathError *fs.PathError
    if errors.As(err, &pathError) {
        fmt.Println("Failed at path:", pathError.Path)
    } else {
        fmt.Println(err)
    }
}

    • panic：比错误更严重，表示程序无法正常工作，在业务代码中不建议使用，故不展开介绍。

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

      生效条件：

      • 只能在被defer的函数中使
      • 嵌套无法生效
      • 只在当前goroutine生效
      • 注意defer是一个栈

性能优化建议

简介：

  • 性能优化的前提是满足正确可靠、简洁清晰等质量因素
  • 性能优化是综合评估，有时候时间效率和空间效率可能对立，所谓时间换空间空间换时间

Benchmark

性能表现需要实际数量来衡量，Go语言提供了支持基准性能测试的benchmark工具

// 一个例子
// from fib.go
func Fib(n int) int {
    if n < 2 {
        return n
    }
    return Fib(n - 1) + Fib(n - 2)
}

// from fib_test.go
func BenchmarkFib10(b *testing.B) {
    // run the Fib funciton b.N times
    for n := 0; n < b.N; n++ {
        Fib(10
    }
}

通过go test -bench=. -benchmen来进行测试

运行结果说明：

image.png

Slice预分配内存

尽可能在使用make()初始化切片的时候就提供容量信息，执行时间会差很多

究其原因是因为

  • 切片本质是一个数组片段的描述包括数字指针、片段的长度以及片段的容量
  • 切片操作并不复制切片指向的元素
  • 创建一个新的切片会复用原来切片的底层数组

image.png

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

有一种情况，原切片由大量元素构成，但是我们在原切片的基础上切片，虽然只使用了很小一段，但底层数组在内存中仍然占据了大量的空间，得不到释放。

这个时候我们可以用copy代替re-slice

Map预分配内存

与Slice相似地，如果初始化size也可以很大程度上优化性能，分析如下：

  • 不断向map中添加元素会触发map的扩容
  • 提前分配好空间可以减少内存拷贝和Rehash的消耗

strings.Builder

在字符串拼接的过程中，使用strings.Builder往往比直接+要快，分析如下：

  • 字符串在Go语言中是不可变类型，占用内存大小是固定的
  • 使用+每次都会重新分配内存
  • strings.Builder, bytes.Buffer底层都是[]byte数组
  • 内存扩容策略，不需要每次拼接重新分配内存
// 一个strings.Builder例子
func StrBuilder(n int, str string) string {
    var builder strings.Builder
    for i := 0; i < n; i++ {
        builder.WriteString(str)
    }
    return builder.String()
}

空结构体

使用空结构体节省内存，分析如下：

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

  • 可作为各种场景下的占位符使用

    • 节省资源
    • 空结构体本身具备很强的语义，不需要任何值，仅作为占位符
// 一个例子
func EmptyStructMap(n int) {
    m := make(map[int]struct{})
    for i := 0; i < n; i++ {
        m[i] = struct{}{}
    }
}

func BoolMap(n int){
    m := make(map[int]bool)
    for i := 0; i < n; i++ {
        m[i] = false
    }
}
// 比较性能即可

atomic包

即原子变量与原子操作；

  • atomic提供的原子操作能够确保任意时刻只有一个goroutine对变量进行操作
  • 善用atomic能够避免程序中出现大量的锁操作
  • 锁的实现是通过操作系统来实现，属于系统调用
  • atomic操作是通过硬件实现，效率显然高

atomic的常见操作：

  • 增减
  • 载入 read
  • cas
  • 交换
  • 存储 write
// 一个例子
var x int32 = 100
// atomic内部是一个compare ans swap, 简称cas, 会在加减操作之前先比较old new两个值再进行操作
// 而sync.Mutex应该用于保护一段逻辑，而不是仅仅一个变量
func f_add() {
	atomic.AddInt32(&x, 1)
}

func f_sub() {
	atomic.AddInt32(&x, -1)
}

func main() {
	for i := 0; i < 100; i++ {
		f_add()
		f_sub()
	}
	fmt.Printf("x: %v\n", x)
}
// 对于非数值操作，可以使用atomic.Value，能承载一个interface{}

性能调优

pprof

  • 希望知道应用在什么地方耗费了多少CPU、Memory
  • pprof是用于可视化和性能分析数据的工具

image.png

排查实战

在浏览器中打开http://localhost:6060/debug/pprof, 这就是我们刚刚引|入的net/http/pprof注入的入口了。 页面上展示了可用的程序运行采样数据，下面也有简单说明， 分别是:

  • allocs:内存分配情况
  • blocks:阻塞操作情况
  • cmdline:程序启动命令集
  • goroutine:当前所有goroutine的堆栈信息
  • heap:堆上内存使用情况(同alloc)
  • mutex:锁竞争操作情况
  • profile: CPU占用情况
  • threadcreate: 当前所有创建的系统线程的堆栈信息
  • trace:程序运行跟踪信息

CPU

命令行输入go tool pprof "http://localhost:6060/debug/pprof/profile?seconds=10"进入pprof编辑模式

image.png 首先，输入top，查看CPU占用最高的函数，这五列从左到右分别是:

  • Flat:当前函数的占用
  • Flat%: Flat占总量的比例
  • Sum%:上面所有行的Flat%总和
  • Cum (Cumulative) :当前函数加上其调用函数的总占用
  • Cum%: Cum占总量的比例

然后使用list命令，后面接top排查出来的高占有率的名称，进行代码定位

Heap-堆内存

命令行输入go tool pprof -http=:8080 "http://localhost: 6060/debug/pprof/heap"打开pprof自带的web UI，可以更加直观的观看性能分布。

左上角view选项可以切换视图，更加直观的显示问题所在。

在堆内存采样中，默认展示的是inuse——space视图，只展示当前持有的内存，但如果有的内存已经被释放，这是inuse采样就不会展示了。我们切换到alloc——space指标。后续分析alloc的内存问题。(用于排除一直申请但又马上释放的代码)

image.png

goroutine

命令行输入go tool pprof -http=:8080 "http://localhost: 6060/debug/pprof/goroutine"

mutex

命令行输入go tool pprof -http=:8080 "http://localhost: 6060/debug/pprof/mutex"

block

命令行输入go tool pprof -http=:8080 "http://localhost: 6060/debug/pprof/block"

原理

了解即可，就没有过多深入

avatar
文章
阅读
粉丝