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 相关文章推荐
Golang二维切片初始化的实现
Apr 08 Golang
go:垃圾回收GC触发条件详解
Apr 24 Golang
Go语言中break label与goto label的区别
Apr 28 Golang
golang slice元素去重操作
Apr 30 Golang
Go 自定义package包设置与导入操作
May 06 Golang
golang 实现并发求和
May 08 Golang
go xorm框架的使用
May 22 Golang
go select编译期的优化处理逻辑使用场景分析
Jun 28 Golang
go goroutine 怎样进行错误处理
Jul 16 Golang
Golang并发操作中常见的读写锁详析
Aug 30 Golang
一文搞懂Golang 时间和日期相关函数
Dec 06 Golang
Golang解析JSON对象
Apr 30 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
PHP获取MAC地址的函数代码
2011/09/11 PHP
一个经典实用的PHP图像处理类分享
2014/11/18 PHP
PHP操作路由器实现方法示例
2019/04/27 PHP
TP5多入口设置实例讲解
2020/12/15 PHP
用Javascript同时提交多个Web表单的方法
2009/12/26 Javascript
javascript定时保存表单数据的代码
2011/03/17 Javascript
jquery插件制作 提示框插件实现代码
2012/08/17 Javascript
JS 毫秒转时间示例代码
2013/09/22 Javascript
jQuery设置和移除文本框默认值的方法
2015/03/09 Javascript
JS实现控制表格行内容垂直对齐的方法
2015/03/30 Javascript
Angularjs注入拦截器实现Loading效果
2015/12/28 Javascript
JS在一定时间内跳转页面及各种刷新页面的实现方法
2016/05/26 Javascript
浅谈window.onbeforeunload() 事件调用ajax
2016/06/29 Javascript
js模仿微信朋友圈计算时间显示几天/几小时/几分钟/几秒之前
2017/04/27 Javascript
Angular 4 指令快速入门教程
2017/06/07 Javascript
基于原生js运动方式关键点的总结(推荐)
2017/10/01 Javascript
JavaScript使用math.js进行精确计算操作示例
2018/06/19 Javascript
vue中的数据绑定原理的实现
2018/07/02 Javascript
vue中使用codemirror的实例详解
2018/11/01 Javascript
vue项目部署到nginx/tomcat服务器的实现
2019/08/26 Javascript
[05:31]DOTA2英雄梦之声_第08期_莉娜
2014/06/23 DOTA
python编写暴力破解zip文档程序的实例讲解
2018/04/24 Python
将python2.7添加进64位系统的注册表方式
2019/11/20 Python
英国最大的体育&时尚零售公司:JD Sports
2017/12/13 全球购物
亿阳信通股份有限公司C#笔试题
2016/12/06 面试题
山海经纬软件测试笔试题和面试题
2013/04/02 面试题
采购内勤岗位职责
2013/12/10 职场文书
2014法院干警廉洁警示教育思想汇报
2014/09/13 职场文书
2014年财务人员工作总结
2014/11/11 职场文书
2015年林业工作总结
2015/05/14 职场文书
青年文明号创建口号大全
2015/12/25 职场文书
深度好文:50条没人告诉你的人生经验,句句精辟
2019/08/22 职场文书
MySQL中你可能忽略的COLLATION实例详解
2021/05/12 MySQL
pandas:get_dummies()与pd.factorize()的用法及区别说明
2021/05/21 Python
代码解析React中setState同步和异步问题
2021/06/03 Javascript
Python使用socket去实现TCP客户端和TCP服务端
2022/04/12 Python