Go高质量编程简介以及性能调优方面 ｜ 青训营笔记

小江同学66666
84 阅读6分钟

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

零.前言

通过本节课你可以学习到:

  • 怎样编写更简洁清晰的代码
  • 常用Go语言程序优化的手段
  • 熟悉Go程序性能分析工具pprof
  • 工程中性能优化的流程和原则

一.本节课重点内容:

  • 高质量编程
    • 高质量编程简介
    • 编码规范
    • 性能优化建议
  • 性能调优案例分析与实战
    • 性能调优简介
    • 性能分析工具
    • pprof实战
    • 性能调优案例

1.高质量编程

编写的代码能够达到正确可靠,简洁清晰的目标就可以称之为高质量编程。但是实际上并不容易,需要多简洁清晰,需要多可靠多正确,如何保证正确?如何撰写简洁清晰的代码?这需要上一节说的单元测试来验证代码的正确性,那如何保证简洁清晰可靠呢?请读者朋友们继续看下去~

编写性能卓越,逻辑清晰,可读性高的代码是每一个编程人员一直在追求的目标。这些目标主要要满足以下几点:

  • 简单性：消除多余的复杂性,以简单清晰的逻辑编写代码，不好理解的代码容易带来给coder带来歧义,使得代码不易修改和维护。
  • 可读性：代码是写给人看的,而不是机器,编写可维护代码的第一步是确保代码可读。简单来说就是少炫技!少写语法糖!(当然如果可以优化代码执行速度,或者是行内基础知识那么另当别论)
  • 生产力：团队整体的工作效率非常重要，为了减低新员工上手项目代码的成本,一般的Go语言的IDE都配置有格式化功能,所以这一步可以通过配置IDE来实现,另外可以在编写项目代码遇到复杂逻辑时,简要描述一下思路以及上下文背景,可以让新员工更容易上手。

编码规范

如何编写高质量的Go代码？需要注意以下几点：

  • 代码格式:使用gofmt自动格式化代码

  • 注释:

    • 注释应该解释代码作用
    • 注释应该解释代码如何做的(交代实现代码逻辑)
    • 注释应该解释代码实现的原因(交代上下文背景,实现功能的上下游)
    • 注释应该解释代码什么情况会出错(交代函数异常情况)
    • 公共符号始终要注释(变量,函数,常量,方法,包)

  • 命名规范:

    • 尽可能简洁
    • package名只由小写字母组成
    • 缩略词全大写，但当其位于变量开头且不需要导出时，
      • 如使用ServeHTTP而不是ServeHttp
      • 如使用XMLHTTPRequest而不是xmlHTTPRequest
    • 变量距离其被使用的地方越远，则需要携带越多的上下文信息
    • 函数名不携带包名的上下文信息且尽量简短

  • 控制流程:

    • 避免嵌套，保持正常流程清晰,如果两个if-else分支中都包含return语句那么可以直接去掉else
    • 尽量保持正常代码路径为最小缩进,优先处理错误异常特殊情况,尽早返回或继续尽早执行接下来的代码逻辑
    • 处理逻辑尽可能走直线,避免复杂的嵌套分支

  • 错误和异常处理:

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

例1

func defaultCheckRedirect(req *Request, via []*Request) error {
    if len(via) >= 10 {
        // 简单错误优先使用errors.New
        return errors.New("stopped after 10 redirects.")
    }
    // else
    // 去掉不必要的else
    return nil  
}

错误包Wrap和UnWrap

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

例2

list, _, err := c.GetBytes(cache.Subkey(a.actionID, "srcfiles"))
if err != nil {
    return fmt.Errorf("reading srcfiles list: %w", err)
}

错误判定：

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

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

  • panic:最严重的错误,表示程序无法正常工作,通常在服务器或者客户端连接初始化的时候会使用,让不能运转的服务器和客户端连接尽早的关闭,尽可能的节省系统资源。

  • recover：用来处理panic，更多的实际应用场景是提示程序员或用户出现错误的原因,从而快速定位程序运行失败的原因。生效条件：

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

2.性能优化案例分析与实战

  • 性能优化的前提是满足正确可靠、简洁清晰等质量因素
  • 性能优化是综合评估，有时候时间效率和空间效率可能对立，所谓时间换空间空间换时间
  • 针对Go语言,介绍Go相关性能优化建议

Benchmark

性能表现需要实际数据来衡量，Go本身自带的benchmark工具可以用于基准分析

例3

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

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

image.png

  • 通过对Slice,Map,strings.Builder的内存预分配可以减少内存的分配次数和拷贝数据的次数提高程序运行效率

  • Slice预分配性能提升原因分析:

    • 切片本质是一个数组片段的描述包括数字指针、片段的长度以及片段的容量
    • 切片操作并不复制切片指向的元素
    • 创建一个新的切片会复用原来切片的底层数组
    • Slice使用陷阱:有一种情况，原切片由大量元素构成，但是我们在原切片的基础上切片，虽然只使用了很小一段，但底层数组在内存中仍然占据了大量的空间，得不到释放。此时我们使用copy代替slice可以释放调大内存

  • Map预分配内存性能提升原因分析:

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

  • strings.Builder预分配内存性能提升原因分析:

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

StrBuilder底层源码:

func StrBuilder(n int, str string) string {
    var builder strings.Builder
    for i := 0; i < n; i++ {
        builder.WriteString(str)
    }
    return builder.String()
}
  • 空结构体可与提高运行性能
    • 使用空结构体节省内存，分析如下:
    • 空结构体struct}实例不占据任何的内存空间·可作为各种场景下的占位符使用
      • 节省资源
      • 空结构体本身具备很强的语义，不需要任何值，仅作为占位符

例4:Set的go语言简单实现:

func EmptyStructSet(n int) {
    m := make(map[int]struct{})
    for i := 0; i < n; i++ {
        m[i] = struct{}{}
    }
}

func BoolSet(n int){
    m := make(map[int]bool)
    for i := 0; i < n; i++ {
        m[i] = false
    }
}

  • 使用atomic包对单个变量做并发安全保护

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

  • atomic的常见操作:

    • swap
    • read
    • add/sub
    • cas
    • write

  • 在维护单个共享变量时优先考虑使用atomic,在维护一段代码块时使用锁,在使用上比较简单同时也能提高运行效率

性能调优原则:

  • 依靠数据而非猜测
  • 找到决速反应，而非细枝末节
  • 不要过早和过度的优化

性能分析工具pprof

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

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

  • pprof功能简介

image.png

  • pprof排查工具文档

  • 大家可以在其他文章了解pprof更为详细的介绍,笔者能力受限就不在此显拙了~

三.引用参考

avatar
文章
阅读
粉丝