> For the complete documentation index, see [llms.txt](https://deepingo.run-linux.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://deepingo.run-linux.com/conc/pool.md).

# Pool 临时对象池

sync.Pool类型可以被称为临时对象池，它的值可以被用来存储临时的对象。与 Go 语言的很多同步工具一样，sync.Pool类型也属于结构体类型，它的值在被真正使用之后，就不应该再被复制了。

这里的“临时对象”的意思是：**不需要持久使用的某一类值**。这类值对于程序来说可有可无，但如果有的话会明显更好。**它们的创建和销毁可以在任何时候发生，并且完全不会影响到程序的功能**。

同时，它们也应该是无需被区分的，其中的**任何一个值都可以代替另一个**。如果你的某类值完全满足上述条件，那么你就可以把它们存储到临时对象池中。

我们可以把临时对象池当作针对某种数据的缓存来用。实际上，在我看来，临时对象池最主要的用途就在于此。

sync.Pool类型只有两个方法——Put和Get。**Put 用于在当前的池中存放临时对象，它接受一个interface{}类型的参数**；而 **Get 则被用于从当前的池中获取临时对象，它会返回一个interface{}类型的值。**

更具体地说，**这个类型的Get方法可能会从当前的池中删除掉任何一个值，然后把这个值作为结果返回**。**如果此时当前的池中没有任何值，那么这个方法就会使用当前池的New字段创建一个新值，并直接将其返回**。

sync.Pool类型的**New字段代表着创建临时对象的函数**。**它的类型是没有参数但有唯一结果的函数类型**，即：func() interface{}。

这个函数是**Get方法最后的临时对象获取手段**。**Get方法如果到了最后，仍然无法获取到一个值，那么就会调用该函数。**该函数的**结果值并不会被存入当前的临时对象池中，而是直接返回给Get方法的调用方。**

这里的New字段的实际值需要我们在初始化临时对象池的时候就给定。否则，在我们调用它的Get方法的时候就有可能会得到nil。所以，**sync.Pool类型并不是开箱即用的。不过，这个类型也就只有这么一个公开的字段，因此初始化起来也并不麻烦。**

`Get`方法会把返回的对象从池子里面删除。所以用完了的对象，还是得重新放回池子。

举个例子。标准库代码包fmt就使用到了sync.Pool类型。这个包会创建一个用于缓存某类临时对象的sync.Pool类型值，并将这个值赋给一个名为ppFree的变量。这类临时对象可以识别、格式化和暂存需要打印的内容。

```go
var ppFree = sync.Pool{
 New: func() interface{} { return new(pp) },
}
```

临时对象池ppFree的New字段在被调用的时候，总是会返回一个全新的pp类型值的指针（即临时对象）。这就保证了ppFree的Get方法总能返回一个可以包含需要打印内容的值。

pp类型是fmt包中的私有类型，它有很多实现了不同功能的方法。不过，这里的重点是，它的每一个值都是独立的、平等的和可重用的。

更具体地说，这些对象既互不干扰，又不会受到外部状态的影响。**它们几乎只针对某个需要打印内容的缓冲区而已**。由于fmt包中的代码在**真正使用这些临时对象之前，总是会先对其进行重置**，所以它们并不在意取到的是哪一个临时对象。这就是临时对象的平等性的具体体现。

另外，**这些代码在使用完临时对象之后，都会先抹掉其中已缓冲的内容，然后再把它存放到ppFree中。这样就为重用这类临时对象做好了准备。**

众所周知的fmt.Println、fmt.Printf等打印函数都是如此使用ppFree，以及其中的临时对象的。因此，在程序同时执行很多的打印函数调用的时候，**ppFree可以及时地把它缓存的临时对象提供给它们，以加快执行的速度**。

当程序在一段时间内不再执行打印函数调用时，**ppFree中的临时对象又能够被及时地清理掉，以节省内存空间。**

在这个维度上，临时对象池可以帮助程序实现可伸缩性。这就是它的最大价值。

由于Go 语言运行时系统中的垃圾回收器，在每次开始执行之前，都会对所有已创建的临时对象池中的值进行全面地清除。

sync包在被初始化的时候，会向 Go 语言运行时系统注册一个函数，这个函数的功能就是清除所有已创建的临时对象池中的值。我们可以把它称为池清理函数。

一旦池清理函数被注册到了 Go 语言运行时系统，Go 语言运行时系统在每次即将执行垃圾回收时就都会执行池清理函数。

在sync包中还有一个包级私有的全局变量。这个**变量代表了当前的程序中使用的所有临时对象池的汇总**，**它是元素类型为\*sync.Pool的切片。我们可以称之为池汇总列表。**

在一个临时对象池的Put方法或Get方法第一次被调用的时候，**这个池就会被添加到池汇总列表中。正因为如此，池清理函数总是能访问到所有正在被真正使用的临时对象池。**

更具体地说，**池清理函数会遍历池汇总列表**。**对于其中的每一个临时对象池，它都会先将池中所有的私有临时对象和共享临时对象列表都置为nil，然后再把这个池中的所有本地池列表都销毁掉。**

池清理函数会把池汇总列表重置为空的切片。如此一来，这些池中存储的临时对象就全部被清除干净了。

如果临时对象池以外的代码再无对它们的引用，那么在稍后的垃圾回收过程中，这些临时对象就会被当作垃圾销毁掉，它们占用的内存空间也会被回收以备他用。

## 临时对象池存储值所用的数据结构

在临时对象池中，有一个多层的数据结构。

正因为有了它的存在，临时对象池才能够非常高效地存储大量的值。

这个数据结构的顶层，我们可以称之为本地池列表，不过更确切地说，它是一个数组。

这个列表的长度，总是与 Go 语言调度器中的 P 的数量相同。

Go 语言调度器中的 P 是 processor 的缩写，它指的是一种可以承载若干个 G、且能够使这些 G 适时地与 M 进行对接，并得到真正运行的中介。

G 正是 goroutine 的缩写，而 M 则是 machine 的缩写，后者指代的是系统级的线程。正因为有了 P 的存在，G 和 M 才能够进行灵活、高效的配对，从而实现强大的并发编程模型。

P 存在的一个很重要的原因是**为了分散并发程序的执行压力**，而让**临时对象池中的本地池列表的长度与 P 的数量相同的主要原因也是分散压力**。这里所说的**压力包括了存储和性能两个方面**。在说明它们之前，我们先来探索一下临时对象池中的那个数据结构。

在本地池列表中的每个本地池都包含了三个字段（或者说组件），它们是：**存储私有临时对象的字段private**、代表了**共享临时对象列表的字段shared**，以及**一个sync.Mutex类型的嵌入字段**。

![825cae64e0a879faba34c0a157b7ca22](https://static001.geekbang.org/resource/image/82/22/825cae64e0a879faba34c0a157b7ca22.png)

## sync.Pool 中的本地池与各个 G 的对应关系

实际上，每个本地池都对应着一个 P。我们都知道，一个 goroutine 要想真正运行就必须先与某个 P 产生关联。也就是说，**一个正在运行的 goroutine 必然会关联着某个 P。**

在程序调用临时对象池的Put方法或Get方法的时候，**总会先试图从该临时对象池的本地池列表中，获取与之对应的本地池，依据的就是与当前的 goroutine 关联的那个 P 的 ID。**

一个临时对象池的Put方法或Get方法会获取到哪一个本地池，完全取决于调用它的代码所在的 goroutine 关联的那个 P。

## 临时对象池利用内部数据结构存取值

临时对象池的Put方法总会先试图把新的临时对象，存储到对应的本地池的private字段中，以便在后面获取临时对象的时候，可以快速地拿到一个可用的值。

**只有当这个private字段已经存有某个值时，该方法才会去访问本地池的shared字段。**

相应的，临时对象池的Get方法，**总会先试图从对应的本地池的private字段处获取一个临时对象**。**只有当这个private字段的值为nil时，它才会去访问本地池的shared字段。**

**一个本地池的shared字段原则上可以被任何 goroutine 中的代码访问到，不论这个 goroutine 关联的是哪一个 P。这也是我把它叫做共享临时对象列表的原因。**

一个本地池的private字段，**只可能被与之对应的那个 P 所关联的 goroutine 中的代码访问到，所以可以说，它是 P 级私有的。**

以临时对象池的Put方法为例，**它一旦发现对应的本地池的private字段已存有值，就会去访问这个本地池的shared字段。当然，由于shared字段是共享的，所以此时必须受到互斥锁的保护。**

本地池本身就拥有互斥锁的功能。P**ut方法会在互斥锁的保护下，把新的临时对象追加到共享临时对象列表的末尾。**

相应的，**临时对象池的Get方法在发现对应本地池的private字段未存有值时，也会去访问后者的shared字段。它会在互斥锁的保护下，试图把该共享临时对象列表中的最后一个元素值取出并作为结果。**

不过，这里的共享临时对象列表也可能是空的，这可能是由于这个本地池中的所有临时对象都已经被取走了，也可能是当前的临时对象池刚被清理过。

无论原因是什么，Get方法都会去访问当前的临时对象池中的所有本地池，它会去逐个搜索它们的共享临时对象列表。只要发现某个共享临时对象列表中包含元素值，它就会把该列表的最后一个元素值取出并作为结果返回。

![df956fe29f35b41a14f941a9efd80d21](https://static001.geekbang.org/resource/image/df/21/df956fe29f35b41a14f941a9efd80d21.png)

即使这样也可能无法拿到一个可用的临时对象，比如，在所有的临时对象池都刚被大清洗的情况下就会是如此。

这时，Get方法就会使出最后的手段——调用可创建临时对象的那个函数。

```go
package main

import(
    "fmt"
    "sync"
)

func main() {
    p := &sync.Pool{
        New: func() interface{} {
            return 0
        },
    }

    a := p.Get().(int)
    a = 1
    p.Put(a)
    b := p.Get().(int)
    fmt.Println(a, b)
}
```