青训营X豆包MarsCode 技术训练营第三课|高质量编程与性能调优实践

用户744705445707
84 阅读8分钟

高质量编程

高质量编程简介

什么是高质量

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

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

编程原则

实际应用场景千变万化，各种语言的特性和语法各不相同，但是高质量编程遵循的原则是相通的

简单性：

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

可读性：

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

生产力：

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

编码规范

如何编写高质量的 Go 代码

  • 代码格式
  • 注释
  • 命名规范
  • 控制流程
  • 错误和异常处理

代码格式

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

gofmt：

Go 语言官方提供的工具，能自动格式化 Go 语言代码为官方统一风格，常见IDE都支持方便的配置

gofmt：

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

注释

注释应该做的：

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

公共符号始终要注释：

  • 包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释
  • 任何既不明显也不简短的公共功能必须予以注释
  • 无论长度或复杂程度如何，对库中的任何函数都必须进行注释
小结
  • 代码是最好的注释
  • 注释应该提供代码未表达出的上下文信息

命名规范

Valuables

  • 简洁胜于冗长

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

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

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

    • 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
Function
  • 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
  • 函数名尽量简短
  • 当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义
  • 当名为 foo 的包某个函数返回类型T时(T 并不是 Foo)，可以在函数名中加入类型信息

例子：

http 包中创建服务的函数如何命名更好? 第一种

func Serve(l net.Listener, handler Handler) error
​
func ServeHTTP(l net.Listener, handler Handler) error
package
  • 只由小写字母组成。不包含大写字母和下划线等字符
  • 简短并包含一定的上下文信息。例如 schema、task 等
  • 不要与标准库同名。例如不要使用 sync 或者 strings

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

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

核心目标是降低阅读理解代码的成本

重点考虑上下文信息，设计简洁清晰的名称

控制流程

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

    //Bad
if foo {
    return x
} else {
    return nil
}
// Good
if foo {
    return x
}
return nil

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

    //bad
func OneFunc()error {
    err := doSomething( )
    if err == nil {
        err := doAnotherThing()
        if err == nil {
            return nil // normal case
        }
        return err
    }
    return err
}
    • 最常见的正常流程的路径被嵌套在两个 if 条件内
    • 成功的退出条件是 return nil，必须仔细匹配大括号来发现
    • 函数最后一行返回一个错误，需要追溯到匹配的左括号，才能了解何时会触发错误
    • 如果后续正常流程需要增加一步操作，调用新的函数，则又会增加一层嵌套
    //good
func OneFunc() error {
    if err := doSomething(); err != nil {
        return err
    }
    if err := doAnothorThing(); err != nil{
        return err
    }
    return nil
}

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

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

错误和异常处理

简单错误

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

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

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

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

代码示例：

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

  • 判定一个错误是否为特定错误，使用 errors.ls

    if _,err := os.0pen("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
  • 不建议在业务代码中使用 panic
  • 调用函数不包含 recover 会造成程序崩溃
  • 若问题可以被屏蔽或解决，建议使用error 代替 panic
  • 当程序启动阶段发生不可逆转的错误时，可以在 init 或 main 函数中使用 panic
recover
  • recover 只能在被 defer 的函数中使用
  • 嵌套无法生效
  • 只在当前 goroutine 生效
  • defer 的语句是后进先出
func(s *ss)Token(skipSpace bool,f func(rune)bool)
(tok [lbyte, err error){
    defer func(){
        if e := recover();e != nil {
            if se,ok :=e.(scanError);ok{
                err = se.err
            } else {
                    panic(e)
            }
        }
    }()
}
小结

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

性能优化建议

Benchmark

go的基准性能测试工具

  • goos: 显示运行基准测试的操作系统，这里是 linux。
  • goarch: 处理器架构，表明测试在 amd64（64位架构）上运行。
  • pkg: 指向正在测试的包，即 github.com/MoonLight-Zhao/go-project-example/test。
  • cpu: 显示使用的 CPU 的型号及核心数，这里是 AMD EPYC 9Y24 96-Core Processor。
  • 运行了 132,493 次
  • 每次调用的平均时间是 8981 纳秒
  • 每次调用的内存分配是 5376 字节
  • 每次调用的内存分配次数是 1

slice

预分配内存：

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

使用copy

  • 在已有切片基础上创建切片，如果原切片较大，应该用 copy 替代重复切片

    因为原切片较大，代码在原切片基础上新建小切片原底层数组在内存中有引用，得不到释放

map

预分配内存：

分析：

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

字符串处理

使用strings.Builder:

一般情况：

func Plus(n int, str string) string{
    s := ""
    for i := 0; i < n; i++{
        s += str[i]
    }
    return s
}

strings.Builder

func StrBuilder(n int, str string) string {
    var builder string.Builder
    for i := 0; i < n; i ++{
        builder.WriteString(str)
    }
    return builder.String
}

ByteBuffer

func ByteBuffer(n int, str string)string{
    buf := new(bytes.Buffer)
    for i := 0; i<n; i++ {
        buf.WriteString(str)
    }
    return buf.string( )
}

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

  • 分析：

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

想要再进一步提升性能，用 PreStrBuilder，PreByteBuffer (提前知道长度)

空结构体

使用空结构体节省内存:

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

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

    • 节省资源
    • 空结构体本身具备很强的语义，即这里不需要任何值，仅作为占位符

使用示例：

  • 实现 Set，可以考虑用 map 来代替
  • 对于这个场景，只需要用到 map 的键，而不需要值
  • 即使是将 map 的值设置为 bool 类型，也会多占据 1个字节空间

如何使用atomic包

使用 atomic 来代替 sync.Mutex

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

小结

避免常见的性能陷阱可以保证大部分程序的性能

普通应用代码，不要一味地追求程序的性能

越高级的性能优化手段越容易出现问题

在满足正确可靠、简洁清晰的质量要求的前提下提高程序性能

性能调优实战

性能调优简介

性能分析工具pprof实战

性能调优案例

avatar
文章
阅读
粉丝