探秘Go并发利器：Singleflight深入剖析

2023-11-03 20:06:12

Singleflight简介

Singleflight是一个轻量级的并发控制库，用于处理共享数据访问的场景。它可以确保在多个并发请求同时访问共享数据时，只有一个请求会真正执行数据获取操作，其他请求都会等待该请求的返回结果。

Singleflight通过使用一个全局的map来存储共享数据。当一个并发请求首次访问共享数据时，Singleflight会检查map中是否已经存在该数据的副本。如果存在，则直接返回该副本；如果不存在，则创建一个新的goroutine来获取数据，并将该goroutine的结果存储在map中。后续的并发请求在访问共享数据时，都会直接从map中获取数据，而无需重新获取。

Singleflight的使用方法

Singleflight的使用非常简单，只需要导入singleflight包，并创建一个Singleflight实例即可。

import "github.com/golang/singleflight"

var sf = singleflight.Group{}

Singleflight实例创建后，就可以使用Do方法来获取共享数据。Do方法接收两个参数：key和f。key是共享数据的唯一标识，f是获取共享数据的函数。

data, err := sf.Do("key", func() (interface{}, error) {
    // 从数据库中获取数据
    return nil, nil
})

Do方法会先检查map中是否已经存在key对应的共享数据。如果存在，则直接返回该数据；如果不存在，则创建一个新的goroutine来获取数据，并将该goroutine的结果存储在map中。后续的并发请求在访问共享数据时，都会直接从map中获取数据，而无需重新获取。

Singleflight的源码解读

Singleflight的源码非常简洁，只有不到100行代码。下面我们将从源码层面来了解Singleflight是如何工作的。

Singleflight的核心数据结构是一个全局的map，用于存储共享数据。map的key是共享数据的唯一标识，map的value是一个*call结构体。

type call struct {
    wg sync.WaitGroup
    val interface{}
    err error
}

call结构体包含了一个sync.WaitGroup对象、一个interface{}类型的val字段和一个error类型的err字段。sync.WaitGroup对象用于等待goroutine完成数据获取操作，val字段存储获取到的数据，err字段存储获取数据时发生的错误。

Singleflight的Do方法首先会检查map中是否已经存在key对应的call结构体。如果存在，则直接返回该call结构体的val字段和err字段。如果不存在，则创建一个新的goroutine来获取数据，并将该goroutine的结果存储在map中。

func (g *Group) Do(key string, fn func() (interface{}, error)) (interface{}, error) {
    // 检查map中是否已经存在key对应的call结构体
    c, ok := g.mu.Load(key)
    if !ok {
        // 创建一个新的call结构体
        c = &call{
            wg: sync.WaitGroup{},
        }

        // 将call结构体存储在map中
        g.mu.Store(key, c)

        // 创建一个新的goroutine来获取数据
        go func() {
            defer c.wg.Done()

            // 获取数据
            c.val, c.err = fn()
        }()
    }

    // 等待goroutine完成数据获取操作
    c.wg.Wait()

    // 返回获取到的数据和错误
    return c.val, c.err
}