【Golang】singleflight 源码注释

在引入本地 cache 的场景下，缓存失效回源时会将请求打到后台数据库，在高并发时会带来性能和稳定性隐患。

singleflight 能够使多个并发请求所触发的回源操作里，只有第一个回源被执行，其余请求阻塞等待第一个被执行的那个回源操作完成后，直接取其结果，以此保证同一时刻只有一个回源操作在执行，以达到防止击穿的效果。

源码注释如下：

// Copyright 2013 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

// Package singleflight provides a duplicate function call suppression mechanism.
package singleflight

import "sync"

// call is an in-flight or completed singleflight.Do call
// call 代表一个正在执行或已完成的函数调用。
type call struct {

    wg sync.WaitGroup    // 用于阻塞调用这个 call 的其他请求

    // 这两个字段在 WaitGroup.Done() 之前被写入（仅写一次），并在 WaitGroup.Done() 之后被读取。
    val interface{} // 函数执行后的结果
    err error          // 函数执行后的error

    // These fields are read and written with the singleflight mutex held before the WaitGroup is done,  
    // and are read but not written after the WaitGroup is done.
    dups  int
    chans []chan<- Result
}


// Group represents a class of work and forms a namespace in 
// which units of work can be executed with duplicate suppression.
type Group struct {
    mu sync.Mutex       // 保护锁
    m  map[string]*call // 懒加载
}

// Result holds the results of Do, so they can be passed on a channel.
type Result struct {
    Val    interface{}
    Err    error
    Shared bool
}

// Do executes and returns the results of the given function, making
// sure that only one execution is in-flight for a given key at a
// time. If a duplicate comes in, the duplicate caller waits for the
// original to complete and receives the same results.
// The return value shared indicates whether v was given to multiple callers.

// 在 Do 函数中，函数先是判断这个 key 是否是第一次调用，如果是，就会进入 doCall 调用回调函数获取结果，
// 后续的请求就会阻塞在 c.wg.Wait() 这里，等待回调函数返回以后，直接拿到结果。
func (g *Group) Do(key string, fn func() (interface{}, error)) (v interface{}, err error, shared bool) {
    

    // 有可能要修改 g.m ，所以先上锁进行保护
    g.mu.Lock()
    
     // key-call 映射表不存在就创建（懒加载）
    if g.m == nil {
        g.m = make(map[string]*call)
    }

     // 如果 g.m 中已经存在对该 key 的请求，则新协程不会重复处理 key 的请求 ，所以释放锁，然后阻塞等待已存的 key 请求得到的结果。
    if c, ok := g.m[key]; ok {
        // 释放 mu 锁并 wait 在 wg 上，在 wg.wait() 返回后，把结果返回。
        c.dups++
        g.mu.Unlock()
        // 如果已存的 key 请求完成，阻塞状态会解除，wg.Wait() 返回
        c.wg.Wait()
        return c.val, c.err, true
    }


     // 如果没有在处理，则创建一个 call ，把 wg 加 1，把 call 存到 m 中表示已经有在请求了，然后释放锁
    c := new(call)
    c.wg.Add(1)
    g.m[key] = c
    g.mu.Unlock()

    // 执行真正的请求函数，得到对该 key 请求的结果
    g.doCall(c, key, fn)

    // 返回请求结果
    return c.val, c.err, c.dups > 0
}

// DoChan is like Do but returns a channel that will receive the
// results when they are ready. The second result is true if the function
// will eventually be called, false if it will not (because there is
// a pending request with this key).
func (g *Group) DoChan(key string, fn func() (interface{}, error)) (<-chan Result, bool) {
    ch := make(chan Result, 1)

    // 有可能要修改 g.m ，所以先上锁进行保护
    g.mu.Lock()
    // key-call 映射表不存在就创建（懒加载）
    if g.m == nil {
        g.m = make(map[string]*call)
    }
    // 如果 g.m 中已经存在对该 key 的请求，则新协程不会重复处理 key 的请求 ，所以释放锁，然后阻塞等待已存的 key 请求得到的结果。
    if c, ok := g.m[key]; ok {
        c.dups++
        c.chans = append(c.chans, ch) // 追加 chan 用来接收返回结果
        g.mu.Unlock()
        return ch, false
    }
    // 如果没有在处理，则创建一个 call ，把 wg 加 1，把 call 存到 m 中表示已经有在请求了，然后释放锁
    c := &call{chans: []chan<- Result{ch}}
    c.wg.Add(1)
    g.m[key] = c
    g.mu.Unlock()

    go g.doCall(c, key, fn)

    return ch, true
}

// doCall handles the single call for a key.
func (g *Group) doCall(c *call, key string, fn func() (interface{}, error)) {
    
    // 执行 fn，记录结果到 c.val, c.err 中
    c.val, c.err = fn()

    // 释放 wg，会唤醒外部的 wg.wait() 阻塞
    c.wg.Done()

    // 共享变量 g.m 的写保护
    g.mu.Lock()

    // 删除 key 
    delete(g.m, key)

    // 结果递送
    for _, ch := range c.chans {
        ch <- Result{c.val, c.err, c.dups > 0}

    g.mu.Unlock()
}

// ForgetUnshared tells the singleflight to forget about a key if it is not
// shared with any other goroutines. Future calls to Do for a forgotten key
// will call the function rather than waiting for an earlier call to complete.
// Returns whether the key was forgotten or unknown--that is, whether no
// other goroutines are waiting for the result.
func (g *Group) ForgetUnshared(key string) bool {
    g.mu.Lock()
    defer g.mu.Unlock()
    c, ok := g.m[key]
    if !ok {
        return true
    }
    if c.dups == 0 {
        delete(g.m, key)
        return true
    }
    return false
}