Golang源碼分析之golang/sync之singleflight

func main() {
   var flight singleflight.Group
   var errGroup errgroup.Group

   // 模擬並發獲取數據緩存
   for i := 0; i < 10; i++ {
      i := i
      errGroup.Go(func() error {
         fmt.Printf("協程%v準備獲取緩存\n", i)
         v, err, shared := flight.Do("getCache", func() (interface{}, error) {
            // 模擬獲取緩存操作
            fmt.Printf("協程%v正在讀數據庫獲取緩存\n", i)
            time.Sleep(100 * time.Millisecond)
            fmt.Printf("協程%v讀取數據庫生成緩存成功\n", i)
            return "mockCache", nil
         })
         if err != nil {
            fmt.Printf("err = %v", err)
            return err
         }
         fmt.Printf("協程%v獲取緩存成功, v = %v, shared = %v\n", i, v, shared)
         return nil
      })
   }
   if err := errGroup.Wait(); err != nil {
      fmt.Printf("errGroup wait err = %v", err)
   }
}
// 輸出：隻有0號協程實際生成瞭緩存，其餘協程讀取生成的結果
協程0準備獲取緩存
協程4準備獲取緩存
協程3準備獲取緩存
協程2準備獲取緩存
協程6準備獲取緩存
協程5準備獲取緩存
協程7準備獲取緩存
協程1準備獲取緩存
協程8準備獲取緩存
協程9準備獲取緩存
協程0正在讀數據庫獲取緩存
協程0讀取數據庫生成緩存成功
協程0獲取緩存成功, v = mockCache, shared = true
協程8獲取緩存成功, v = mockCache, shared = true
協程2獲取緩存成功, v = mockCache, shared = true
協程6獲取緩存成功, v = mockCache, shared = true
協程5獲取緩存成功, v = mockCache, shared = true
協程7獲取緩存成功, v = mockCache, shared = true
協程9獲取緩存成功, v = mockCache, shared = true
協程1獲取緩存成功, v = mockCache, shared = true
協程4獲取緩存成功, v = mockCache, shared = true
協程3獲取緩存成功, v = mockCache, shared = true

func testDoChan() {
   var flight singleflight.Group
   var errGroup errgroup.Group

   // 模擬並發獲取數據緩存
   for i := 0; i < 10; i++ {
      i := i
      errGroup.Go(func() error {
         fmt.Printf("協程%v準備獲取緩存\n", i)
         ch := flight.DoChan("getCache", func() (interface{}, error) {
            // 模擬獲取緩存操作
            fmt.Printf("協程%v正在讀數據庫獲取緩存\n", i)
            time.Sleep(100 * time.Millisecond)
            fmt.Printf("協程%v讀取數據庫獲取緩存成功\n", i)
            return "mockCache", nil
         })
         res := <-ch
         if res.Err != nil {
            fmt.Printf("err = %v", res.Err)
            return res.Err
         }
         fmt.Printf("協程%v獲取緩存成功, v = %v, shared = %v\n", i, res.Val, res.Shared)
         return nil
      })
   }
   if err := errGroup.Wait(); err != nil {
      fmt.Printf("errGroup wait err = %v", err)
   }
}
// 輸出結果
協程9準備獲取緩存
協程0準備獲取緩存
協程1準備獲取緩存
協程6準備獲取緩存
協程5準備獲取緩存
協程2準備獲取緩存
協程7準備獲取緩存
協程8準備獲取緩存
協程4準備獲取緩存
協程9正在讀數據庫獲取緩存
協程9讀取數據庫獲取緩存成功
協程3準備獲取緩存
協程3獲取緩存成功, v = mockCache, shared = true
協程8獲取緩存成功, v = mockCache, shared = true
協程0獲取緩存成功, v = mockCache, shared = true
協程1獲取緩存成功, v = mockCache, shared = true
協程6獲取緩存成功, v = mockCache, shared = true
協程5獲取緩存成功, v = mockCache, shared = true
協程2獲取緩存成功, v = mockCache, shared = true
協程7獲取緩存成功, v = mockCache, shared = true
協程4獲取緩存成功, v = mockCache, shared = true
協程9獲取緩存成功, v = mockCache, shared = true

// singleflight.Group
type Group struct {
   mu sync.Mutex       // map的鎖
   m  map[string]*call // 保存每個key的調用
}

// 一次Do對應的響應結果
type Result struct {
   Val    interface{}
   Err    error
   Shared bool
}

// 一個key會對應一個call
type call struct {
   wg sync.WaitGroup
   val interface{} // 保存調用的結果
   err error       // 調用出現的err
   // 該call被調用的次數
   dups  int
   // 每次DoChan時都會追加一個chan在該列表
   chans []chan<- Result
}

func (g *Group) Do(key string, fn func() (interface{}, error)) (v interface{}, err error, shared bool) {
   g.mu.Lock()
   if g.m == nil {
      // 第一次執行Do的時候創建map
      g.m = make(map[string]*call)
   }
   // 已經存在該key，對應後續的並發調用
   if c, ok := g.m[key]; ok {
      // 執行次數自增
      c.dups++
      g.mu.Unlock()
      // 等待執行fn的協程完成
      c.wg.Wait()
      // ...
      // 返回執行結果
      return c.val, c.err, true
   }
   
   // 不存在該key，說明第一次調用，初始化一個call
   c := new(call)
   // wg添加1，後續其他協程在該wg上阻塞
   c.wg.Add(1)
   // 保存key和call的關系
   g.m[key] = c
   g.mu.Unlock()
   // 真正執行fn函數
   g.doCall(c, key, fn)
   return c.val, c.err, c.dups > 0
}

func (g *Group) doCall(c *call, key string, fn func() (interface{}, error)) {
   normalReturn := false
   recovered := false

   // 第三步、最後的設置和清理工作
   defer func() {
      // ...
      g.mu.Lock()
      defer g.mu.Unlock()
      // 執行完成，調用wg.Done，其他協程此時不再阻塞，讀到fn執行結果
      c.wg.Done()
      // 二次校驗map中key的值是否為當前call，並刪除該key
      if g.m[key] == c {
         delete(g.m, key)
      }
      // ...
      // 如果c.chans存在，則遍歷並寫入執行結果
      for _, ch := range c.chans {
          ch <- Result{c.val, c.err, c.dups > 0}
        }
      }
   }()

   // 第一步、執行fn獲取結果
   func() {
      // 3、如果fn執行過程中panic，將c.err設置為PanicError
      defer func() {
         if !normalReturn {
            if r := recover(); r != nil {
               c.err = newPanicError(r)
            }
         }
      }()
      // 1、執行fn，獲取到執行結果
      c.val, c.err = fn()
      // 2、設置正常返回結果標識
      normalReturn = true
   }()

   // 第二步、fn執行出錯，將recovered標識設置為true
   if !normalReturn {
      recovered = true
   }
}

func (g *Group) DoChan(key string, fn func() (interface{}, error)) <-chan Result {
   // 一次調用對應一個chan
   ch := make(chan Result, 1)
   g.mu.Lock()
   if g.m == nil {
      // 第一次調用，初始化map
      g.m = make(map[string]*call)
   }
   // 後續調用，已存在key
   if c, ok := g.m[key]; ok {
      // 調用次數自增
      c.dups++
      // 將chan添加到chans列表
      c.chans = append(c.chans, ch)
      g.mu.Unlock()
      // 直接返回chan，不等待fn執行完成
      return ch
   }

   // 第一次調用，初始化call及chans列表
   c := &call{chans: []chan<- Result{ch}}
   // wg加一
   c.wg.Add(1)
   // 保存key及call的關系
   g.m[key] = c
   g.mu.Unlock()

   // 異步執行fn函數
   go g.doCall(c, key, fn)

   // 直接返回該chan
   return ch
}