如何在Next.js API中像使用MongoDB一样调用Node Redis？

问题根源 #

• 导出语法错误：你代码里写的是module.export，正确语法为module.exports，该错误会导致Node.js无法正确缓存模块，每次导入工具文件都会重新执行初始化逻辑创建新的Redis连接。
• 缺少错误监听逻辑：仅监听了connect事件，没有监听error事件，无法捕获连接阶段的具体报错信息，ECONNREFUSED本质是Redis客户端无法和服务端建立连接导致的报错。
• 未适配Next.js运行机制：Next.js开发环境下热重载会清除普通模块缓存，即使导出语法正确，每次修改代码重编译后还是会创建新的连接实例，和MongoDB单例适配逻辑一致，需要把连接实例挂载到全局对象上做缓存。

修复后的工具文件代码 #

/* ------ 连接Redis单例工具 ------ */
const redis = require('redis');
const { promisify } = require('util');

// 适配开发环境热重载，全局缓存Redis实例
let client = global.redisClient;
if (!client) {
  client = redis.createClient({
    host: process.env.REDIS_HOSTNAME,
    port: process.env.REDIS_PORT,
    password: process.env.REDIS_PASSWORD
  });
  // 开发环境下挂载到全局对象
  if (process.env.NODE_ENV !== 'production') global.redisClient = client;

  client.on('connect', () => {
    console.log('connected to redis');
  });

  client.on('error', (err) => {
    console.error('Redis connection error:', err);
  });
}

/* promisify封装异步方法 */
const redisHget = promisify(client.hget).bind(client);
const redisHset = promisify(client.hset).bind(client);

module.exports = { redisHget, redisHset };

ECONNREFUSED报错排查点 #

• 确认环境变量正确加载：在创建client前打印三个环境变量process.env.REDIS_HOSTNAME、process.env.REDIS_PORT、process.env.REDIS_PASSWORD，确认值和Redis Labs控制台给出的配置一致。
• 确认IP白名单配置：Redis Labs默认会限制访问IP，需要把你本地开发的公网IP、生产环境服务器IP添加到Redis Labs实例的访问白名单中。
• 确认Redis客户端版本：如果你使用的是v4及以上版本的redis npm包，createClient的配置格式发生了变化，不再支持根参数直接传host、port、password，需要调整为如下配置：

  client = redis.createClient({
    socket: {
      host: process.env.REDIS_HOSTNAME,
      port: process.env.REDIS_PORT
    },
    password: process.env.REDIS_PASSWORD
  });
  // v4默认返回promise不需要手动promisify，连接需要主动调用client.connect()
  await client.connect()
  

内容的提问来源于stack exchange，提问作者Cloyd Abad