Redis Node.js客户端使用示例详解-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00223/article/details/148375602

Redis Node.js客户端使用示例详解

node-redis redis/node-redis: Node-Redis 是一个用于 Node.js 的 Redis 客户端库，可以用于连接和操作 Redis 数据库，支持多种 Redis 数据类型和命令，如字符串，哈希表，列表，集合等。项目地址: https://gitcode.com/gh_mirrors/no/node-redis

Redis是一个高性能的键值数据库，而node-redis是Redis官方推荐的Node.js客户端库。本文将通过分析node-redis示例项目中的典型场景，帮助开发者掌握Redis在Node.js环境中的各种高级用法。

基础连接示例

检查连接状态

check-connection-status.js展示了如何检查客户端连接状态。在实际开发中，连接状态的监控至关重要：

// 创建客户端并检查连接状态
const client = createClient();

// 监听连接事件
client.on('connect', () => console.log('正在连接...'));
client.on('ready', () => console.log('已连接'));
client.on('end', () => console.log('连接关闭'));
client.on('error', (err) => console.log('Redis错误', err));

await client.connect();

集群连接

connect-to-cluster.js演示了如何连接Redis集群。在分布式环境中，正确处理集群连接是基础：

const cluster = createCluster({
  rootNodes: [
    { url: 'redis://localhost:30001' },
    { url: 'redis://localhost:30002' }
  ]
});

数据结构操作示例

列表阻塞操作

blocking-list-pop.js展示了BLPOP命令的使用，这是实现消息队列的常见模式：

// 从列表左侧阻塞弹出元素
const result = await client.blPop('myqueue', 0); // 0表示无限等待
console.log(result); // { key: 'myqueue', element: 'value' }

有序集合

sorted-set.js演示了ZADD和ZSCAN的用法，适合排行榜等场景：

// 添加成员和分数
await client.zAdd('leaderboard', [
  { score: 100, value: 'player1' },
  { score: 200, value: 'player2' }
]);

// 迭代查询
for await (const member of client.zScanIterator('leaderboard')) {
  console.log(member);
}

高级数据结构示例

HyperLogLog

hyperloglog.js展示了基数统计功能，适合UV统计等场景：

// 添加元素到HyperLogLog
await client.pfAdd('hll', ['user1', 'user2']);

// 获取基数估计
const count = await client.pfCount('hll');

流处理

stream-producer.js和stream-consumer.js展示了Redis流的发布订阅模式：

// 生产者添加消息
await client.xAdd('mystream', '*', {
  name: 'John',
  age: '30'
});

// 消费者读取消息
const messages = await client.xRead(
  { key: 'mystream', id: '0' },
  { BLOCK: 0 } // 阻塞等待
);

Redis模块集成示例

RedisJSON操作

managing-json.js展示了RedisJSON模块的使用：

// 设置JSON数据
await client.json.set('user:1', '$', {
  name: 'Alice',
  age: 30
});

// 获取JSON字段
const name = await client.json.get('user:1', {
  path: '$.name'
});

RediSearch应用

search-json.js结合了RedisJSON和RediSearch的强大功能：

// 创建索引
await client.ft.create('idx:users', {
  '$.name': { type: 'TEXT' },
  '$.age': { type: 'NUMERIC' }
}, {
  ON: 'JSON'
});

// 搜索JSON文档
const results = await client.ft.search('idx:users', '@age:[30 40]');

高级特性示例

事务处理

transaction-with-watch.js展示了乐观锁事务：

const key = 'counter';
await client.watch(key);

const value = parseInt(await client.get(key)) || 0;

const multi = client.multi();
multi.set(key, value + 1);

const results = await multi.exec(); // 如果key被修改则返回null

Lua脚本

lua-multi-incr.js演示了如何使用Lua脚本实现原子操作：

const script = `
  for i, key in ipairs(KEYS) do
    redis.call('INCRBY', key, ARGV[i])
  end
`;

await client.eval(script, {
  keys: ['key1', 'key2'],
  arguments: ['10', '20']
});