用 Go + Redis 實現陪玩平臺原始碼中的分散式鎖

為什麼需要分散式鎖

分散式鎖需要具備特性

實現 Redis 鎖應先掌握哪些知識點

• EXsecond ：設定鍵的過期時間為 second 秒。SET key value EX second 效果等同於 SETEX key second value 。
• PXmillisecond ：設定鍵的過期時間為 millisecond 毫秒。SET key value PX millisecond效果等同於 PSETEX key millisecond value 。
• NX：只在鍵不存在時，才對鍵進行設定操作。SET key value NX 效果等同於 SETNX key value 。
• XX：只在鍵已經存在時，才對鍵進行設定操作。

go-zero 分散式鎖 RedisLock 原始碼分析

-- KEYS[1]: 鎖key
-- ARGV[1]: 鎖value,隨機字串
-- ARGV[2]: 過期時間
-- 判斷鎖key持有的value是否等於傳入的value
-- 如果相等說明是再次獲取鎖並更新獲取時間，防止重入時過期
-- 這裡說明是“可重入鎖”
if redis.call("GET", KEYS[1]) == ARGV[1] then
    -- 設定
    redis.call("SET", KEYS[1], ARGV[1], "PX", ARGV[2])
    return "OK"
else
    -- 鎖key.value不等於傳入的value則說明是第一次獲取鎖
    -- SET key value NX PX timeout : 當key不存在時才設定key的值
    -- 設定成功會自動返回“OK”，設定失敗返回“NULL Bulk Reply”
    -- 為什麼這裡要加“NX”呢，因為需要防止把別人的鎖給覆蓋了
    return redis.call("SET", KEYS[1], ARGV[1], "NX", "PX", ARGV[2])
end

-- 釋放鎖
-- 不可以釋放別人的鎖
if redis.call("GET", KEYS[1]) == ARGV[1] then
    -- 執行成功返回“1”
    return redis.call("DEL", KEYS[1])
else
    return 0
end

package redis
import (
    "math/rand"
    "strconv"
    "sync/atomic"
    "time"
    red "github.com/go-redis/redis"
    "github.com/tal-tech/go-zero/core/logx"
)
const (
    letters     = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
    lockCommand = `if redis.call("GET", KEYS[1]) == ARGV[1] then
    redis.call("SET", KEYS[1], ARGV[1], "PX", ARGV[2])
    return "OK"
else
    return redis.call("SET", KEYS[1], ARGV[1], "NX", "PX", ARGV[2])
end`
    delCommand = `if redis.call("GET", KEYS[1]) == ARGV[1] then
    return redis.call("DEL", KEYS[1])
else
    return 0
end`
    randomLen = 16
    // 預設超時時間，防止死鎖
    tolerance       = 500 // milliseconds
    millisPerSecond = 1000
)
// A RedisLock is a redis lock.
type RedisLock struct {
    // redis客戶端
    store *Redis
    // 超時時間
    seconds uint32
    // 鎖key
    key string
    // 鎖value，防止鎖被別人獲取到
    id string
}
func init() {
    rand.Seed(time.Now().UnixNano())
}
// NewRedisLock returns a RedisLock.
func NewRedisLock(store *Redis, key string) *RedisLock {
    return &RedisLock{
        store: store,
        key:   key,
        // 獲取鎖時，鎖的值通過隨機字串生成
        // 實際上go-zero提供更加高效的隨機字串生成方式
        // 見core/stringx/random.go：Randn
        id:    randomStr(randomLen),
    }
}
// Acquire acquires the lock.
// 加鎖
func (rl *RedisLock) Acquire() (bool, error) {
    // 獲取過期時間
    seconds := atomic.LoadUint32(&rl.seconds)
    // 預設鎖過期時間為500ms，防止死鎖
    resp, err := rl.store.Eval(lockCommand, []string{rl.key}, []string{
        rl.id, strconv.Itoa(int(seconds)*millisPerSecond + tolerance),
    })
    if err == red.Nil {
        return false, nil
    } else if err != nil {
        logx.Errorf("Error on acquiring lock for %s, %s", rl.key, err.Error())
        return false, err
    } else if resp == nil {
        return false, nil
    }
    reply, ok := resp.(string)
    if ok && reply == "OK" {
        return true, nil
    }
    logx.Errorf("Unknown reply when acquiring lock for %s: %v", rl.key, resp)
    return false, nil
}
// Release releases the lock.
// 釋放鎖
func (rl *RedisLock) Release() (bool, error) {
    resp, err := rl.store.Eval(delCommand, []string{rl.key}, []string{rl.id})
    if err != nil {
        return false, err
    }
    reply, ok := resp.(int64)
    if !ok {
        return false, nil
    }
    return reply == 1, nil
}
// SetExpire sets the expire.
// 需要注意的是需要在Acquire()之前呼叫
// 不然預設為500ms自動釋放
func (rl *RedisLock) SetExpire(seconds int) {
    atomic.StoreUint32(&rl.seconds, uint32(seconds))
}
func randomStr(n int) string {
    b := make([]byte, n)
    for i := range b {
        b[i] = letters[rand.Intn(len(letters))]
    }
    return string(b)
}

關於分散式鎖還有哪些實現方案