Node.js应用启动报错TypeError: redisClient.on不是函数求助

问题原因 #

你碰到的TypeError: redisClient.on is not a function错误，确实是依赖冲突或残留缓存导致的。安装redis-mock后，它可能篡改了redis模块的依赖结构或模块解析路径，就算卸载了这个包，Node.js的模块缓存、残留的node_modules文件或者锁文件（package-lock.json/yarn.lock）还是会让redis模块加载异常，使得createClient返回的对象缺失on方法——正常情况下Redis v4的客户端是支持事件监听的。

解决步骤 #

按以下顺序操作，彻底清理残留并修复依赖：

1. 清空Node.js模块缓存
   在项目根目录执行命令：

node --clear-module-cache

或者直接重启你的开发服务器，确保缓存完全清空。

2. 删除旧依赖目录和锁文件
   执行命令：

# 删除node_modules文件夹
rm -rf node_modules
# npm用户删除package-lock.json
rm package-lock.json
# yarn用户删除yarn.lock
rm yarn.lock

3. 重新安装所有依赖

npm install
# 用yarn的话执行yarn install

4. 验证Redis模块是否恢复正常
   在项目根目录新建一个临时测试文件test-redis.js，代码如下：

const redis = require('redis');
const client = redis.createClient({
  socket: {
    host: process.env.REDIS_HOST,
    port: process.env.REDIS_PORT,
  },
  password: process.env.REDIS_PASSWORD,
});

console.log('客户端on方法类型:', typeof client.on);
console.log('是否存在on方法:', typeof client.on === 'function');

// 尝试监听事件并连接
client.on('ready', () => console.log('测试：Redis连接就绪'));
client.on('error', err => console.log('测试：Redis连接错误', err));

client.connect().then(() => {
  console.log('测试：连接成功');
  client.quit();
}).catch(err => console.log('测试：连接失败', err));

运行这个测试文件：

node test-redis.js

如果输出显示是否存在on方法: true，说明Redis模块已恢复正常，再启动你的应用即可。

5. 排查是否有间接依赖引入redis-mock
   查看项目依赖树，确认没有其他依赖间接引入redis-mock：

npm list redis-mock

如果发现有间接依赖，可以执行npm dedupe来整理依赖，或者手动调整相关依赖的版本。

额外处理 #

如果以上步骤都无效，可以尝试强制安装Redis v4.6.4的精确版本：

npm install redis@4.6.4

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