如何移除Node.js中pty.js实例的.on()事件监听函数？

问题描述 #

我在Node.js中使用pty.js编写了如下代码，用来维持一个持久的SSH终端会话（即使用户关闭浏览器也不终止）：

if (!global.terminal) global.terminal = pty.spawn('ssh', [sshuser + sshhost, '-p', sshport, '-o', 'PreferredAuthentications=' + sshauth], { name: 'xterm-256color', cols: 80, rows: 28 });
var term1 = global.terminal;
term1.on('data', function(data) { socket.emit('output1', data); console.log('on data: ' + data); });

我没有调用term1.end()，因为希望保留会话，但现在需要移除这个data事件的监听函数，请问该怎么做？

解决方案 #

嘿，这个问题其实在Node.js的事件驱动体系里有明确的处理方式，核心要点是你得持有监听函数的引用——这也是你当前代码的小问题：你用了匿名函数，没法直接引用它来移除监听。我给你一步步说怎么改：

1. 把匿名监听函数改成具名函数 #

首先重构你的代码，把原来的匿名回调抽成一个有名字的函数，这样后续就能精准定位它来移除监听：

// 先定义好具名的监听函数
function handleTerminalData(data) {
  socket.emit('output1', data);
  console.log('on data: ' + data);
}

// 初始化终端并绑定事件
if (!global.terminal) {
  global.terminal = pty.spawn(
    'ssh', 
    [sshuser + sshhost, '-p', sshport, '-o', 'PreferredAuthentications=' + sshauth], 
    { name: 'xterm-256color', cols: 80, rows: 28 }
  );
}
const term1 = global.terminal;
term1.on('data', handleTerminalData);

2. 移除指定的事件监听 #

当你需要取消这个data事件的监听时，直接调用removeListener方法（Node.js v10+也支持等价的off方法，写法更简洁）：

// 使用removeListener移除监听
term1.removeListener('data', handleTerminalData);

// 或者用off方法，效果完全一样
// term1.off('data', handleTerminalData);

额外补充 #

• 如果你需要一次性移除这个终端实例上所有的data事件监听（比如有多个不同的回调绑定了这个事件），可以用removeAllListeners：

  term1.removeAllListeners('data');
  

  不过这个要谨慎用，它会清掉该事件下的所有监听，别误删了其他有用的回调。
• 因为你的终端实例存在global上，记得移除监听时要确保能正确拿到这个实例的引用，别出现找不到global.terminal的情况哦。

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