Go 语言下基于Redis分布式锁的实现方式

分布式锁一般有三种实现方式：1. 数据库乐观锁；2. 基于Redis的分布式锁；3. 基于ZooKeeper的分布式锁。本篇博客将介绍第二种方式，基于Redis实现分布式锁。虽然网上已经有各种介绍Redis分布式锁实现的博客，然而他们的实现却有着各种各样的问题，为了避免误人子弟，本篇博客将详细介绍如何正确地实现Redis分布式锁。

项目地址： https://github.com/Spongecaptain/redisLock

1. Go 原生的互斥锁

Go 原生的互斥锁即 sync 包下的 Mutex 结构体，利用此结构体的 Lock 以及 Unlock 方法能够实现锁的占据以及释放。

关于 sync.Mutex，我们可以总结出如下的特性：

• 支持自旋锁，在并发冲突不严重的背景下提高锁的使用效率；

• 支持锁的公平性，能够避免锁导致的线程饥饿问题；

• 不支持锁的重入，持有锁的协程再次申请锁资源会导致死锁；

• 任何协程都可以调用 Mutex.Unlock 方法来解锁，并不只允许占据锁资源的协程进行解锁；

• 不支持超时锁获取，也不支持 TryLock 机制

Go 语言中 sync.Mutex 的特性与 Java 中 java.util.concurrent.locks.Lock 相比，API 语义简单不少，这也符合 Go 语言对于简单化的追求。

下面看看本项目-基于 Redis 的分布式锁能够提供哪些分布锁特性。

2. redisLock 的特性

github-redisLock 是一个基于 go-redis/redis 客户端的 Redis 分布式锁。其拥有的如下的特性：

• 原子性：利用 Lua 脚本实现原子性语义；

• 阻塞唤醒：利用 Redis 的发布订阅来实现锁的阻塞唤醒；

• 锁自动过期：避免因为宕机导致的死锁问题；

• 锁的自动续期：利用 Go 协程实现锁资源的自动续期，避免出现业务时间>锁超时时间导致并发安全问题

• TryLock：尝试获取一次锁，获取失败后阻塞

• 自旋锁：提供自旋锁 API 来实现分布式锁的自旋获取
  

github-redisLock 同时不支持如下特性：

重入性：分布式锁不可重入，Go 语言并没有优雅的方式来实现 Java 中的 ThreadLocal 机制
非公平性：分布式锁存在非公平问题，在极端情况下会导致饥饿问题

3. Quick Start

Install redisLock:

go get github.com/Spongecaptain/redisLock

Create redis client:

import(
"github.com/go-redis/redis"
)
var redisClient = redis.NewClient(&redis.Options{
Addr:     "localhost:6379",
Password: "", // no password set
DB:       0,  // use default DB
})

Create redisLock:

key := "reids-lock-key"
value := "redis-lock-value"
lock := redisLock.NewRedisLock(redisClient, key, value)

err := lock.Lock()
if err != nil {
 fmt.Println(err.Error())
 return
}
fmt.Println("get redis lock success")
defer func() {
 err = lock.Unlock()
 if err != nil {
   fmt.Println(err.Error())
   return
 }
 fmt.Println("release redis lock success")
}()

4. API 说明

（1）构造分布式锁实例
利用 NewRedisLock 以及 NewRedisLockWithExpireTime 函数能够构造出一个分布式锁实例，NewRedisLockWithExpireTime 的区别在于其能够自定义锁的过期时间。

NewRedisLock 方法接收的 key 决定了分布式锁的粒度，value 决定了只有 value 值相同才能够进行解锁。

（2）TryLock
TryLock 仅尝试一次锁的获取，如果失败，那么不会阻塞，直接返回。

（3）Lock
Lock 会不断尝试索取分布式锁，这会导致调用此方法的协程阻塞。

（4）Unlock
Unlock 方法用于解锁，由于涉及网络通信，解锁可能失败， error!=nil 意味着解锁失败。

（5）LockWithTimeout
Lock 方法会在获取锁资源成功或者超时后返回。

（6）SpinLock
支持指定次数地进行自旋式的锁获取。

来源：https://spongecaptain.cool/post/go/redislock/