Redis Mutex 技术文档

1. 安装指南

要使用 Redis Mutex，首先需要确保您的环境中已经安装了 Redis。然后可以通过 Ruby 的 gem 包管理器来安装 Redis Mutex。

在命令行中执行以下命令：

gem install redis-mutex

确保在您的项目 Gemfile 中添加以下内容：

gem 'redis-mutex'

然后执行 bundle install 来安装依赖。

2. 项目的使用说明

Redis Mutex 是一个在 Ruby 中使用 Redis 实现的分布式互斥锁。它支持阻塞和非阻塞两种语义。

以下是一个基本的使用示例：

RedisMutex.with_lock(:your_lock_name) do
  # 在这里执行独占操作
end

或者使用以下方式：

mutex = RedisMutex.new(:your_lock_name)
if mutex.lock
  # 执行独占操作
  mutex.unlock
else
  puts "无法获取锁！"
end

默认情况下，当一个进程持有锁时，其他进程会等待总共 1 秒钟，每隔 100 毫秒检查一次锁是否被释放。如果 1 秒钟后锁仍未释放，则 lock 方法返回 false 并放弃。注意，如果您的任务运行时间超过 10 秒，锁会自动被移除，以避免因为任务挂掉导致死锁的情况。您可以根据需要配置这些时间值。

如果您希望在尝试获取锁失败时立即返回 false，可以将互斥锁模式设置为非阻塞。

3. 项目API使用文档

以下是 Redis Mutex 提供的一些方法：

mutex = RedisMutex.new(key, options)    # 配置互斥锁
mutex.lock                                # 尝试获取锁，失败时返回 false
mutex.lock!                               # 尝试获取锁，失败时抛出异常
mutex.unlock                              # 尝试释放锁，失败时返回 false
mutex.unlock!                             # 尝试释放锁，失败时抛出异常
mutex.locked?                             # 检查资源是否已经被锁定
mutex.with_lock                           # 尝试获取锁，执行块内的操作，然后返回块的结果。失败时抛出异常。

RedisMutex.sweep                         # 移除所有过期的锁
RedisMutex.with_lock(key, options)       # 快捷方式，创建互斥锁并立即执行 with_lock

key 参数可以是符号、字符串或任何响应 id 方法的 Ruby 对象。对于给定的键，RedisMutex: 前缀会自动添加。例如，如果您传递一个 Room 对象，其 id 为 123，实际在 Redis 中的键将会是 RedisMutex:Room:123。

initialize 方法接受几个选项：

:block  => 1    # 指定等待锁释放的秒数。如果需要非阻塞语义，请指定 0。（默认：1）
:sleep  => 0.1  # 指定在等待时的轮询间隔时间，单位为秒。（不推荐低于 0.01）（默认：0.1）
:expire => 10   # 指定锁被认为是过期的秒数，如果持锁者出现问题未能释放锁。（默认：10）

4. 项目安装方式

请参考“安装指南”部分的内容进行安装。

以上就是关于 Redis Mutex 的技术文档，通过上述内容，用户可以了解到如何安装、配置以及使用 Redis Mutex 来实现分布式系统中的互斥操作。