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语言-在mac下brew升级golang
Apr 25 Golang
golang json数组拼接的实例
Apr 28 Golang
golang 如何通过反射创建新对象
Apr 28 Golang
浅谈Golang 嵌套 interface 的赋值问题
Apr 29 Golang
解决golang在import自己的包报错的问题
Apr 29 Golang
go mod 安装依赖 unkown revision问题的解决方案
May 06 Golang
go web 预防跨站脚本的实现方式
Jun 11 Golang
Go语言基础map用法及示例详解
Nov 17 Golang
详解Golang如何优雅的终止一个服务
Mar 21 Golang
Go语言的协程上下文的几个方法和用法
Apr 11 Golang
Go语言入门exec的基本使用
May 20 Golang
Golang gRPC HTTP协议转换示例
Jun 16 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 self,$this,const,static,-&amp;gt;的使用
2009/10/22 PHP
PHP json_encode() 函数详解及中文乱码问题
2015/11/05 PHP
PHP面向对象程序设计实例分析
2016/01/26 PHP
动态表单验证的操作方法和TP框架里面的ajax表单验证
2017/07/19 PHP
解决laravel中日志权限莫名变成了root的问题
2019/10/17 PHP
php如何实现数据库的备份和恢复
2020/11/30 PHP
jQuery示例收集
2010/11/05 Javascript
选择器中含有空格在使用示例及注意事项
2013/07/31 Javascript
javascript页面渲染速度测试脚本分享
2014/04/15 Javascript
js通过更改按钮的显示样式实现按钮的滑动效果
2014/04/23 Javascript
jQuery多媒体插件jQuery Media Plugin使用详解
2014/12/19 Javascript
Backbone.js 0.9.2 源码注释中文翻译版
2015/06/25 Javascript
JS中用三种方式实现导航菜单中的二级下拉菜单
2016/10/31 Javascript
vue 怎么创建组件及组件使用方法
2017/07/27 Javascript
JavaScript动态绑定详解
2017/09/14 Javascript
原生js封装运动框架的示例讲解
2017/10/01 Javascript
React项目动态设置title标题的方法示例
2018/09/26 Javascript
Angular实现svg和png图片下载实现
2019/05/05 Javascript
微信小程序实现下拉刷新动画
2019/06/21 Javascript
js实现视图和数据双向绑定的方法分析
2020/02/05 Javascript
Vue的v-model的几种修饰符.lazy,.number和.trim的用法说明
2020/08/05 Javascript
python协程用法实例分析
2015/06/04 Python
浅谈Python类的__getitem__和__setitem__特殊方法
2016/12/25 Python
Python利用BeautifulSoup解析Html的方法示例
2017/07/30 Python
Python自定义一个类实现字典dict功能的方法
2019/01/19 Python
python爬虫增加访问量的方法
2019/08/22 Python
简单介绍一下pyinstaller打包以及安全性的实现
2020/06/02 Python
python等待10秒执行下一命令的方法
2020/07/19 Python
让ie浏览器成为支持html5的浏览器的解决方法(使用html5shiv)
2014/04/08 HTML / CSS
计算机网络毕业生自荐信
2013/10/01 职场文书
生产总经理岗位职责
2013/12/19 职场文书
营业员演讲稿
2013/12/30 职场文书
自我评价范文分享
2014/01/04 职场文书
司机职责范本
2014/03/08 职场文书
Win11怎么进入安全模式?Windows 11进入安全模式的方法
2021/11/21 数码科技
Win11任务栏太宽了怎么办?一招解决Win11任务栏太宽问题
2021/11/21 数码科技