高质量编程与性能调优实战｜青训营笔记前言这是我参与「第三届青训营 -后端场」笔记创作活动的的第3篇笔记，做笔记记录

前言

这是我参与「第三届青训营 -后端场」笔记创作活动的的第3篇笔记，做笔记记录一下自己的学习过程。

此笔记主要内容如下：

高质量编程

高质量编程简介
编码规范
性能优化建议

1 高质量编程

1.1 简介

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

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

简单性

消除“多余的复杂性”，以简单清晰的逻辑编写代码
不理解的代码无法修复改进 可读性
代码是写给人看的，而不是机器
编写可维护代码的第一步是确保代码可读 生产力
团队整体工作效率非常重要

1.2 编码规范

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

1.2.1 代码格式

gofmt

Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格

常见IDE都支持方便的配置，Goland直接内置
goimports

goimports也是Go语言官方提供的工具，实际等于gofmt加上依赖包管理

自动增删依赖包的引用、将依赖包按字母序排序并分类

1.2.2 注释

注释应该解释代码的作用
- 适合注释公共符号
注释应该解释代码如何做的
- 适合注释实现过程
注释应该解释代码实现的原因
- 适合解释代码的外部因素
- 提供额外上下文
注释应该解释代码什么情况会出错
- 适合解释代码的限制条件

公共符号始终要注释

包中声明的每个公共符号：变量、常量、函数以及结构都需要添加注释
任何既不明显也不简短的公共功能必须予以注释
无论长度或复杂程序如何，对库中的任何函数都必须进行注释
有一个例外，不需要注释实现接口的方法
尽管LimitedReader.Read本身没有注释，但它紧跟LimitedReader结构的声明，明确它的作用小结
代码是最好的注释
注释应该提供代码未表达出的上下文信息 Good code has lots of comments, bad code requires lots of comments

好的代码有很多注释，坏代码需要很多注释。——Dave Thomas and Andrew Hunt

1.2.3 命名规范

变量variable
- 简洁胜于冗长
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
  - 例如使用ServeHTTP而不是ServeHttp
  - 使用XMLHTTPRequest或者xmlHTTPRequest
- 变量距离其被使用的地方越远，则需要携带越多的上下文信息
  - 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
  - 在for循环内部，当i和index的作用域仅限于for循环内部时，index的额外冗长几乎没有增加对程序的理解
  - 在函数提供给外部调用时，
    - 将deadline替换成t降低了变量名的信息量
    - t常代指任意时间
    - deadline指截止时间，有特定的含义
函数function
- 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
- 函数名尽量简短
- 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
- 当名为foo的包某个函数返回类型T时（T并不是Foo），可以在函数名中加入类型信息
包package
- 只由小写字母组成。不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息。例如schema、task等
- 不要与标准库同名。例如不要使用sync或者strings 以下规则尽量满足，以标准库包名为例
- 不使用常用变量作为包名。例如使用bufio而不是buf
- 使用单数而不是复数。例如使用encoding而不是encodings
- 谨慎地使用缩写。例如使用fmt在不破坏上下文的情况下比format更加简短小结
核心目标是降低阅读理解代码的成本
重点考虑上下文信息，设计简洁清晰的名称 Good naming is like a good joke. If you have to explain it, it's not funny.

好的命名就像一个好笑话。如果你必须解释它，那就不好笑了。——Dave Cheney

1.2.4 控制流程

避免嵌套，保持正常流程清晰
- 如果两个分支中都包含return语句，则可以去除冗余的else
尽量保证正常代码路径为最小缩进
- 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套小结
线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
正常流程代码沿着屏幕向下移动
提升代码可维护性和可读性
故障问题大多出现在复杂的条件语句和循环语句中

1.2.5 错误和异常处理

简单错误
- 简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
- 优先使用errors.New 来创建匿名变量来直接表示简单错误
- 如果有格式化的需求，使用fmt.Errorf
错误的Wrap和Unwrap
- 错误的Wrap实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链
- 在fmt.Errorf中使用: %w 关键字来将一个错误关联至错误链中
- Go1.13在errors中新增了三个新API和一个新的format关键字，分别是errors.Is,errors.As,errors.Unwrap以及fmt.Errorf的%w。如果项目运行在小于Go1.13的版本中，导入golang.org/x/xerrors来使用。
错误判定
- 判定一个错误是否为特定错误，使用errors.Is
- 不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误
- 在错误链上获取特定种类的错误，使用errors.As
panic
- 不建议在业务代码中使用panic
- 调用函数不包含recover会造成程序崩溃
- 若问题可以被屏蔽或解决，建议使用error代替panic
- 当程序启动阶段发生不可逆转的错误时，可以在init或main函数中使用panic尽早暴露错误
recover
- recover只能在被defer的函数中使用
- 嵌套无法生效
- 只在当前goroutine生效
- defer的语句是后进先出
- 如果需要更多的上下文信息，可以recover后在log中记录当前的调用栈。//err = fmt.Errorf("gitfs panic: %v\n%s", e, debug.Stack()) 小结
error尽可能提供简明的上下文信息链，方便定位问题
panic用于真正异常的情况
recover生效范围，在当前goroutine的被defer的函数中生效

1.3 性能优化建议

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

1.3.1 Benchmark

性能表现需要实际数据衡量
Go语言提供了支持基准性能测试的benchmark工具 go test -bench=. -benchmem
GOMAXPROCS 1.5版本后，默认值为CPU核数

1.3.2 Slice性能优化建议

slice预分配内存

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

切片本质是一个数组片段的描述
- 包括数组指针
- 片段的长度
- 片段的容量（不改变内存分配情况下的最大长度）
slice结构体源码
```
      type slice struct {
          array unsafe.Pointer
          len int
          cap int
      }
      
```
切片操作并不复制切片指向的元素

创建一个新的切片会复用原来切片的底层数组

带来一个问题：大内存未释放
- 在已有切片的基础上创建切片，不会创建新的底层数组
- 场景
  - 原切片较大，代码在原切片基础上新建小切片
  - 原底层数组在内存中有引用，得不到释放
- 可用copy代替re-slice

测试代码


      func GetLastBySlice(origin []int) []int {
         return origin[len(origin)-2:]
      }
      func GetLastByCopy(origin []int) []int {
         result := make([]int, 2)
         copy(result, origin[len(origin)-2:])
         return result
      }
      func generateWithCap(n int) []int {
         rand.Seed(time.Now().UnixNano())
         nums := make([]int, 0, n)
         for i := 0; i < n; i++ {
            nums = append(nums, rand.Int())
         }
         return nums
      }
      func printMem(t *testing.T) {
         t.Helper()
         var rtm runtime.MemStats
         runtime.ReadMemStats(&rtm)
         t.Logf("%.2f MB", float64(rtm.Alloc)/1024./1024.)
      }
      func testGetLast(t *testing.T, f func([]int) []int) {
         result := make([][]int, 0)
         for k := 0; k < 100; k++ {
            origin := generateWithCap(128 * 1024) // 1M
            result = append(result, f(origin))
         }
         printMem(t)
         _ = result
      }
      func TestLastBySlice(t *testing.T) {
         testGetLast(t, GetLastBySlice)
      }
      func TestLastByCopy(t *testing.T) {
         testGetLast(t, GetLastByCopy)
      }

1.3.3 map性能优化建议

map预分配内存

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

测试代码


      func NoPreAlloc(size int) {
         data := make(map[int]int)
         for i := 0; i < size; i++ {
             data[i] = 1
         }
      }
      func PreAlloc(size int) {
         data := make(map[int]int, size)
         for i := 0; i < size; i++ {
            data[i] = 1
         }
      }
      func BenchmarkNoPreAlloc(b *testing.B) {
         for n := 0; n < b.N; n++ {
            NoPreAlloc(1000)
         }
      }
      func BenchmarkPreAlloc(b *testing.B) {
         for n := 0; n < b.N; n++ {
            PreAlloc(1000)
         }
      }

1.3.4 字符串处理

使用strings.Builder

使用+号拼接性能最差，strings.Builder,bytes.Buffer相近，strings.Builder更快
分析
- 字符串在Go语言中是不可变类型，占用内存大小是固定的
- 使用+每次都会重新分配内存
- strings.Builder,bytes.Buffer底层都是[]byte数组
- 内存扩容策略，不需要每次拼接重新分配内存
- bytes.Buffer转化为字符串时重新申请了一块空间
- strings.Builder直接将底层的[]byte转换成了字符串类型返回
- stirngs.Builder和bytes.Buffer都可以通过预分配内存来提高性能

测试代码


func Plus(n int, str string) string {
   s := ""
   for i := 0; i < n; i++ {
      s += str
   }
   return s
}
func StrBuilder(n int, str string) string {
   var builder strings.Builder
   for i := 0; i < n; i++ {
      builder.WriteString(str)
   }
   return builder.String()
}
func ByteBuffer(n int, str string) string {
   buf := new(bytes.Buffer)
   for i := 0; i < n; i++ {
      buf.WriteString(str)
   }
   return buf.String()
}
func PreStrBuilder(n int, str string) string {
   var builder strings.Builder
   builder.Grow(n * len(str))
   for i := 0; i < n; i++ {
      builder.WriteString(str)
   }
   return builder.String()
}
func PreByteBuffer(n int, str string) string {
   buf := new(bytes.Buffer)
   buf.Grow(n * len(str))
   for i := 0; i < n; i++ {
      buf.WriteString(str)
   }
   return buf.String()
}
func BenchmarkPlus(b *testing.B) {
   for n := 0; n < b.N; n++ {
      Plus(1000, "string")
   }
}
func BenchmarkStrBuilder(b *testing.B) {
   for n := 0; n < b.N; n++ {
      StrBuilder(1000, "string")
   }
}
func BenchmarkByteBuffer(b *testing.B) {
   for n := 0; n < b.N; n++ {
      ByteBuffer(1000, "string")
   }
}
func BenchmarkPreStrBuilder(b *testing.B) {
   for n := 0; n < b.N; n++ {
      PreStrBuilder(1000, "string")
   }
}
func BenchmarkPreByteBuffer(b *testing.B) {
   for n := 0; n < b.N; n++ {
      PreByteBuffer(1000, "string")
   }
}

1.3.5 空结构体

使用空结构体节省内存

空结构体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
   }
}
func BenchmarkEmptyStructMap(b *testing.B) {
   for n := 0; n < b.N; n++ {
      EmptyStructMap(10000)
   }
}
func BenchmarkBoolMap(b *testing.B) {
   for n := 0; n < b.N; n++ {
      BoolMap(10000)
   }
}

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

1.3.6 atomic包

使用atomic包

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

测试代码


type atomicCounter struct {
   i int32
}
func AtomicAddOne(c *atomicCounter) {
   atomic.AddInt32(&c.i, 1)
}
type mutexCounter struct {
   i int32
   m sync.Mutex
}
func MutexAddOne(c *mutexCounter) {
   c.m.Lock()
   c.i++
   c.m.Unlock()
}
func BenchmarkAtomicAddOne(b *testing.B) {
   for n := 0; n < b.N; n++ {
      var counter = atomicCounter{}
      AtomicAddOne(&counter)
   }
}
func BenchmarkMutexAddOne(b *testing.B) {
   for n := 0; n < b.N; n++ {
      var counter = mutexCounter{}
      MutexAddOne(&counter)
   }
}

小结

避免常见的性能陷阱可以保证大部分程序的性能
普通应用代码，不要一味地追求程序地性能
越高级的性能优化手段越容易出现问题
在满足正确可靠，简洁清晰的质量要求的前提下提高程序性能

高质量编程与性能调优实战 ｜ 青训营笔记

前言

此笔记主要内容如下：

1 高质量编程

1.1 简介

1.2 编码规范

1.2.1 代码格式

1.2.2 注释

1.2.3 命名规范

1.2.4 控制流程

1.2.5 错误和异常处理

1.3 性能优化建议

1.3.1 Benchmark

1.3.2 Slice性能优化建议

1.3.3 map性能优化建议

1.3.4 字符串处理

1.3.5 空结构体

1.3.6 atomic包

高质量编程与性能调优实战｜青训营笔记