编程规范和性能优化 ｜ 青训营笔记

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

简介： 在学习了基础的Go语言编程方法后我们还有许多需要注意的编程规范。性能优化的前提是满足正确可靠、简洁清晰等质量因素性能优化是综合评估，有时候时间效率和空间效率可能对立针对 Go 语言特性，介绍 Go 相关的性能优化建议

1. 编码规范

   • 编码规范
   • 性能优化

2. 性能调优

   • 工具pprof的使用
   • 性能调优案例

编码规范： 实际应用场景千变万化。在编程的过程中我们要遵循以下两点特性。

a. 简单性

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

b. 可读性

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

具体有以下几点需要注意

1. 代码格式

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

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

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

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

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

2. 注释

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

3. 命名规范、控制流程均需要以不出现冗余为目标
4. 错误和异常处理
5. 性能能测试-benchmark

性能优化建议Slice预分配内存

• 切片本质是一个数组片段的描述
  • 包括数组指针
  • 片段的长度
  • 片段的容量
• 切片操作并不复制切片指向的元素
• 创建一个新的切片会复用原来切片的底层数组
• 我们还需注意“大内存未释放的问题”可以用copy来代替re-slice,以下为仅拷贝和切片的对比。显然写死的占用空间会小的多。

// from fib.go
func Fib(n int) int {
    if n < 2 {r
        eturn n
    }
    return Fib(n-1) + Fib(n-2)
// from fib_test.go
func BenchmarkFib10(b *testing.B) {
    // run the Fib function b.N times
    for n := 0; n < b.N; n++ {
        Fib(10)
    }
}

执行：go test-bench=.-benchmem

结果如下： 其中，BenchmarkFib10是测试函数名-8 表示GOMAXPROCS的值为8； 1855870表示一共执行这么多次即b.N的值；602.5ns表示每次执行花费时间；