泛型版 singleflight：Go 中如何防止緩存擊穿？

大家好，我是 polarisxu。

并發(fā)是 Go 的優(yōu)勢(shì)，但并發(fā)也需要很好的進(jìn)行控制。標(biāo)準(zhǔn)庫(kù)中有 sync 包，經(jīng)常使用的功能有 sync.Mutex、sync.WaitGroup 等。其實(shí)，除了標(biāo)準(zhǔn)庫(kù)，還有一個(gè)官方的擴(kuò)展庫(kù)，也叫 sync，其中有一個(gè)子包：sync/singleflight，專(zhuān)門(mén)做并發(fā)控制，比如防止緩存擊穿。

01 從例子說(shuō)起

看一個(gè)模擬緩存的例子，有如下代碼：

package?main

import?(
?"errors"
?"flag"
?"log"
?"sync"
)

var?errorNotExist?=?errors.New("not?exist")

var?n?int

func?init()?{
?flag.IntVar(&n,?"n",?5,?"模擬的并發(fā)數(shù)，默認(rèn)?5")
}

func?main()?{
?flag.Parse()

?var?wg?sync.WaitGroup
?wg.Add(n)

?//?模擬并發(fā)訪(fǎng)問(wèn)
?for?i?:=?0;?i???go?func()?{
???defer?wg.Done()
???//?假設(shè)都獲取?id?=?1?這篇文章
???article?:=?fetchArticle(1)
???log.Println(article)
??}()
?}
?wg.Wait()
}

type?Article?struct?{
?ID??????int
?Content?string
}


func?fetchArticle(id?int)?*Article?{
?article?:=?findArticleFromCache(id)

?if?article?!=?nil?&&?article.ID?>?0?{
??return?article
?}

?return?findArticleFromDB(id)
}

var?(
?cache???=?make(map[int]*Article)
?rwmutex?sync.RWMutex
)

//?模擬從緩存獲取數(shù)據(jù)
func?findArticleFromCache(id?int)?*Article?{
?rwmutex.RLock()
?defer?rwmutex.RUnlock()
?return?cache[id]
}

//?模擬從數(shù)據(jù)庫(kù)中獲取數(shù)據(jù)
func?findArticleFromDB(id?int)?*Article?{
?log.Printf("SELECT?*?FROM?article?WHERE?id=%d",?id)
?article?:=?&Article{ID:?id,?Content:?"polarisxu"}
?rwmutex.Lock()
?defer?rwmutex.Unlock()
?cache[id]?=?article
?return?article
}

我們模擬 5 個(gè)用戶(hù)并發(fā)訪(fǎng)問(wèn)，同時(shí)獲取 ID=1 的文章，因?yàn)榫彺嬷胁淮嬖冢虼硕嫉胶蠖?DB 獲取具體數(shù)據(jù)。從運(yùn)行結(jié)果可以看出這一點(diǎn)：

$?go?run?main.go
2021/12/30?10:32:36?SELECT?*?FROM?article?WHERE?id=1
2021/12/30?10:32:36?SELECT?*?FROM?article?WHERE?id=1
2021/12/30?10:32:36?&{1?polarisxu}
2021/12/30?10:32:36?&{1?polarisxu}
2021/12/30?10:32:36?SELECT?*?FROM?article?WHERE?id=1
2021/12/30?10:32:36?&{1?polarisxu}
2021/12/30?10:32:36?SELECT?*?FROM?article?WHERE?id=1
2021/12/30?10:32:36?&{1?polarisxu}
2021/12/30?10:32:36?SELECT?*?FROM?article?WHERE?id=1
2021/12/30?10:32:36?&{1?polarisxu}

顯然這是我們不希望看到的。

02 使用 singleflight

官方的擴(kuò)展包 golang.org/x/sync 下面有一個(gè)子包 singleflight：

Package?singleflight?provides?a?duplicate?function?call?suppression?mechanism.

它用來(lái)抑制函數(shù)的重復(fù)調(diào)用，這正好符合上面的場(chǎng)景：希望從數(shù)據(jù)庫(kù)獲取數(shù)據(jù)的函數(shù)只調(diào)用一次。

將 fetchArticle 函數(shù)改成這樣：

var?g?singleflight.Group

func?fetchArticle(id?int)?*Article?{
?article?:=?findArticleFromCache(id)

?if?article?!=?nil?&&?article.ID?>?0?{
??return?article
?}

?v,?err,?shared?:=?g.Do(strconv.Itoa(id),?func()?(interface{},?error)?{
??return?findArticleFromDB(id),?nil
?})

??//?打印?shared，看看都什么值
?fmt.Println("shared===",?shared)

?if?err?!=?nil?{
??log.Println("singleflight?do?error:",?err)
??return?nil
?}

?return?v.(*Article)
}

singleflight.Group 是一個(gè)結(jié)構(gòu)體類(lèi)型，沒(méi)有導(dǎo)出任何字段，它代表一類(lèi)工作并形成一個(gè)命名空間，在該命名空間中可以抑制工作單元的重復(fù)執(zhí)行。

該類(lèi)型有三個(gè)方法，它們的功能見(jiàn)注釋?zhuān)?/p>

//?執(zhí)行并返回給定函數(shù)的結(jié)果，確保對(duì)于給定的鍵，fn 函數(shù)只會(huì)執(zhí)行一次。
//?如果有重復(fù)的進(jìn)來(lái)，重復(fù)的調(diào)用者會(huì)等待最原始的調(diào)用完成并收到相同的結(jié)果。
//?返回值 shared 指示是否將 v 提供給多個(gè)調(diào)用者。
//?返回值?v?是?fn?的執(zhí)行結(jié)果
//?返回值?err?是?fn?返回的?err
func?(g?*Group)?Do(key?string,?fn?func()?(interface{},?error))?(v?interface{},?err?error,?shared?bool)
//?和 Do 類(lèi)似，但返回一個(gè) channel（只能接收），用來(lái)接收結(jié)果。Result 是一個(gè)結(jié)構(gòu)體，有三個(gè)字段，即 Do 返回的那三個(gè)。
func?(g?*Group)?DoChan(key?string,?fn?func()?(interface{},?error))?<-chan?Result
func?(g?*Group)?Forget(key?string)

因此，改后的代碼，通過(guò) Group.Do，即使并發(fā)多次調(diào)用，findArticleFromDB 也只會(huì)執(zhí)行一次，并且這一次的結(jié)果會(huì)被并發(fā)多次執(zhí)行共享。

運(yùn)行后，結(jié)果如下：

$?go?run?main.go
2021/12/30?11:55:44?SELECT?*?FROM?article?WHERE?id=1
shared===?true
2021/12/30?11:55:44?&{1?polarisxu}
shared===?true
2021/12/30?11:55:44?&{1?polarisxu}
shared===?true
2021/12/30?11:55:44?&{1?polarisxu}
shared===?true
2021/12/30?11:55:44?&{1?polarisxu}
shared===?true
2021/12/30?11:55:44?&{1?polarisxu}

和預(yù)期一樣，findArticleFromDB 只執(zhí)行了一次，shared 的值也表示結(jié)果被多個(gè)調(diào)用者共享。

所以，使用 Go 后，再也不需要通過(guò)類(lèi)似 Redis 中的 SETNX 這樣的命令來(lái)實(shí)現(xiàn)類(lèi)似的功能了。

03 Forget 的用途

上面 Group 的方法中，有一個(gè)沒(méi)有給任何注釋?zhuān)?Forget。從名字猜到，用來(lái)忘掉什么，那具體什么意思呢？

通過(guò)上面的例子，我們知曉，通過(guò) Do，可以實(shí)現(xiàn)多個(gè)并發(fā)調(diào)用只執(zhí)行回調(diào)函數(shù)一次，并共享相同的結(jié)果。而 Forget 的作用是：

Forget tells the singleflight to forget about a key. Future calls to Do for this key will call the function rather than waiting for an earlier call to complete.

即告訴 singleflight 忘記一個(gè) key，未來(lái)對(duì)此 key 的 Do 調(diào)用將調(diào)用 fn 回調(diào)函數(shù)，而不是等待更早的調(diào)用完成，即相當(dāng)于廢棄 Do 原本的作用。

可以在上面例子中 Do 調(diào)用之前，調(diào)用 g.Forget，驗(yàn)證是否 Do 的調(diào)用都執(zhí)行 fn 函數(shù)即 findArticleFromDB 函數(shù)了。

04 泛型版本

細(xì)心的讀者可能會(huì)發(fā)現(xiàn)，Do 方法返回的 v 是 interface{}，在 fetchArticle 函數(shù)最后，我們做了類(lèi)型斷言：v.(*Article)。

既然 Go1.18 馬上要來(lái)了，有了泛型，可以有泛型版本的 singleflight，不需要做類(lèi)型斷言了。GitHub 已經(jīng)有人實(shí)現(xiàn)并開(kāi)源：https://github.com/marwan-at-work/singleflight。

改成這個(gè)泛型版本，要改以下幾處：

• 導(dǎo)入包 marwan.io/singleflight，而非 github.com/marwan-at-work/singleflight，同時(shí)移除 golang.org/x/sync/singleflight

• g 的聲明改為：var g singleflight.Group[*Article]

• Do 的調(diào)用，返回值由 interface{} 類(lèi)型改為：*Article：

  article,?err,?shared?:=?g.Do(strconv.Itoa(id),?func()?(*Article,?error)?{
  ??return?findArticleFromDB(id),?nil
  })
  

• 最后返回時(shí)，直接返回 article，不需要做類(lèi)型斷言

05 總結(jié)

singleflight 很常用，你在 pkg.go.dev 搜索 singleflight，發(fā)現(xiàn)有很多輪子：https://pkg.go.dev/search?q=singleflight，好些項(xiàng)目不是使用官方的 golang.org/x/sync/singleflight，而是自己實(shí)現(xiàn)一個(gè)，不過(guò)這些實(shí)現(xiàn)基本只實(shí)現(xiàn)了最常用的 Do 方法。感興趣的可以查看他們的實(shí)現(xiàn)。

下次項(xiàng)目中需要類(lèi)似功能，記得使用 singleflight 哦！