快捷導(dǎo)航

SingleFlight模式的Go并發(fā)編程學(xué)習(xí)

更新時間：2022年04月26日 11:44:50 作者：kevwan

這篇文章主要為大家介紹了SingleFlight模式的Go并發(fā)編程學(xué)習(xí)，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

應(yīng)用場景

查詢緩存時，合并請求，提升服務(wù)性能。假設(shè)有一個 IP 查詢的服務(wù)，每次用戶請求先在緩存中查詢一個 IP 的歸屬地，如果緩存中有結(jié)果則直接返回，不存在則進(jìn)行 IP 解析操作。

如上圖所示，n 個用戶請求查詢同一個 IP（8.8.8.8）就會對應(yīng) n 個 Redis 的查詢，在高并發(fā)場景下，如果能將 n 個 Redis 查詢合并成一個 Redis 查詢，那么性能肯定會提升很多，而 SingleFlight就是用來實現(xiàn)請求合并的，效果如下：

防止緩存擊穿。

緩存擊穿問題是指：在高并發(fā)的場景中，大量的請求同時查詢一個 key ，如果這個 key 正好過期失效了，就會導(dǎo)致大量的請求都打到數(shù)據(jù)庫，導(dǎo)致數(shù)據(jù)庫的連接增多，負(fù)載上升。

通過SingleFlight可以將對同一個Key的并發(fā)請求進(jìn)行合并，只讓其中一個請求到數(shù)據(jù)庫進(jìn)行查詢，其他請求共享同一個結(jié)果，可以很大程度提升并發(fā)能力。

應(yīng)用方式

直接上代碼：

func main() {
  round := 10
  var wg sync.WaitGroup
  barrier := syncx.NewSingleFlight()
  wg.Add(round)
  for i := 0; i < round; i++ {
    go func() {
      defer wg.Done()
      // 啟用10個協(xié)程模擬獲取緩存操作
      val, err := barrier.Do("get_rand_int", func() (interface{}, error) {
        time.Sleep(time.Second)
        return rand.Int(), nil
      })
      if err != nil {
        fmt.Println(err)
      } else {
        fmt.Println(val)
      }
    }()
  }
  wg.Wait()
}

以上代碼，模擬 10 個協(xié)程請求 Redis 獲取一個 key 的內(nèi)容，代碼很簡單，就是執(zhí)行Do()方法。其中，接收兩個參數(shù)，第一個參數(shù)是獲取資源的標(biāo)識，可以是 redis 中緩存的 key，第二個參數(shù)就是一個匿名函數(shù)，封裝好要做的業(yè)務(wù)邏輯。最終獲得的結(jié)果如下：

5577006791947779410
5577006791947779410
5577006791947779410
5577006791947779410
5577006791947779410
5577006791947779410
5577006791947779410
5577006791947779410
5577006791947779410
5577006791947779410

從上看出，10個協(xié)程都獲得了同一個結(jié)果，也就是只有一個協(xié)程真正執(zhí)行了rand.Int()獲取了隨機(jī)數(shù)，其他的協(xié)程都共享了這個結(jié)果。

源碼解析

先看代碼結(jié)構(gòu)：

type (
  // 定義接口，有2個方法 Do 和 DoEx，其實邏輯是一樣的，DoEx 多了一個標(biāo)識，主要看Do的邏輯就夠了
  SingleFlight interface {
    Do(key string, fn func() (interface{}, error)) (interface{}, error)
    DoEx(key string, fn func() (interface{}, error)) (interface{}, bool, error)
  }
  // 定義 call 的結(jié)構(gòu)
  call struct {
    wg  sync.WaitGroup // 用于實現(xiàn)通過1個 call，其他 call 阻塞
    val interface{}    // 表示 call 操作的返回結(jié)果
    err error          // 表示 call 操作發(fā)生的錯誤
  }
  // 總控結(jié)構(gòu)，實現(xiàn) SingleFlight 接口
  flightGroup struct {
    calls map[string]*call // 不同的 call 對應(yīng)不同的 key
    lock  sync.Mutex       // 利用鎖控制請求
  }
)

然后看最核心的Do方法做了什么事情：

func (g *flightGroup) Do(key string, fn func() (interface{}, error)) (interface{}, error) {
  c, done := g.createCall(key)
  if done {
    return c.val, c.err
  }
  g.makeCall(c, key, fn)
  return c.val, c.err
}

代碼很簡潔，利用g.createCall(key)對 key 發(fā)起 call 請求（其實就是做一件事情），如果此時已經(jīng)有其他協(xié)程已經(jīng)在發(fā)起 call 請求就阻塞住（done 為 true 的情況），等待拿到結(jié)果后直接返回。如果 done 是 false，說明當(dāng)前協(xié)程是第一個發(fā)起 call 的協(xié)程，那么就執(zhí)行g.makeCall(c, key, fn)真正地發(fā)起 call 請求（此后的其他協(xié)程就阻塞在了g.createCall(key))。

從上圖可知，其實關(guān)鍵就兩步：

判斷是第一個請求的協(xié)程（利用map）
阻塞住其他所有協(xié)程（利用 sync.WaitGroup）

來看下g.createCall(key)如何實現(xiàn)的：

func (g *flightGroup) createCall(key string) (c *call, done bool) {
  g.lock.Lock()
  if c, ok := g.calls[key]; ok {
    g.lock.Unlock()
    c.wg.Wait()
    return c, true
  }
  c = new(call)
  c.wg.Add(1)
  g.calls[key] = c
  g.lock.Unlock()
  return c, false
}

先看第一步：判斷是第一個請求的協(xié)程（利用map）

g.lock.Lock()
if c, ok := g.calls[key]; ok {
  g.lock.Unlock()
  c.wg.Wait()
  return c, true
}

此處判斷 map 中的 key 是否存在，如果已經(jīng)存在，說明已經(jīng)有其他協(xié)程在請求了，當(dāng)前這個協(xié)程只需要等待，等待是利用了sync.WaitGroup的Wait()方法實現(xiàn)的，此處還是很巧妙的。要注意的是，map 在 Go 中是非并發(fā)安全的，所以需要加鎖。

再看第二步：阻塞住其他所有協(xié)程（利用 sync.WaitGroup）

c = new(call)
c.wg.Add(1)
g.calls[key] = c

因為是第一個發(fā)起 call 的協(xié)程，所以需要 new 這個 call，然后將wg.Add(1)，這樣就對應(yīng)了上面的wg.Wait()，阻塞剩下的協(xié)程。隨后將 new 的 call 放入 map 中，注意此時只是完成了初始化，并沒有真正去執(zhí)行call請求，真正的處理邏輯在 g.makeCall(c, key, fn)中。

func (g *flightGroup) makeCall(c *call, key string, fn func() (interface{}, error)) {
  defer func() {
    g.lock.Lock()
    delete(g.calls, key)
    g.lock.Unlock()
    c.wg.Done()
  }()
  c.val, c.err = fn()
}

這個方法中做的事情很簡單，就是執(zhí)行了傳遞的匿名函數(shù)fn()（也就是真正call請求要做的事情）。最后處理收尾的事情（通過defer），也是分成兩步：