关于golang:Go-每日一库之-bytebufferpool

简介

在编程开发中，咱们常常会须要 频繁 创立和销毁同类对象的情景。这样的操作很可能会对性能造成影响。这时，罕用的优化伎俩就是应用 对象池 （object pool）。须要创建对象时，咱们先从对象池中查找。如果有闲暇对象，则从池中移除这个对象并将其返回给调用者应用。只有在池中无闲暇对象时，才会真正创立一个新对象。另一方面，对象应用完之后，咱们并不进行销毁。而是将它放回到对象池以供后续应用。应用对象池在频繁创立和销毁对象的情景下，能大幅度晋升性能。同时，为了防止对象池中的对象占用过多的内存。对象池个别还配有特定的清理策略。Go 规范库sync.Pool 就是这样一个例子。sync.Pool中的对象会被垃圾回收清理掉。

在这类对象中，比拟非凡的一类是字节缓冲（底层个别是字节切片）。在做字符串拼接时，为了拼接的高效，咱们通常将两头后果寄存在一个字节缓冲。在拼接实现之后，再从字节缓冲中生成后果字符串。在收发网络包时，也须要将不残缺的包临时寄存在字节缓冲中。

Go 规范库中的类型 bytes.Buffer 封装字节切片，提供一些应用接口。咱们晓得切片的容量是无限的，容量有余时须要进行扩容。而频繁的扩容容易造成性能抖动。bytebufferpool实现了本人的 Buffer 类型，并应用一个简略的算法升高扩容带来的性能损失。bytebufferpool曾经在赫赫有名的 Web 框架 fasthttp 和灵便的 Go 模块库 quicktemplate 失去了利用。实际上，这 3 个库是同一个作者：valyala😀。

疾速应用

本文代码应用 Go Modules。

创立目录并初始化：

$ mkdir bytebufferpool && cd bytebufferpool
$ go mod init github.com/darjun/go-daily-lib/bytebufferpool

装置 bytebufferpool 库：

$ go get -u github.com/PuerkitoBio/bytebufferpool

典型的应用形式先通过 bytebufferpool 提供的 Get() 办法获取一个 bytebufferpool.Buffer 对象，而后调用这个对象的办法写入数据，应用实现之后再调用 bytebufferpool.Put() 将对象放回对象池中。例：

package main

import (
  "fmt"

  "github.com/valyala/bytebufferpool"
)

func main() {b := bytebufferpool.Get()
  b.WriteString("hello")
  b.WriteByte(',')
  b.WriteString("world!")

  fmt.Println(b.String())

  bytebufferpool.Put(b)
}

间接调用 bytebufferpool 包的 Get() 和Put()办法，底层操作的是包中默认的对象池：

// bytebufferpool/pool.go
var defaultPool Pool

func Get() *ByteBuffer { return defaultPool.Get() }
func Put(b *ByteBuffer) {defaultPool.Put(b) }

咱们当然能够依据理论须要创立新的对象池，将雷同用途的对象放在一起（比方咱们能够创立一个对象池用于辅助接管网络包，一个用于辅助拼接字符串）：

func main() {joinPool := new(bytebufferpool.Pool)
  b := joinPool.Get()
  b.WriteString("hello")
  b.WriteByte(',')
  b.WriteString("world!")

  fmt.Println(b.String())

  joinPool.Put(b)
}

bytebufferpool没有提供具体的创立函数，不过能够应用 new 创立。

优化细节

在将对象放回池中时，会依据以后切片的容量进行相应的解决。bytebufferpool将大小分为 20 个区间：

| < 2^6 | 2^6 ~ 2^7-1 | … | > 2^25 |

如果容量小于 2^6，则属于第一个区间。如果处于 2^6 和 2^7-1 之间，则落在第二个区间。顺次类推。执行足够多的放回次数后，bytebufferpool会从新校准，计算处于哪个区间容量的对象最多。将 defaultSize 设置为该区间的下限容量，第一个区间的下限容量为 2^6，第二区间为 2^7，最初一个区间为 2^26。后续通过 Get() 申请对象时，若池中无闲暇对象，创立一个新对象时，间接将容量设置为defaultSize。这样根本能够防止在应用过程中的切片扩容，从而晋升性能。上面联合代码来了解：

// bytebufferpool/pool.go
const (
  minBitSize = 6 // 2**6=64 is a CPU cache line size
  steps      = 20

  minSize = 1 << minBitSize
  maxSize = 1 << (minBitSize + steps - 1)

  calibrateCallsThreshold = 42000
  maxPercentile           = 0.95
)

type Pool struct {calls       [steps]uint64
  calibrating uint64

  defaultSize uint64
  maxSize     uint64

  pool sync.Pool
}

咱们能够看到，bytebufferpool外部应用了规范库中的对象sync.Pool。

这里的 steps 就是下面所说的区间，一共 20 份。calls数组记录放回对象容量落在各个区间的次数。

调用 Pool.Get() 将对象放回时，首先计算切片容量落在哪个区间，减少 calls 数组中相应元素的值：

// bytebufferpool/pool.go
func (p *Pool) Put(b *ByteBuffer) {idx := index(len(b.B))

  if atomic.AddUint64(&p.calls[idx], 1) > calibrateCallsThreshold {p.calibrate()
  }

  maxSize := int(atomic.LoadUint64(&p.maxSize))
  if maxSize == 0 || cap(b.B) <= maxSize {b.Reset()
    p.pool.Put(b)
  }
}

如果 calls 数组该元素超过指定值 calibrateCallsThreshold=42000（阐明间隔上次校准，放回对象到该区间的次数曾经达到阈值了，42000 应该就是个教训数字），则调用Pool.calibrate() 执行校准操作：

// bytebufferpool/pool.go
func (p *Pool) calibrate() {
  // 防止并发放回对象触发 `calibrate`
  if !atomic.CompareAndSwapUint64(&p.calibrating, 0, 1) {return}

  // step 1. 统计并排序
  a := make(callSizes, 0, steps)
  var callsSum uint64
  for i := uint64(0); i < steps; i++ {calls := atomic.SwapUint64(&p.calls[i], 0)
    callsSum += calls
    a = append(a, callSize{
      calls: calls,
      size:  minSize << i,
    })
  }
  sort.Sort(a)

  // step 2. 计算 defaultSize 和 maxSize
  defaultSize := a[0].size
  maxSize := defaultSize

  maxSum := uint64(float64(callsSum) * maxPercentile)
  callsSum = 0
  for i := 0; i < steps; i++ {
    if callsSum > maxSum {break}
    callsSum += a[i].calls
    size := a[i].size
    if size > maxSize {maxSize = size}
  }

  // step 3. 保留对应值
  atomic.StoreUint64(&p.defaultSize, defaultSize)
  atomic.StoreUint64(&p.maxSize, maxSize)

  atomic.StoreUint64(&p.calibrating, 0)
}

step 1. 统计并排序

calls数组记录了放回对象到对应区间的次数。依照这个次数从大到小排序。留神：minSize << i示意区间 i 的下限容量。

step 2. 计算 defaultSize 和maxSize

defaultSize很好了解，取排序后的第一个 size 即可。maxSize值记录放回次数超过 95% 的多个对象容量的最大值。它的作用是避免将应用较少的大容量对象放回对象池，从而占用太多内存。这里就能够了解 Pool.Put() 办法后半局部的逻辑了：

// 如果要放回的对象容量大于 maxSize，则不放回
maxSize := int(atomic.LoadUint64(&p.maxSize))
if maxSize == 0 || cap(b.B) <= maxSize {b.Reset()
  p.pool.Put(b)
}

step 3. 保留对应值

后续通过 Pool.Get() 获取对象时，若池中无闲暇对象，新创建的对象默认容量为defaultSize。这样的容量能满足绝大多数状况下的应用，防止应用过程中的切片扩容。

// bytebufferpool/pool.go
func (p *Pool) Get() *ByteBuffer {v := p.pool.Get()
  if v != nil {return v.(*ByteBuffer)
  }
  return &ByteBuffer{B: make([]byte, 0, atomic.LoadUint64(&p.defaultSize)),
  }
}

其余一些细节：

• 容量最小值取 2^6 = 64，因为这就是 64 位计算机上 CPU 缓存行的大小。这个大小的数据能够一次性被加载到 CPU 缓存行中，再小就无意义了。
• 代码中屡次应用 atomic 原子操作，防止加锁导致性能损失。

当然这个库毛病也很显著，因为大部分应用的容量都小于defaultSize，会有局部内存节约。

总结

去掉正文，空行，bytebufferpool只用了 150 行左右的代码就实现了一个高性能的 Buffer 对象池。其中细节值得细细品味。浏览高质量的代码有助于晋升本人的编码能力，学习编码细节。强烈建议抽空细读！！！

大家如果发现好玩、好用的 Go 语言库，欢送到 Go 每日一库 GitHub 上提交 issue😄

参考

1. bytebufferpool GitHub：https://github.com/valyala/bytebufferpool
2. Go 每日一库 GitHub：https://github.com/darjun/go-daily-lib

我

我的博客：https://darjun.github.io

欢送关注我的微信公众号【GoUpUp】，独特学习，一起提高~