Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jefferyjob/go-redislock
High-performance Redis distributed lock service based on Go language. 基于Go语言实现的高性能Redis分布式锁服务。
https://github.com/jefferyjob/go-redislock
distributed go lock redis reentrant spinlock sync
Last synced: 5 days ago
JSON representation
High-performance Redis distributed lock service based on Go language. 基于Go语言实现的高性能Redis分布式锁服务。
- Host: GitHub
- URL: https://github.com/jefferyjob/go-redislock
- Owner: jefferyjob
- License: mit
- Created: 2023-08-31T12:29:18.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-26T06:00:26.000Z (26 days ago)
- Last Synced: 2024-12-10T19:19:32.496Z (12 days ago)
- Topics: distributed, go, lock, redis, reentrant, spinlock, sync
- Language: Go
- Homepage:
- Size: 85.9 KB
- Stars: 316
- Watchers: 1
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.cn.md
- Changelog: CHANGELOG.cn.md
- License: LICENSE
Awesome Lists containing this project
README
# go-redislock
[](https://go.dev)
[](https://github.com/jefferyjob/go-redislock/releases)
[](https://github.com/jefferyjob/go-redislock/actions)
[](https://goreportcard.com/report/github.com/jefferyjob/go-redislock)
[](https://codecov.io/gh/jefferyjob/go-redislock)
[](https://pkg.go.dev/github.com/jefferyjob/go-redislock)
[](https://github.com/jefferyjob/go-redislock/blob/main/LICENSE)
[English](README.md) | 简体中文
## 介绍
go-redislock 是一个用于 Go 的库，用于使用 Redis 作为后端存储提供分布式锁功能。确保在分布式环境中的并发访问下实现数据共享和资源互斥。我们的分布式锁具备可靠性、高性能、超时机制、可重入性和灵活的锁释放方式等特性，简化了分布式锁的使用，让您专注于业务逻辑的实现。
## 快速开始
### 安装
```bash
go get -u github.com/jefferyjob/go-redislock
```
### 使用Demo
```go
package main
import (
"context"
"fmt"
redislock "github.com/jefferyjob/go-redislock"
"github.com/redis/go-redis/v9"
)
func main() {
// 创建 Redis 客户端
redisClient := redis.NewClient(&redis.Options{
Addr: "localhost:6379",
Password: "",
DB: 0,
})
// 创建一个上下文，用于取消锁操作
ctx := context.Background()
// 创建 RedisLock 对象
lock := redislock.New(ctx, redisClient, "test_key")
// 获取锁
err := lock.Lock()
if err != nil {
fmt.Println("锁获取失败：", err)
return
}
defer lock.UnLock() // 解锁
// 在锁定期间执行任务
// ...
fmt.Println("任务执行完成")
}
```
## 高级用法
### 自定义Token
您可以通过使用 `WithToken` 选项在自定义锁的token功能：
```go
lock := redislock.New(ctx, redisClient,
redislock.WithToken("your token")
)
```
### 自定义锁超时时间
您可以通过使用 `WithTimeout` 选项在自定义锁的超时时间功能：
```go
lock := redislock.New(ctx, redisClient,
redislock.WithTimeout(time.Duration(10) * time.Second)
)
```
### 自动续期
您可以通过使用 `WithAutoRenew` 选项在获取锁时启用自动续约功能：
```go
lock := redislock.New(ctx, redisClient,
redislock.WithAutoRenew()
)
```
当使用自动续约时，锁会在获取后自动定期续约，以防止锁过期。要手动续约锁，可以调用 `Renew` 方法。
### 自旋锁
自旋锁是一种尝试在锁可用之前反复获取锁的方式，可以使用 `SpinLock` 方法来实现自旋锁：
```go
err := lock.SpinLock(time.Duration(5) * time.Second) // 尝试获取锁，最多等待5秒
if err != nil {
fmt.Println("自旋锁超时：", err)
return
}
defer lock.UnLock() // 解锁
// 在锁定期间执行任务
// ...
```
### 锁释放
如果您希望手动释放锁而不等待锁超时，您可以使用 `UnLock` 方法：
```go
err := lock.Lock()
if err != nil {
fmt.Println("锁获取失败：", err)
return
}
// 执行任务
err = lock.UnLock() // 手动释放锁
if err != nil {
fmt.Println("锁释放失败：", err)
return
}
```
## 注意事项
- 请确保您的 Redis 服务器设置正确，并且能够正常连接和运行。
- 在使用自动续约功能时，确保在任务执行期间没有出现长时间的阻塞，以免导致续约失败。
- 考虑使用适当的超时设置，以避免由于网络问题等原因导致死锁。
- 尽量保证使用相同的 key 来获取和释放锁，以确保正确性。
- 在使用锁的过程中，建议对关键代码块进行精心设计和测试，以避免出现竞态条件和死锁问题。
## 许可证
本库采用 MIT 进行授权。有关详细信息，请参阅 LICENSE 文件。