node-redis 指南（JavaScript）

提示

来自deepseek解释

原文链接：https://redis.io/docs/latest/develop/clients/nodejs/

node-redis 是 Redis 的 Node.js/JavaScript 客户端。 以下各节说明如何安装 node-redis 并将您的应用程序连接到 Redis 数据库。

node-redis 是 Node.js/JavaScript 的推荐客户端库， 但我们也支持并记录较旧的 JavaScript 客户端 ioredis。如果您有兴趣将现有的 ioredis 项目转换为 node-redis，请参见从 ioredis 迁移。

node-redis 需要一个正在运行的 Redis 服务器。请参见此处获取 Redis 开源版的安装说明。

您也可以使用对象映射客户端接口访问 Redis。更多信息请参见 RedisOM for Node.js。

安装

要安装 node-redis，请运行：

npm install redis

连接与测试

连接到 localhost 的 6379 端口。

import { createClient } from 'redis';

const client = createClient();

client.on('error', err => console.log('Redis Client Error', err));

await client.connect();

存储并检索一个简单的字符串。

await client.set('key', 'value');
const value = await client.get('key');
console.log(value);

存储并检索一个映射（哈希）。

await client.hSet('user-session:123', {
    name: 'John',
    surname: 'Smith',
    company: 'Redis',
    age: 29
});

let userSession = await client.hGetAll('user-session:123');
console.log(JSON.stringify(userSession, null, 2));

要连接到不同的主机或端口，请使用格式为 redis[s]://[[username][:password]@][host][:port][/db-number] 的连接字符串：

createClient({
  url: 'redis://alice:foobared@awesome.redis.server:6380'
});

要检查客户端是否已连接并准备好发送命令，请使用 client.isReady，它返回一个布尔值。client.isOpen 也可用。当客户端的底层套接字打开时返回 true，否则返回 false（例如，当客户端仍在连接或在网络错误后重新连接时）。

完成连接使用后，使用 client.quit() 关闭它。

await client.quit();

更多信息

node-redis 网站 上有更多示例。 GitHub 仓库 也包含有用的信息，包括您可以使用连接配置选项的指南。

更多信息和示例请参见本节中的其他页面。