Go結(jié)合Redis用最簡單的方式實(shí)現(xiàn)分布式鎖
前言
在項(xiàng)目中我們經(jīng)常有需要使用分布式鎖的場景，而Redis是實(shí)現(xiàn)分布式鎖最常見的一種方式，并且我們也都希望能夠把代碼寫得簡單一點(diǎn)，所以今天我們盡量用最簡單的方式來實(shí)現(xiàn)。
下面的代碼使用go-redis客戶端和gofakeit，參考和引用了Redis官方文章
單Redis實(shí)例場景
如果熟悉Redis的命令，可能會馬上想到使用Redis的set if not exists操作來實(shí)現(xiàn)，并且現(xiàn)在標(biāo)準(zhǔn)的實(shí)現(xiàn)方式是SET resource_name my_random_value NX PX 30000這串命令，其中：
- resource_name表示要鎖定的資源
- NX表示如果不存在則設(shè)置
- PX 30000表示過期時(shí)間為30000毫秒，也就是30秒
- my_random_value這個(gè)值在所有的客戶端必須是唯一的，所有同一key的獲取者（競爭者）這個(gè)值都不能一樣。
value的值必須是隨機(jī)數(shù)主要是為了更安全的釋放鎖，釋放鎖的時(shí)候使用腳本告訴Redis:只有key存在并且存儲的值和我指定的值一樣才能告訴我刪除成功?？梢酝ㄟ^以下Lua腳本實(shí)現(xiàn)：
if redis.call("get",KEYS[1]) == ARGV[1] then
? ? return redis.call("del",KEYS[1])
else
? ? return 0
end舉個(gè)例子：客戶端A取得資源鎖，但是緊接著被一個(gè)其他操作阻塞了，當(dāng)客戶端A運(yùn)行完畢其他操作后要釋放鎖時(shí)，原來的鎖早已超時(shí)并且被Redis自動釋放，并且在這期間資源鎖又被客戶端B再次獲取到。
使用Lua腳本是因?yàn)榕袛嗪蛣h除是兩個(gè)操作，所以有可能A剛判斷完鎖就過期自動釋放了，然后B就獲取到了鎖，然后A又調(diào)用了Del，導(dǎo)致把B的鎖給釋放了。
加解鎖示例
package main
import (
? ?"context"
? ?"errors"
? ?"fmt"
? ?"github.com/brianvoe/gofakeit/v6"
? ?"github.com/go-redis/redis/v8"
? ?"sync"
? ?"time"
)
var client *redis.Client
const unlockScript = `
if redis.call("get",KEYS[1]) == ARGV[1] then
? ? return redis.call("del",KEYS[1])
else
? ? return 0
end`
func lottery(ctx context.Context) error {
? ?// 加鎖
? ?myRandomValue := gofakeit.UUID()
? ?resourceName := "resource_name"
? ?ok, err := client.SetNX(ctx, resourceName, myRandomValue, time.Second*30).Result()
? ?if err != nil {
? ? ? return err
? ?}
? ?if !ok {
? ? ? return errors.New("系統(tǒng)繁忙，請重試")
? ?}
? ?// 解鎖
? ?defer func() {
? ? ? script := redis.NewScript(unlockScript)
? ? ? script.Run(ctx, client, []string{resourceName}, myRandomValue)
? ?}()
? ?// 業(yè)務(wù)處理
? ?time.Sleep(time.Second)
? ?return nil
}
func main() {
? ?client = redis.NewClient(&redis.Options{
? ? ? Addr: "127.0.0.1:6379",
? ?})
? ?var wg sync.WaitGroup
? ?wg.Add(2)
? ?go func() {
? ? ? defer wg.Done()
? ? ? ctx, _ := context.WithTimeout(context.Background(), time.Second*3)
? ? ? err := lottery(ctx)
? ? ? if err != nil {
? ? ? ? ?fmt.Println(err)
? ? ? }
? ?}()
? ?go func() {
? ? ? defer wg.Done()
? ? ? ctx, _ := context.WithTimeout(context.Background(), time.Second*3)
? ? ? err := lottery(ctx)
? ? ? if err != nil {
? ? ? ? ?fmt.Println(err)
? ? ? }
? ?}()
? ?wg.Wait()
}我們先看lottery()函數(shù)，這里模擬一個(gè)抽獎操作，在進(jìn)入函數(shù)時(shí)，先使用SET resource_name my_random_value NX PX 30000加鎖，這里使用UUID作為隨機(jī)值，如果操作失敗，直接返回，讓用戶重試，如果成功在defer里面執(zhí)行解鎖邏輯，解鎖邏輯就是執(zhí)行前面說到得lua腳本，然后再進(jìn)行業(yè)務(wù)處理。
我們在main()函數(shù)里面執(zhí)行了兩個(gè)goroutine并發(fā)調(diào)用lottery()函數(shù)，其中有一個(gè)操作會因?yàn)槟貌坏芥i而直接失敗。
小結(jié)
- 生成隨機(jī)值
- 使用SET resource_name my_random_value NX PX 30000加鎖
- 如果加鎖失敗，直接返回
- defer添加解鎖邏輯，保證在函數(shù)退出的時(shí)候會執(zhí)行
- 執(zhí)行業(yè)務(wù)邏輯
多Redis實(shí)例場景
在單實(shí)例情況下，如果這個(gè)實(shí)例掛了，那么所有請求都會因?yàn)槟貌坏芥i而失敗，所以我們需要多個(gè)分布在不同機(jī)器上的Redis實(shí)例，并且拿到其中大多數(shù)節(jié)點(diǎn)的鎖才能加鎖成功，這也就是RedLock算法。它其實(shí)也是基于上面的單實(shí)例算法的，只是我們需要同時(shí)對多個(gè)Redis實(shí)例獲取鎖。
加解鎖示例
package main
import (
? ?"context"
? ?"errors"
? ?"fmt"
? ?"github.com/brianvoe/gofakeit/v6"
? ?"github.com/go-redis/redis/v8"
? ?"sync"
? ?"time"
)
var clients []*redis.Client
const unlockScript = `
if redis.call("get",KEYS[1]) == ARGV[1] then
? ? return redis.call("del",KEYS[1])
else
? ? return 0
end`
func lottery(ctx context.Context) error {
? ?// 加鎖
? ?myRandomValue := gofakeit.UUID()
? ?resourceName := "resource_name"
? ?var wg sync.WaitGroup
? ?wg.Add(len(clients))
? ?// 這里主要是確保不要加鎖太久，這樣會導(dǎo)致業(yè)務(wù)處理的時(shí)間變少
? ?lockCtx, _ := context.WithTimeout(ctx, time.Millisecond*5)
? ?// 成功獲得鎖的Redis實(shí)例的客戶端
? ?successClients := make(chan *redis.Client, len(clients))
? ?for _, client := range clients {
? ? ? go func(client *redis.Client) {
? ? ? ? ?defer wg.Done()
? ? ? ? ?ok, err := client.SetNX(lockCtx, resourceName, myRandomValue, time.Second*30).Result()
? ? ? ? ?if err != nil {
? ? ? ? ? ? return
? ? ? ? ?}
? ? ? ? ?if !ok {
? ? ? ? ? ? return
? ? ? ? ?}
? ? ? ? ?successClients <- client
? ? ? }(client)
? ?}
? ?wg.Wait() // 等待所有獲取鎖操作完成
? ?close(successClients)
? ?// 解鎖，不管加鎖是否成功，最后都要把已經(jīng)獲得的鎖給釋放掉
? ?defer func() {
? ? ? script := redis.NewScript(unlockScript)
? ? ? for client := range successClients {
? ? ? ? ?go func(client *redis.Client) {
? ? ? ? ? ? script.Run(ctx, client, []string{resourceName}, myRandomValue)
? ? ? ? ?}(client)
? ? ? }
? ?}()
? ?// 如果成功加鎖得客戶端少于客戶端數(shù)量的一半+1，表示加鎖失敗
? ?if len(successClients) < len(clients)/2+1 {
? ? ? return errors.New("系統(tǒng)繁忙，請重試")
? ?}
? ?// 業(yè)務(wù)處理
? ?time.Sleep(time.Second)
? ?return nil
}
func main() {
? ?clients = append(clients, redis.NewClient(&redis.Options{
? ? ? Addr: "127.0.0.1:6379",
? ? ? DB: ? 0,
? ?}), redis.NewClient(&redis.Options{
? ? ? Addr: "127.0.0.1:6379",
? ? ? DB: ? 1,
? ?}), redis.NewClient(&redis.Options{
? ? ? Addr: "127.0.0.1:6379",
? ? ? DB: ? 2,
? ?}), redis.NewClient(&redis.Options{
? ? ? Addr: "127.0.0.1:6379",
? ? ? DB: ? 3,
? ?}), redis.NewClient(&redis.Options{
? ? ? Addr: "127.0.0.1:6379",
? ? ? DB: ? 4,
? ?}))
? ?var wg sync.WaitGroup
? ?wg.Add(2)
? ?go func() {
? ? ? defer wg.Done()
? ? ? ctx, _ := context.WithTimeout(context.Background(), time.Second*3)
? ? ? err := lottery(ctx)
? ? ? if err != nil {
? ? ? ? ?fmt.Println(err)
? ? ? }
? ?}()
? ?go func() {
? ? ? defer wg.Done()
? ? ? ctx, _ := context.WithTimeout(context.Background(), time.Second*3)
? ? ? err := lottery(ctx)
? ? ? if err != nil {
? ? ? ? ?fmt.Println(err)
? ? ? }
? ?}()
? ?wg.Wait()
? ?time.Sleep(time.Second)?
}在上面的代碼中，我們使用Redis的多數(shù)據(jù)庫模擬多個(gè)Redis master實(shí)例，一般我們會選擇5個(gè)Redis實(shí)例，真實(shí)環(huán)境中這些實(shí)例應(yīng)該是分布在不同機(jī)器上的，避免同時(shí)失效。
在加鎖邏輯里，我們主要是對每個(gè)Redis實(shí)例執(zhí)行SET resource_name my_random_value NX PX 30000獲取鎖，然后把成功獲取鎖的客戶端放到一個(gè)channel里（這里使用slice可能有并發(fā)問題），同時(shí)使用sync.WaitGroup等待所以獲取鎖操作結(jié)束。
然后添加defer釋放鎖邏輯，釋放鎖邏輯很簡單，只是把成功拿到的鎖給釋放掉即可。
最后判斷成功獲取到的鎖的數(shù)量是否大于一半，如果沒有得到一半以上的鎖，說明加鎖失敗。
如果加鎖成功接下來就是進(jìn)行業(yè)務(wù)處理。
小結(jié)
- 生成隨機(jī)值
- 并發(fā)給每個(gè)Redis實(shí)例使用
SET resource_name my_random_value NX PX 30000加鎖 - 等待所有獲取鎖操作完成
- defer添加解鎖邏輯，保證在函數(shù)退出的時(shí)候會執(zhí)行，這里先defer再判斷是因?yàn)橛锌赡塬@取到一部分Redis實(shí)例的鎖，但是因?yàn)闆]有超過一半，還是會判斷為加鎖失敗
- 判斷是否拿到一半以上Redis實(shí)例的鎖，如果沒有說明加鎖失敗，直接返回
- 執(zhí)行業(yè)務(wù)邏輯
總結(jié)
通過使用Go的goroutine、channel、context、sync.WaitGroup等功能可以很容易的實(shí)現(xiàn)RedLock（30多行代碼）
可以把加解鎖操作封裝成函數(shù)，這樣就不會在業(yè)務(wù)代碼里參雜太多加解鎖的邏輯
到此這篇關(guān)于Go+Redis用最簡單的方式實(shí)現(xiàn)分布式鎖的文章就介紹到這了,更多相關(guān)Go Redis分布式鎖內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
golang結(jié)構(gòu)化日志log/slog包之slog.Record的用法簡介
這篇文章主要為大家詳細(xì)介紹了golang結(jié)構(gòu)化日志log/slog包中slog.Record結(jié)構(gòu)體的使用方法和需要注意的點(diǎn),文中的示例代碼講解詳細(xì),需要的可以學(xué)習(xí)一下2023-10-10
這篇文章主要介紹了Golang內(nèi)存管理的棧空間管理，文章通過代碼示例介紹的非常詳細(xì)，對我們學(xué)習(xí)Golang內(nèi)存管理有一定的幫助，需要的朋友跟著小編一起來學(xué)習(xí)吧2023-06-06
本文主要介紹了安裝Sublime?Text支持Go插件的方法步驟，文中通過示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2022-01-01
這篇文章主要介紹了go中panic源碼解讀,本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2021-04-04
Golang設(shè)計(jì)模式之外觀模式的實(shí)現(xiàn)
這篇文章主要介紹了Golang設(shè)計(jì)模式之外觀模式的實(shí)現(xiàn)，外觀模式是一種常用的設(shè)計(jì)模式之一，是一種結(jié)構(gòu)型設(shè)計(jì)模式，它提供了一個(gè)簡單的接口來訪問復(fù)雜系統(tǒng)的各種功能，從而降低了系統(tǒng)的復(fù)雜度，需要詳細(xì)了解可以參考下文2023-05-05
本文主要介紹了Golang 按行讀取文件的三種方法小結(jié),文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-04-04
這篇文章主要為大家介紹了Golang語言的跨平臺UI工具包fyne使用詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-12-12
這篇文章主要介紹了Go?中的空白標(biāo)識符下劃線，空白標(biāo)識符是未使用的值的占位符，由下劃線（_）表示，下文對其相關(guān)介紹需要的小伙伴可以參考一下2022-03-03
這篇文章主要為大家介紹了golang的tunny的用法示例教程，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2023-07-07
Golang實(shí)現(xiàn)加權(quán)輪詢負(fù)載均衡算法
加權(quán)輪詢負(fù)載均衡算法是一種常見的負(fù)載均衡策略,本文主要介紹了Golang實(shí)現(xiàn)加權(quán)輪詢負(fù)載均衡算法,具有一定的參考價(jià)值,感興趣的可以了解一下2024-08-08