Redis Client for Node.js 技术文档

1. 安装指南

环境要求

• Node.js 版本至少为 v0.1.90
• Redis 版本至少为 1.3.8

安装方式

方式一：直接复制文件

1. 从 GitHub 仓库克隆或下载 tarball。
2. 将 lib/redis-client.js 文件复制到你的项目中。

方式二：使用 Git Submodule

1. 在你的项目中添加该仓库作为 submodule：

   git submodule add https://github.com/fictorial/redis-node-client.git
   

2. 将 lib/redis-client.js 文件引入你的项目。

方式三：使用 Kiwi 包管理器

1. 安装 Kiwi：

   npm install kiwi
   

2. 使用 Kiwi 安装 redis-client：

   kiwi install redis-client
   

3. 在你的代码中引入：

   var kiwi = require("kiwi"),
       client = kiwi.require("redis-client").createClient();
   

2. 项目的使用说明

基本使用

从 Git 克隆使用

var sys = require("sys");
var client = require("../lib/redis-client").createClient();
client.info(function (err, info) {
    if (err) throw new Error(err);
    sys.puts("Redis Version is: " + info.redis_version);
    client.close();
});

使用 Kiwi 安装

var sys = require("sys"), 
    kiwi = require("kiwi"),
    client = kiwi.require("redis-client").createClient();

client.info(function (err, info) {
    if (err) throw new Error(err);
    sys.puts("Redis Version is: " + info.redis_version);
    client.close();
});

示例代码

• 参考 test/test.js 文件中的测试代码，了解如何使用该客户端。
• 参考 examples/ 目录下的示例代码，获取更多使用场景。

3. 项目API使用文档

基本命令

每个 Redis 命令在客户端中都有对应的方法。例如，Redis 命令 SETNX 对应客户端方法 client.setnx。

示例：INCRBY 命令

Redis 命令 INCRBY key integer 的客户端调用方式如下：

client.incrby('foo', 42, function (err, newValue) {
    if (err) throw new Error(err);
    sys.puts("New value is: " + newValue);
});

PUBSUB 命令

对于 PUBSUB 命令，建议使用 subscribeTo 和 unsubscribeFrom 方法，而不是直接使用 SUBSCRIBE 和 UNSUBSCRIBE 命令。

示例：订阅与取消订阅

client.subscribeTo('channelName', function (channel, message) {
    sys.puts("Received message: " + message + " from channel: " + channel);
});

client.unsubscribeFrom('channelName', function (channel) {
    sys.puts("Unsubscribed from channel: " + channel);
});

4. 项目安装方式

直接复制文件

1. 从 GitHub 仓库克隆或下载 tarball。
2. 将 lib/redis-client.js 文件复制到你的项目中。

使用 Git Submodule

1. 在你的项目中添加该仓库作为 submodule：

   git submodule add https://github.com/fictorial/redis-node-client.git
   

2. 将 lib/redis-client.js 文件引入你的项目。

使用 Kiwi 包管理器

1. 安装 Kiwi：

   npm install kiwi
   

2. 使用 Kiwi 安装 redis-client：

   kiwi install redis-client
   

3. 在你的代码中引入：

   var kiwi = require("kiwi"),
       client = kiwi.require("redis-client").createClient();
   

通过以上步骤，你可以成功安装并使用 Redis Client for Node.js。