Go结合Redis用最简单的方式实现分布式锁

更新时间：2022年01月20日 15:36:15 作者：jiaxwu

本文主要介绍了Go结合Redis用最简单的方式实现分布式锁示例，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下

前言

在项目中我们经常有需要使用分布式锁的场景，而Redis是实现分布式锁最常见的一种方式，并且我们也都希望能够把代码写得简单一点，所以今天我们尽量用最简单的方式来实现。

下面的代码使用go-redis客户端和gofakeit，参考和引用了Redis官方文章

单Redis实例场景

如果熟悉Redis的命令，可能会马上想到使用Redis的set if not exists操作来实现，并且现在标准的实现方式是SET resource_name my_random_value NX PX 30000这串命令，其中：

resource_name表示要锁定的资源
NX表示如果不存在则设置
PX 30000表示过期时间为30000毫秒，也就是30秒
my_random_value这个值在所有的客户端必须是唯一的，所有同一key的获取者（竞争者）这个值都不能一样。

value的值必须是随机数主要是为了更安全的释放锁，释放锁的时候使用脚本告诉Redis:只有key存在并且存储的值和我指定的值一样才能告诉我删除成功。可以通过以下Lua脚本实现：

if redis.call("get",KEYS[1]) == ARGV[1] then
    return redis.call("del",KEYS[1])
else
    return 0
end

举个例子：客户端A取得资源锁，但是紧接着被一个其他操作阻塞了，当客户端A运行完毕其他操作后要释放锁时，原来的锁早已超时并且被Redis自动释放，并且在这期间资源锁又被客户端B再次获取到。

使用Lua脚本是因为判断和删除是两个操作，所以有可能A刚判断完锁就过期自动释放了，然后B就获取到了锁，然后A又调用了Del，导致把B的锁给释放了。

加解锁示例

package main

import (
   "context"
   "errors"
   "fmt"
   "github.com/brianvoe/gofakeit/v6"
   "github.com/go-redis/redis/v8"
   "sync"
   "time"
)

var client *redis.Client

const unlockScript = `
if redis.call("get",KEYS[1]) == ARGV[1] then
    return redis.call("del",KEYS[1])
else
    return 0
end`

func lottery(ctx context.Context) error {
   // 加锁
   myRandomValue := gofakeit.UUID()
   resourceName := "resource_name"
   ok, err := client.SetNX(ctx, resourceName, myRandomValue, time.Second*30).Result()
   if err != nil {
      return err
   }
   if !ok {
      return errors.New("系统繁忙，请重试")
   }
   // 解锁
   defer func() {
      script := redis.NewScript(unlockScript)
      script.Run(ctx, client, []string{resourceName}, myRandomValue)
   }()

   // 业务处理
   time.Sleep(time.Second)
   return nil
}

func main() {
   client = redis.NewClient(&redis.Options{
      Addr: "127.0.0.1:6379",
   })
   var wg sync.WaitGroup
   wg.Add(2)
   go func() {
      defer wg.Done()
      ctx, _ := context.WithTimeout(context.Background(), time.Second*3)
      err := lottery(ctx)
      if err != nil {
         fmt.Println(err)
      }
   }()
   go func() {
      defer wg.Done()
      ctx, _ := context.WithTimeout(context.Background(), time.Second*3)
      err := lottery(ctx)
      if err != nil {
         fmt.Println(err)
      }
   }()
   wg.Wait()
}

我们先看lottery()函数，这里模拟一个抽奖操作，在进入函数时，先使用SET resource_name my_random_value NX PX 30000加锁，这里使用UUID作为随机值，如果操作失败，直接返回，让用户重试，如果成功在defer里面执行解锁逻辑，解锁逻辑就是执行前面说到得lua脚本，然后再进行业务处理。

我们在main()函数里面执行了两个goroutine并发调用lottery()函数，其中有一个操作会因为拿不到锁而直接失败。

小结

生成随机值
使用SET resource_name my_random_value NX PX 30000加锁
如果加锁失败，直接返回
defer添加解锁逻辑，保证在函数退出的时候会执行
执行业务逻辑

多Redis实例场景

在单实例情况下，如果这个实例挂了，那么所有请求都会因为拿不到锁而失败，所以我们需要多个分布在不同机器上的Redis实例，并且拿到其中大多数节点的锁才能加锁成功，这也就是RedLock算法。它其实也是基于上面的单实例算法的，只是我们需要同时对多个Redis实例获取锁。

加解锁示例

package main

import (
   "context"
   "errors"
   "fmt"
   "github.com/brianvoe/gofakeit/v6"
   "github.com/go-redis/redis/v8"
   "sync"
   "time"
)

var clients []*redis.Client

const unlockScript = `
if redis.call("get",KEYS[1]) == ARGV[1] then
    return redis.call("del",KEYS[1])
else
    return 0
end`

func lottery(ctx context.Context) error {
   // 加锁
   myRandomValue := gofakeit.UUID()
   resourceName := "resource_name"
   var wg sync.WaitGroup
   wg.Add(len(clients))
   // 这里主要是确保不要加锁太久，这样会导致业务处理的时间变少
   lockCtx, _ := context.WithTimeout(ctx, time.Millisecond*5)
   // 成功获得锁的Redis实例的客户端
   successClients := make(chan *redis.Client, len(clients))
   for _, client := range clients {
      go func(client *redis.Client) {
         defer wg.Done()
         ok, err := client.SetNX(lockCtx, resourceName, myRandomValue, time.Second*30).Result()
         if err != nil {
            return
         }
         if !ok {
            return
         }
         successClients <- client
      }(client)
   }
   wg.Wait() // 等待所有获取锁操作完成
   close(successClients)
   // 解锁，不管加锁是否成功，最后都要把已经获得的锁给释放掉
   defer func() {
      script := redis.NewScript(unlockScript)
      for client := range successClients {
         go func(client *redis.Client) {
            script.Run(ctx, client, []string{resourceName}, myRandomValue)
         }(client)
      }
   }()
   // 如果成功加锁得客户端少于客户端数量的一半+1，表示加锁失败
   if len(successClients) < len(clients)/2+1 {
      return errors.New("系统繁忙，请重试")
   }

   // 业务处理
   time.Sleep(time.Second)
   return nil
}

func main() {
   clients = append(clients, redis.NewClient(&redis.Options{
      Addr: "127.0.0.1:6379",
      DB:   0,
   }), redis.NewClient(&redis.Options{
      Addr: "127.0.0.1:6379",
      DB:   1,
   }), redis.NewClient(&redis.Options{
      Addr: "127.0.0.1:6379",
      DB:   2,
   }), redis.NewClient(&redis.Options{
      Addr: "127.0.0.1:6379",
      DB:   3,
   }), redis.NewClient(&redis.Options{
      Addr: "127.0.0.1:6379",
      DB:   4,
   }))
   var wg sync.WaitGroup
   wg.Add(2)
   go func() {
      defer wg.Done()
      ctx, _ := context.WithTimeout(context.Background(), time.Second*3)
      err := lottery(ctx)
      if err != nil {
         fmt.Println(err)
      }
   }()
   go func() {
      defer wg.Done()
      ctx, _ := context.WithTimeout(context.Background(), time.Second*3)
      err := lottery(ctx)
      if err != nil {
         fmt.Println(err)
      }
   }()
   wg.Wait()
   time.Sleep(time.Second) 
}

在上面的代码中，我们使用Redis的多数据库模拟多个Redis master实例，一般我们会选择5个Redis实例，真实环境中这些实例应该是分布在不同机器上的，避免同时失效。
在加锁逻辑里，我们主要是对每个Redis实例执行SET resource_name my_random_value NX PX 30000获取锁，然后把成功获取锁的客户端放到一个channel里（这里使用slice可能有并发问题），同时使用sync.WaitGroup等待所以获取锁操作结束。
然后添加defer释放锁逻辑，释放锁逻辑很简单，只是把成功拿到的锁给释放掉即可。
最后判断成功获取到的锁的数量是否大于一半，如果没有得到一半以上的锁，说明加锁失败。
如果加锁成功接下来就是进行业务处理。

小结

生成随机值
并发给每个Redis实例使用SET resource_name my_random_value NX PX 30000加锁
等待所有获取锁操作完成
defer添加解锁逻辑，保证在函数退出的时候会执行，这里先defer再判断是因为有可能获取到一部分Redis实例的锁，但是因为没有超过一半，还是会判断为加锁失败
判断是否拿到一半以上Redis实例的锁，如果没有说明加锁失败，直接返回
执行业务逻辑

总结

通过使用Go的goroutine、channel、context、sync.WaitGroup等功能可以很容易的实现RedLock（30多行代码）
可以把加解锁操作封装成函数，这样就不会在业务代码里参杂太多加解锁的逻辑

到此这篇关于Go+Redis用最简单的方式实现分布式锁的文章就介绍到这了,更多相关Go Redis分布式锁内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

GO 语言运行环境的基础知识
这篇文章主要介绍了GO 语言运行环境的基础知识的相关资料,需要的朋友可以参考下
2022-09-09
Go开发Gin项目添加jwt功能实例详解
这篇文章主要为大家介绍了Go开发Gin项目中添加jwt功能实例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-07-07
Go项目在linux服务器的部署详细步骤
在今天的软件开发中,使用Linux作为操作系统的比例越来越高,而Golang语言则因为其高效、简洁和并发性能等特点,也被越来越多的开发者所青睐,这篇文章主要给大家介绍了关于Go项目在linux服务器的部署详细步骤,需要的朋友可以参考下
2023-09-09
Go语言实现IP段范围校验示例
这篇文章主要介绍了Go语言实现IP段范围校验示例，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-09-09
Go编写定时器与定时任务详解(附第三方库gocron用法)
当需要每天执行定时任务的时候就需要定时器来处理了,周期任务,倒计时任务,定点任务等,下面这篇文章主要给大家介绍了关于Go编写定时器与定时任务的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
2022-07-07
golang如何优雅的编写事务代码示例
这篇文章主要介绍了golang如何优雅的编写事务代码示例，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-05-05
golang操作mongodb的方法
这篇文章主要介绍了golang操作mongodb的方法,涉及Go语言操作mongodb的连接、读取及显示的方法,具有一定参考借鉴价值,需要的朋友可以参考下
2015-02-02
如何使用golang实现traceroute
这篇文章主要介绍了如何使用golang实现traceroute,该工具在linux环境下的命令是traceroute或者tracepath，在windows下命令是tracert，本文给大家详细讲解需要的朋友可以参考下
2023-04-04
Go类型断言提取测试接口值动态类型及静态转换确保类型接口编译安全
这篇文章主要为大家介绍了Go类型断言提取测试接口值动态类型及静态转换确保类型实现特定接口的编译时安全性详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2023-10-10
go语言中的Carbon库时间处理技巧
这篇文章主要介绍了go语言中的Carbon库时间处理,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-02-02