Node.js中如何在index.js连接Redis并共享至各路由？

问题核心 #

你希望在项目入口（index.js）中一次性建立Redis连接，导出客户端供所有路由复用，避免第一种方法中每次请求都执行connect()和disconnect()的冗余操作。第二种方法导出redisClient时返回undefined，本质是Node.js模块加载机制导致的异步初始化问题。

问题原因 #

Node.js模块加载是同步执行的：你在异步立即执行函数（IIFE）中给redisClient赋值，但模块导出时这个异步函数还未执行完成，redisClient仍保持初始的undefined状态，因此其他模块导入时拿到的就是undefined。

解决方案 #

方案1：导出获取客户端的异步函数

通过封装异步函数确保获取到已连接的Redis客户端，同时实现单例复用：

// index.js
const mongoose = require('mongoose');
const app = require('./app');
const config = require('./config/config');
const logger = require('./config/logger');
const redis = require('redis');
mongoose.Promise = require('bluebird');

let server;
let redisClient;

async function getRedisClient() {
  // 单例模式：仅初始化一次
  if (!redisClient) {
    redisClient = redis.createClient({
      socket: {
        host: '',
        port: '',
      },
      password: '',
    });

    redisClient.on('connect', () => {
      console.log('✅ 💃 Successfully connected to Redis!');
    });
    redisClient.on('error', (error) => console.error(`Error  : ${error}`));

    await redisClient.connect();
  }
  return redisClient;
}

// 并行初始化MongoDB和Redis服务
async function initServices() {
  await getRedisClient();
  await mongoose.connect(config.mongoose.url, config.mongoose.options);
  logger.info('Connected to MongoDB');
}

// 启动服务器
initServices().then(() => {
  server = app.listen(config.port, () => {
    logger.info(`Listening to port ${config.port}`);
  });
}).catch(err => {
  logger.error('Failed to initialize services:', err);
  process.exit(1);
});

// 导出获取客户端的方法
module.exports = { getRedisClient };

路由中使用方式：

// someRoute.route.js
const express = require('express');
const { getRedisClient } = require('../../index');

const router = express.Router();

router.route('/test').get(async (req, res) => {
  const redisClient = await getRedisClient();
  await redisClient.zAdd('$200', { score: 1, value: 'value' });
  res.send({});
});

方案2：确保Redis连接完成后再启动服务器

将Redis连接逻辑与服务器启动绑定，保证客户端初始化完成后再处理请求，直接导出已连接的客户端：

// index.js
const mongoose = require('mongoose');
const app = require('./app');
const config = require('./config/config');
const logger = require('./config/logger');
const redis = require('redis');
mongoose.Promise = require('bluebird');

let server;
let redisClient;

// 初始化所有服务
async function init() {
  // 初始化Redis
  redisClient = redis.createClient({
    socket: {
      host: '',
      port: '',
    },
    password: '',
  });

  redisClient.on('connect', () => {
    console.log('✅ 💃 Successfully connected to Redis!');
  });
  redisClient.on('error', (error) => console.error(`Error  : ${error}`));

  await redisClient.connect();

  // 初始化MongoDB
  await mongoose.connect(config.mongoose.url, config.mongoose.options);
  logger.info('Connected to MongoDB');

  // 启动服务器
  server = app.listen(config.port, () => {
    logger.info(`Listening to port ${config.port}`);
  });
}

init().catch(err => {
  logger.error('Initialization failed:', err);
  process.exit(1);
});

// 导出客户端（服务器启动后已确保连接完成）
module.exports = { redisClient };

路由中使用方式：

// someRoute.route.js
const express = require('express');
const { redisClient } = require('../../index');

const router = express.Router();

router.route('/test').get(async (req, res) => {
  await redisClient.zAdd('$200', { score: 1, value: 'value' });
  res.send({});
});

方案优势 #

两种方案都实现了Redis连接的单例复用，避免了每次请求建立/断开连接的性能开销，同时解决了异步初始化导致的导出undefined问题。

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