Golang实现可重入锁的示例代码


Posted in Golang onMay 25, 2022

项目中遇到了可重入锁的需求和实现,具体记录下。

什么是可重入锁

我们平时说的分布式锁,一般指的是在不同服务器上的多个线程中,只有一个线程能抢到一个锁,从而执行一个任务。而我们使用锁就是保证一个任务只能由一个线程来完成。所以我们一般是使用这样的三段式逻辑:

Lock();
DoJob();
Unlock();

但是由于我们的系统都是分布式的,这个锁一般不会只放在某个进程中,我们会借用第三方存储,比如 Redis 来做这种分布式锁。但是一旦借助了第三方存储,我们就必须面对这个问题:Unlock是否能保证一定运行呢?

这个问题,我们面对的除了程序的bug之外,还有网络的不稳定,进程被杀死,服务器被down机等。我们是无法保证Unlock一定被运行的。

那么我们就一般在Lock的时候为这个锁加一个超时时间作为兜底。

LockByExpire(duration);
DoJob();
Unlock();

这个超时时间是为了一旦出现异常情况导致Unlock没有被运行,这个锁在duration时间内也会被自动释放。这个在redis中我们一般就是使用set ex 来进行锁超时的设定。

但是有这个超时时间我们又遇上了问题,超时时间设置多久合适呢?当然要设置的比 DoJob 消耗的时间更长,否则的话,在任务还没结束的时候,锁就被释放了,还是有可能导致并发任务的存在。

但是实际上,同样由于网络超时问题,系统运行状况问题等,我们是无法准确知道DoJob这个函数要执行多久的。那么这时候怎么办呢?

有两个办法:

第一个方法,我们可以对DoJob做一个超时设置。让DoJob最多只能执行n秒,那么我的分布式锁的超时时长设置比n秒长就可以了。为一个任务设置超时时间在很多语言是可以做到的。比如golang 中的 TimeoutContext。

而第二种方法,就是我们先为锁设置一个比较小的超时时长,然后不断续期这个锁。对一个锁的不断需求,也可以理解为重新开始加锁,这种可以不断续期的锁,就叫做可重入锁。

除了主线程之外,可重入锁必然有一个另外的线程(或者携程)可以对这个锁进行续期,我们叫这个额外的程序叫做watchDog(看门狗)。

具体实现

在Golang中,语言级别天生支持协程,所以这种可重入锁就非常容易实现:

// DistributeLockRedis 基于redis的分布式可重入锁,自动续租
type DistributeLockRedis struct {
	key       string             // 锁的key
	expire    int64              // 锁超时时间
	status    bool               // 上锁成功标识
	cancelFun context.CancelFunc // 用于取消自动续租携程
	redis     redis.Client       // redis句柄
}

// 创建可
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) // 创建守护协程,自动对锁进行续期
	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 创建守护协程,自动续期
func (dl *DistributeLockRedis) startWatchDog(ctx context.Context) {
	safeGo(func() error {
		for {
			select {
			// Unlock通知结束
			case <-ctx.Done():
				return nil
			default:
				// 否则只要开始了,就自动重入(续租锁)
				if dl.status {
					if res, err := redis.Int(dl.redis.Do(context.Background(), "EXPIRE", dl.key, dl.expire)); err != nil {
						return nil
					} 
					// 续租时间为 expire/2 秒
					time.Sleep(time.Duration(dl.expire/2) * time.Second)
				}
			}
		}
	})
}

// Unlock 释放锁
func (dl *DistributeLockRedis) Unlock() (err error) {
	// 这个重入锁必须取消,放在第一个地方执行
	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,对锁进行重新续期

ctx, cancelFun := context.WithCancel(context.Background())
dl.cancelFun = cancelFun
dl.startWatchDog(ctx) // 创建守护协程,自动对锁进行续期
dl.status = true

首先创建一个cancelContext,它的context函数cancelFunc是给Unlock进行调用的。然后启动一个goroutine进程来循环续期。

这个新启动的goroutine在主goroutine处理结束,调用Unlock的时候,才会结束,否则会在 过期时间/2 的时候,调用一次redis的expire命令来进行续期。

至于外部,在使用的时候如下

func Foo() error {
  key := foo
  
  // 创建可重入的分布式锁
	dl := NewDistributeLockRedis(key, 10)
	// 争抢锁
	err := dl.TryLock()
	if err != nil {
		// 没有抢到锁
		return err
	}
	
	// 抢到锁的记得释放锁
	defer func() {
		dl.Unlock()
	}
	
	// 做真正的任务
	DoJob()
}

以上就是Golang实现可重入锁的示例代码的详细内容!

Golang 相关文章推荐
go语言中切片与内存复制 memcpy 的实现操作
Apr 27 Golang
解决Golang time.Parse和time.Format的时区问题
Apr 29 Golang
golang slice元素去重操作
Apr 30 Golang
golang协程池模拟实现群发邮件功能
May 02 Golang
Go标准容器之Ring的使用说明
May 05 Golang
golang内置函数len的小技巧
Jul 25 Golang
Golang并发操作中常见的读写锁详析
Aug 30 Golang
golang中的struct操作
Nov 11 Golang
Go语言基础map用法及示例详解
Nov 17 Golang
golang语言指针操作
Apr 14 Golang
Go 内联优化让程序员爱不释手
Jun 21 Golang
Go web入门Go pongo2模板引擎
May 20 #Golang
Go语言入门exec的基本使用
May 20 #Golang
Golang并发工具Singleflight
May 06 #Golang
深入理解 Golang 的字符串
May 04 #Golang
Golang入门之计时器
May 04 #Golang
Golang 入门 之url 包
May 04 #Golang
Golang解析JSON对象
Apr 30 #Golang
You might like
Body是什么,该怎么喝出咖啡里的口感
2021/03/03 咖啡文化
php中支持多种编码的中文字符串截取函数!
2007/03/20 PHP
md5 16位二进制与32位字符串相互转换示例
2013/12/30 PHP
Linux下手动编译安装PHP扩展的例子分享
2014/07/15 PHP
JQuery中关于jquery.js与jquery.min.js的比较探讨
2013/05/15 Javascript
jQuery取得设置清空select选择的文本与值
2014/07/08 Javascript
用原生js做个简单的滑动效果的回到顶部
2014/10/15 Javascript
jquery代码实现多选、不同分享功能
2015/07/31 Javascript
jQuery解决$符号命名冲突
2016/06/18 Javascript
JS简单生成两个数字之间随机数的方法
2016/08/03 Javascript
javascript之with的使用(阿里云、淘宝使用代码分析)
2016/10/11 Javascript
AngularJS基于http请求实现下载php生成的excel文件功能示例
2018/01/23 Javascript
微信小程序icon组件使用详解
2018/01/31 Javascript
vue自定义指令之面板拖拽的实现
2019/04/14 Javascript
微信小程序开发注意指南和优化实践(小结)
2019/06/21 Javascript
JS实现动态无缝轮播
2020/01/11 Javascript
vue基于better-scroll仿京东分类列表
2020/06/30 Javascript
举例讲解Python程序与系统shell交互的方式
2015/04/09 Python
Python编程之变量赋值操作实例分析
2017/07/24 Python
python中数据爬虫requests库使用方法详解
2018/02/11 Python
python多线程并发实例及其优化
2019/06/27 Python
Django发送邮件和itsdangerous模块的配合使用解析
2019/08/10 Python
pytorch .detach() .detach_() 和 .data用于切断反向传播的实现
2019/12/27 Python
python实现磁盘日志清理的示例
2020/11/05 Python
用python对excel进行操作(读,写,修改)
2020/12/25 Python
Tahari ASL官方网站:高级设计师女装
2021/03/15 全球购物
国培计划培训感言
2014/03/11 职场文书
中秋手机店促销方案
2014/06/16 职场文书
教师党的群众路线教育实践活动个人对照检查材料
2014/09/23 职场文书
小学教师学习党的群众路线教育实践活动心得体会
2014/10/31 职场文书
2014年个人思想工作总结
2014/11/27 职场文书
高中生个性发展自我评价
2015/03/09 职场文书
2015年人民调解工作总结
2015/05/18 职场文书
2016年基层党支部书记公开承诺书
2016/03/25 职场文书
Python代码风格与编程习惯重要吗?
2021/06/03 Python
基于Redission的分布式锁实战
2022/08/14 Redis