升级connect-redis至6.1.3后RedisStore客户端错误的解决方法

问题原因 #

connect-redis从v6版本开始，不再支持通过redisStore(session)的方式构造，也不再允许直接通过url参数自动创建Redis客户端，必须手动创建Redis客户端实例并传入RedisStore。

修复步骤 #

1. 首先安装Redis客户端包（二选一即可，推荐官方redis包）：

npm install redis
# 或选择ioredis
npm install ioredis

2. 修改代码如下：

import redisStore from 'connect-redis';
import session from 'express-session';
import { createClient } from 'redis'; // 导入redis客户端
import config from '../config/conf';

// 创建Redis客户端实例并建立连接
const redisClient = createClient({
  url: process.env.SESSION_REDIS_URL
});
redisClient.connect().catch(console.error);

// 初始化RedisStore（v6+无需再传入session）
const RedisStore = redisStore(session);
const sessionStore = new RedisStore({
  client: redisClient, // 直接传入已创建的客户端实例
});

const sessionConfig = {
  name: 'os.sid',
  store: sessionStore,
  saveUninitialized: false,
  resave: false,
  secret: config.sessionSecret,
  secure: config.isProduction,
  cookie: {
    path: '/',
    httpOnly: true,
    secure: config.isProduction,
    maxAge: null,
  },
};

相关问题帖内容翻译 #

该帖是用户升级connect-redis到v6后遇到相同错误的讨论，核心回复如下：

connect-redis v6版本不再自动创建Redis客户端，你需要自行初始化一个Redis客户端（使用redis或ioredis包），然后将其作为client选项传给RedisStore。旧版本中通过url或其他参数自动创建客户端的方式已被移除，目的是让用户更灵活地控制Redis客户端的配置和生命周期。

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