em-hiredis 技术文档

以下是对 em-hiredis 项目的一个详细技术文档，包含安装指南、使用说明、API 使用文档以及安装方式。

1. 安装指南

依赖

• Ruby 环境
• EventMachine
• Redis 服务器

安装步骤

1. 确保已安装 Redis 服务器并正在运行。
2. 使用 Ruby 的包管理器（如 gem）安装 em-hiredis：

gem install em-hiredis

3. 确保已经安装 EventMachine：

gem install eventmachine

4. 如果使用特定版本的 Redis 服务器或 EventMachine，请根据需要进行调整。

2. 项目使用说明

连接 Redis

使用以下代码连接到 Redis 服务器：

require 'em-hiredis'
redis = EM::Hiredis.connect

可以通过以下方式使用 Redis URL 连接到不同的主机、端口、密码或数据库：

redis = EM::Hiredis.connect("redis://:[e-mail]:9000/4")

发送命令

所有 Redis 命令都可以直接发送，并且返回一个可延迟对象（deferrable）。例如：

redis.set('foo', 'bar').callback {
  redis.get('foo').callback { |value|
    p [:returned, value]
  }
}

如果 Redis 返回错误，或者 Redis 连接在命令返回之前断开，可延迟对象将失败。

连接状态

当 Redis 服务器连接关闭时，将发出 :disconnected 事件，并且连接将立即尝试重新连接。如果连接重新连接成功，将发出 :connected 事件。

如果重新连接失败，将发出 :reconnect_failed 事件（而不是 :disconnected），并将在超时后（默认为 0.5 秒，可以通过 EM::Hiredis.reconnect_timeout= 设置）重试连接。

如果客户端连续 4 次尝试重新连接失败，将发出 :failed 事件，并且所有排队等待的 Redis 命令将失败。

3. 项目 API 使用文档

订阅（Pubsub）

在 em-hiredis 中，EM::Hiredis::Client 类不再理解 pubsub 消息，这部分逻辑已移至 EM::Hiredis::PubsubClient 类。可以创建一个直接连接到相同 Redis 服务器的 pubsub 客户端，或者通过在现有 EM::Hiredis::Client 实例上调用 #pubsub 来获取。

接近金属的 pubsub 接口

基本方法是绑定到 :message 和 :pmessage 事件：

redis = EM::Hiredis.connect
pubsub = redis.pubsub

pubsub.subscribe('bar.0').callback { puts "Subscribed" }
pubsub.psubscribe('bar.*')

pubsub.on(:message) { |channel, message|
  p [:message, channel, message]
}

pubsub.on(:pmessage) { |key, channel, message|
  p [:pmessage, key, channel, message]
}

丰富的 pubsub 接口

如果将块传递给 subscribe 或 psubscribe，则该块将在订阅接收到消息时被调用：

```ruby
redis = EM::Hiredis.connect

puts "Subscribing"
redis.pubsub.subscribe("foo") { |msg|
  p [:sub1, msg]
}

redis.pubsub.psubscribe("f*") { |channel, msg|
  p [:sub2, msg]
}

Lua 脚本

可以使用 EVAL 或 EVALSHA 直接调用 Lua 脚本；以下是一个更高级的 API。

在 Redis 客户端上注册命名命令将在客户端上定义一个具有给定名称的 Ruby 方法：

redis.register_script(:multiply, <<-END)
  return redis.call('get', KEYS[1]) * ARGV[1]
END

该方法的调用方式与任何其他 Redis 命令类似；唯一的区别是第一个参数必须是键的数组，第二个（可选）是值的数组。

# 将键 foo 的值乘以 2
redis.multiply(['foo'], [2]).callback { ... }

Lua 命令使用 EVALSHA 提交以实现效率。如果 Redis 返回 NOSCRIPT 错误，该命令将自动使用 EVAL 重新提交；这对代码完全透明，中间的“失败”不会传递到回调。

活跃性检查

有时网络连接可能以难以检测的方式挂起，或者涉及非常长的超时时间才能从应用程序层检测到。这对于 Redis Pubsub 连接尤其如此，因为它们不是基于请求-响应的。对于监听客户端来说，区分挂起的连接和没有任何消息的服务器非常困难。

要启动测试连接活跃性的应用程序层乒乓机制，请随时在客户端上调用以下命令：

redis.configure_inactivity_check(5, 3)

这配置了如果 5 秒内没有从服务器接收任何数据，则发送 PING 命令，如果再经过 3 秒，则触发重新连接。

4. 项目安装方式

如前所述，项目的安装方式如下：

1. 确保已安装 Redis 服务器并正在运行。
2. 使用 Ruby 的包管理器（如 gem）安装 em-hiredis：

gem install em-hiredis

3. 确保已经安装 EventMachine：

gem install eventmachine

通过上述步骤，您可以成功安装 em-hiredis 项目，并开始使用其功能。