本文将指导您如何在 Sealos DevBox 项目中使用 Node.js 连接和操作 Redis 数据库。

准备工作

安装依赖包

在 Cursor 终端中执行以下命令安装必要的依赖包：

npm install redis dotenv

该命令将安装以下依赖：

redis：Node.js 的 Redis 客户端库
dotenv：用于从 .env 文件中加载环境变量的零依赖模块

配置连接

配置环境变量

首先，在项目根目录创建 .env 文件，添加以下数据库连接配置：

.env

REDIS_HOST=your_redis_host
REDIS_PORT=6379
REDIS_PASSWORD=your_redis_password

请将上述配置项替换为您从 Sealos 数据库应用中获取的实际 Redis 连接信息。

创建数据库连接文件

接下来，创建 redisClient.js 文件并添加以下代码：

redisClient.js

const redis = require('redis');
require('dotenv').config();
 
const client = redis.createClient({
  url: `redis://${process.env.REDIS_HOST}:${process.env.REDIS_PORT}`,
  password: process.env.REDIS_PASSWORD
});
 
client.on('error', (err) => console.log('Redis Client Error', err));
 
async function connectRedis() {
  await client.connect();
}
 
module.exports = { client, connectRedis };

此文件创建了 Redis 客户端实例并导出客户端对象及其连接方法。

编写测试脚本

创建 test-redis.js 文件来测试基本的 Redis 操作：

test-redis.js

const { client, connectRedis } = require('./redisClient');
 
async function testRedisOperations() {
  try {
    await connectRedis();
    console.log('Connected to Redis');
 
    // Set a key
    await client.set('mykey', 'Hello from Sealos DevBox!');
    console.log('Key set successfully');
 
    // Get a key
    const value = await client.get('mykey');
    console.log('Retrieved value:', value);
 
    // Set a hash
    await client.hSet('myhash', 'field1', 'value1');
    await client.hSet('myhash', 'field2', 'value2');
    console.log('Hash set successfully');
 
    // Get hash fields
    const hashValue = await client.hGetAll('myhash');
    console.log('Retrieved hash:', hashValue);
 
    // Close the connection
    await client.quit();
    console.log('Redis connection closed');
  } catch (error) {
    console.error('An error occurred:', error);
  }
}
 
testRedisOperations();

该测试脚本演示了如何连接 Redis 数据库并执行基本的键值对和哈希表操作。

运行测试

在 Cursor 终端中执行以下命令运行测试脚本：

node test-redis.js

执行后，脚本将连接 Redis 数据库并依次执行各项测试操作。

最佳实践

始终使用环境变量管理数据库连接信息
实现适当的错误处理和重连机制
使用 async/await 编写清晰的异步代码
及时关闭不再使用的数据库连接
在生产环境中考虑使用连接池以提升性能

常见问题排查

如果遇到连接问题，请按以下步骤排查：

检查 .env 文件中的 Redis 连接信息是否正确
确认 Redis 数据库实例是否正常运行且可访问
检查 DevBox 运行环境的网络配置是否有限制
验证 redis 依赖包是否正确安装

更多关于 Node.js Redis 客户端的详细信息，请参考 Node Redis 官方文档。

Node.js

本页导航