golang基于Mutex實(shí)現(xiàn)可重入鎖
golang基于Mutex實(shí)現(xiàn)可重入鎖
為什么需要可重入鎖
我們平時(shí)說的分布式鎖,一般指的是在不同服務(wù)器上的多個(gè)線程中,只有一個(gè)線程能搶到一個(gè)鎖,從而執(zhí)行一個(gè)任務(wù)。而我們使用鎖就是保證一個(gè)任務(wù)只能由一個(gè)線程來完成。所以我們一般是使用這樣的三段式邏輯:
Lock(); DoJob(); Unlock();
但是由于我們的系統(tǒng)都是分布式的,這個(gè)鎖一般不會(huì)只放在某個(gè)進(jìn)程中,我們會(huì)借用第三方存儲(chǔ),比如 Redis 來做這種分布式鎖。但是一旦借助了第三方存儲(chǔ),我們就必須面對(duì)這個(gè)問題:Unlock是否能保證一定運(yùn)行呢?
這個(gè)問題,我們面對(duì)的除了程序的bug之外,還有網(wǎng)絡(luò)的不穩(wěn)定,進(jìn)程被殺死,服務(wù)器被down機(jī)等。我們是無法保證Unlock一定被運(yùn)行的。
那么我們就一般在Lock的時(shí)候?yàn)檫@個(gè)鎖加一個(gè)超時(shí)時(shí)間作為兜底。
LockByExpire(duration); DoJob(); Unlock();
這個(gè)超時(shí)時(shí)間是為了一旦出現(xiàn)異常情況導(dǎo)致Unlock沒有被運(yùn)行,這個(gè)鎖在duration時(shí)間內(nèi)也會(huì)被自動(dòng)釋放。這個(gè)在redis中我們一般就是使用set ex 來進(jìn)行鎖超時(shí)的設(shè)定。
但是有這個(gè)超時(shí)時(shí)間我們又遇上了問題,超時(shí)時(shí)間設(shè)置多久合適呢?當(dāng)然要設(shè)置的比 DoJob 消耗的時(shí)間更長,否則的話,在任務(wù)還沒結(jié)束的時(shí)候,鎖就被釋放了,還是有可能導(dǎo)致并發(fā)任務(wù)的存在。
但是實(shí)際上,同樣由于網(wǎng)絡(luò)超時(shí)問題,系統(tǒng)運(yùn)行狀況問題等,我們是無法準(zhǔn)確知道DoJob這個(gè)函數(shù)要執(zhí)行多久的。那么這時(shí)候怎么辦呢?
有兩個(gè)辦法:
第一個(gè)方法,我們可以對(duì)DoJob做一個(gè)超時(shí)設(shè)置。讓DoJob最多只能執(zhí)行n秒,那么我的分布式鎖的超時(shí)時(shí)長設(shè)置比n秒長就可以了。為一個(gè)任務(wù)設(shè)置超時(shí)時(shí)間在很多語言是可以做到的。比如golang 中的 TimeoutContext。
而第二種方法,就是我們先為鎖設(shè)置一個(gè)比較小的超時(shí)時(shí)長,然后不斷續(xù)期這個(gè)鎖。對(duì)一個(gè)鎖的不斷需求,也可以理解為重新開始加鎖,這種可以不斷續(xù)期的鎖,就叫做可重入鎖。
除了主線程之外,可重入鎖必然有一個(gè)另外的線程(或者攜程)可以對(duì)這個(gè)鎖進(jìn)行續(xù)期,我們叫這個(gè)額外的程序叫做watchDog(看門狗)。
鎖重入的定義
鎖可重入也就是當(dāng)前已經(jīng)獲取到鎖的goroutine繼續(xù)調(diào)用Lock方法獲取鎖,Go標(biāo)準(zhǔn)庫中提供了sync.Mutex實(shí)現(xiàn)了排他鎖,但并不是可重入的,如果在代碼中重入鎖,也就是Lock之后再次進(jìn)行Lock獲取鎖,則會(huì)被阻塞到第二次Lock上,鎖沒有辦法得到釋放從而影響其它goroutine執(zhí)行
// 例如
package main;
import "sync"
func ReentryExample() {
var c int64
var mu sync.Mutex
mu.Lock() // 第一次加鎖
// TODO //
mu.Lock() // 第二次加鎖,阻塞
c++;
// TODO ...
}
重入鎖的簡單實(shí)現(xiàn)思路
- 拿到能夠識(shí)別到當(dāng)前協(xié)程的id,(通過堆棧信息獲取到goroutine的id)
- 寫一個(gè)結(jié)構(gòu)體,實(shí)現(xiàn)Locker接口
首先獲取到goroutine的id
func GoID() int {
var buf [32]byte
n := runtime.Stack(buf[:],false) // 獲取堆棧的信息
// string(buf[:n]
/**
goroutine 6 [running]:
main.XXX
*/
// 拿到goroutine的id
goIdStr := strings.Fields(strings.TrimPrefix(string(buf[:n]), "goroutine"))[0]
goId, err := strconv.Atoi(fieldId)// 轉(zhuǎn)換為int
return goId
}
然后開始編寫可重入鎖的結(jié)構(gòu)體
// ReentrantMutex 可重入的互斥鎖
type ReentrantMutex struct {
sync.Mutex // 互斥鎖
goId int64 // 用于保存goroutine的id
recursion int64 // 鎖重入的次數(shù)
}
// Lock 實(shí)現(xiàn)Locker接口,用于加鎖
func (r *ReentrantMutex) Lock() {
gid := GoID()
if atomic.LoadInt64(&r.goId) == gid { // 看看是否已經(jīng)加過鎖了?
atomic.AddInt64(&r.recursion, 1) // 如果之前加過鎖,則重入的次數(shù)+1
return
}
r.Mutex.Lock() // 使用互斥鎖上鎖
atomic.StoreInt64(&r.goId, gid) // 使用原子操作保存goroutine的id
atomic.StoreInt64(&r.recursion, 1) // 第一次加鎖,因此重入的次數(shù)為一
}
// Unlock 實(shí)現(xiàn)了Locker的接口,用于解鎖
func (r *ReentrantMutex) Unlock() {
gid := GoID()
if atomic.LoadInt64(&r.goId) != gid { // 看是否加過鎖
panic("未加鎖") // 沒有加過鎖,不存在解鎖,直接panic
}
recursion := atomic.AddInt64(&r.recursion, -1) // 重入次數(shù)-1
if recursion != 0 { // 如果重入次數(shù)沒有等于0(意味著還有鎖沒有釋放)
return
}
atomic.StoreInt64(&r.goId, -1) // 重入次數(shù)為0,則不存在鎖沒有釋放,解鎖
r.Mutex.Unlock() // 互斥鎖解鎖
}
測試用例
package main;
func main() {
var m ReentrantMutex
m.Lock()
m.Lock() // 不會(huì)阻塞
fmt.Println("1") // 正常打印1
m.Unlock()
m.Unlock()// 解鎖
}
其他方法實(shí)現(xiàn)Golang可重入鎖:
具體實(shí)現(xiàn)
在Golang中,語言級(jí)別天生支持協(xié)程,所以這種可重入鎖就非常容易實(shí)現(xiàn):
// DistributeLockRedis 基于redis的分布式可重入鎖,自動(dòng)續(xù)租
type DistributeLockRedis struct {
key string // 鎖的key
expire int64 // 鎖超時(shí)時(shí)間
status bool // 上鎖成功標(biāo)識(shí)
cancelFun context.CancelFunc // 用于取消自動(dòng)續(xù)租攜程
redis redis.Client // redis句柄
}
// 創(chuàng)建可
func NewDistributeLockRedis(key string, expire int64) *DistributeLockRedis {
return &DistributeLockRedis{
key : key,
expire : expire,
}
}
// TryLock 上鎖
func (dl *DistributeLockRedis) TryLock() (err error) {
if err = dl.lock(); err != nil {
return err
}
ctx, cancelFun := context.WithCancel(context.Background())
dl.cancelFun = cancelFun
dl.startWatchDog(ctx) // 創(chuàng)建守護(hù)協(xié)程,自動(dòng)對(duì)鎖進(jìn)行續(xù)期
dl.status = true
return nil
}
// competition 競爭鎖
func (dl *DistributeLockRedis) lock() error {
if res, err := redis.String(dl.redis.Do(context.Background(), "SET", dl.key, 1, "NX", "EX", dl.expire)); err != nil {
return err
}
return nil
}
// guard 創(chuàng)建守護(hù)協(xié)程,自動(dòng)續(xù)期
func (dl *DistributeLockRedis) startWatchDog(ctx context.Context) {
safeGo(func() error {
for {
select {
// Unlock通知結(jié)束
case <-ctx.Done():
return nil
default:
// 否則只要開始了,就自動(dòng)重入(續(xù)租鎖)
if dl.status {
if res, err := redis.Int(dl.redis.Do(context.Background(), "EXPIRE", dl.key, dl.expire)); err != nil {
return nil
}
// 續(xù)租時(shí)間為 expire/2 秒
time.Sleep(time.Duration(dl.expire/2) * time.Second)
}
}
}
})
}
// Unlock 釋放鎖
func (dl *DistributeLockRedis) Unlock() (err error) {
// 這個(gè)重入鎖必須取消,放在第一個(gè)地方執(zhí)行
if dl.cancelFun != nil {
dl.cancelFun() // 釋放成功,取消重入鎖
}
var res int
if dl.status {
if res, err = redis.Int(dl.redis.Do(context.Background(), "Del", dl.key)); err != nil {
return fmt.Errorf("釋放鎖失敗")
}
if res == 1 {
dl.status = false
return nil
}
}
return fmt.Errorf("釋放鎖失敗")
}這段代碼的邏輯基本上都以注釋的形式來寫了。其中主要就在startWatchDog,對(duì)鎖進(jìn)行重新續(xù)期
ctx, cancelFun := context.WithCancel(context.Background()) dl.cancelFun = cancelFun dl.startWatchDog(ctx) // 創(chuàng)建守護(hù)協(xié)程,自動(dòng)對(duì)鎖進(jìn)行續(xù)期 dl.status = true
首先創(chuàng)建一個(gè)cancelContext,它的context函數(shù)cancelFunc是給Unlock進(jìn)行調(diào)用的。然后啟動(dòng)一個(gè)goroutine進(jìn)程來循環(huán)續(xù)期。
這個(gè)新啟動(dòng)的goroutine在主goroutine處理結(jié)束,調(diào)用Unlock的時(shí)候,才會(huì)結(jié)束,否則會(huì)在 過期時(shí)間/2 的時(shí)候,調(diào)用一次redis的expire命令來進(jìn)行續(xù)期。
至于外部,在使用的時(shí)候如下
func Foo() error {
key := foo
// 創(chuàng)建可重入的分布式鎖
dl := NewDistributeLockRedis(key, 10)
// 爭搶鎖
err := dl.TryLock()
if err != nil {
// 沒有搶到鎖
return err
}
// 搶到鎖的記得釋放鎖
defer func() {
dl.Unlock()
}
// 做真正的任務(wù)
DoJob()
}到此這篇關(guān)于golang基于Mutex實(shí)現(xiàn)可重入鎖的文章就介紹到這了,更多相關(guān)golang Mutex可重入鎖內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Golang實(shí)現(xiàn)自己的Redis(pipeline客戶端)實(shí)例探索
這篇文章主要為大家介紹了Golang實(shí)現(xiàn)自己的Redis(pipeline客戶端)實(shí)例探索,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2024-01-01
golang默認(rèn)Logger日志庫在項(xiàng)目中使用Zap日志庫
這篇文章主要為大家介紹了golang默認(rèn)Logger日志庫在項(xiàng)目中使用Zap日志庫,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步早日升職加薪2022-04-04

