Redis客户端ioredis使用手册

ioredis 是一个为Node.js打造的强大、高性能且特性齐全的Redis客户端库。它不仅支持最新的Redis版本，还拥有众多高级特性和易用的API设计。本文档旨在引导您快速上手ioredis，了解其安装方法、基础使用、API应用以及配置连接细节。

安装指南

要在您的Node.js项目中使用ioredis，首先需要通过npm进行安装：

npm install ioredis

对于使用TypeScript的项目，确保添加Node.js类型定义以获得更好的代码提示：

npm install --save-dev @types/node

项目使用说明

快速启动

一旦安装完毕，您可以立即创建并使用ioredis实例来执行Redis命令：

const Redis = require('ioredis');

// 默认连接至本地Redis服务（127.0.0.1:6379）
const redis = new Redis();

redis.set('mykey', 'value').then(res => console.log(res)); // 输出："OK"

// 回调风格的使用
redis.get('mykey', (error, value) => {
    if(error) return console.error(error);
    console.log(value); // 输出："value"
});

// 或者使用Promise风格
redis.get('mykey').then(value => console.log(value)); // 同样输出："value"

连接到特定Redis服务器

您可以指定不同的主机、端口或Unix套接字来连接到其他Redis实例：

new Redis(6380); // 连接到本机6380端口
new Redis('/path/to/your/socket'); // 使用Unix套接字连接
new Redis({ host: '192.168.1.1', port: 6379 }); // 指定IP和端口

并且可以包含认证信息：

new Redis({
    host: 'localhost',
    port: 6379,
    password: 'your-password',
    username: 'default', // Redis 6及以上版本支持用户名
});

API使用文档概览

ioredis支持所有Redis命令，并提供了简洁的API。例如，以下是如何使用zrange命令的例子：

redis.zadd('sortedSet', 1, 'one', 2, 'two', 3, 'three');
redis.zrange('sortedSet', 0, 2, 'WITHSCORES')
    .then(console.log); // 输出类似：["one", "1", "two", "2", "three", "3"]

对于详细的API文档，访问官方文档。

TLS选项

若要通过TLS加密连接Redis，可以在创建实例时提供TLS相关选项：

const redisSecure = new Redis({
    port: 6379,
    host: 'ssl.redis.example.com',
    tls: {},
});

其他高级功能

• Pub/Sub：利用Redis的发布/订阅模式，ioredis通过事件监听实现高效的消息传递。
• Pipeline：批量发送命令以提高性能。
• Sentinel和Cluster支持：自动处理主从切换和集群节点发现。
• 脚本和自定义命令：利用Lua脚本或定义新的Redis命令。

总结

ioredis的设计使得在Node.js环境中操作Redis变得简单而强大。无论是基本的数据操作还是复杂的集群管理，它都能提供健壮的支持。遵循上述指南，您将能够充分利用ioredis的所有功能，优化您的Redis应用体验。记得查看ioredis的官方文档获取完整的API参考和进阶使用方法。