如何正确使用Node.js事件

朴灿烈づ我的快乐病毒、 2022-04-24 11:20 71阅读 0赞

> 翻译：疯狂的技术宅  
> 原文：[https://medium.freecodecamp.org/how-to-keep-your-javascript-code-simple-and-easy-to-read-bff702523e7c][https_medium.freecodecamp.org_how-to-keep-your-javascript-code-simple-and-easy-to-read-bff702523e7c]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2V5ZW9mYW5nZWw_size_16_color_FFFFFF_t_70]

事件驱动的编程变得流行之前，在程序内部进行通信的标准方法非常简单：如果一个组件想要向另外一个发送消息，只是显式地调用了那个组件上的方法。但是在 *react* 中用的却是事件驱动而不是*调用*。

#### 事件的好处 ####

这种方法能够使组件**更加分离**。在我们继续写程序时，会识别整个过程中的事件，在正确的时间触发它们，并为每个事件附加一个或多个*事件监听器*，这使得\*\*功能扩展变得更加容易。\*\*我们可以为特定事件添加更多的 listener，而不必修改现有的侦听器或触发事件的应用程序部分。我们所谈论的是观察者模式。

![在这里插入图片描述][20190424213501256.png]

#### 设计一个事件驱动的体系结构 ####

对事件进行识别非常重要，我们不希望最终必须从系统中删除或替换现有事件，因为这可能会迫使我们删除或修改附加到事件上的众多侦听器。我的一般原则是*仅在业务逻辑单元完成执行时才考虑触发事件。*

假如你想在用户注册后发送一堆不同的电子邮件。注册过程本身可能会涉及许多复杂的步骤和查询，但从商业角度来看，这只是其中的*一个步骤*。每个要发送的电子邮件也是单独的步骤。因此，一旦注册完成马上就发布事件是很有意义的。于是我们附加了多个监听器，每个监听器负责发送一种类型的电子邮件。

Node的异步事件驱动架构具有一些被称为“emitters”的对象。它们发出命名事件，这些事件会调用被称为“listener”的函数。发出事件的所有对象都是 [EventEmitter][] 类的实例。使用它，我们可以创建自己的事件：

#### 一个例子 ####

让我们使用内置的 events 模块（我建议你查看这个文档：[https://nodejs.org/api/events.html）以获取对][https_nodejs.org_api_events.html] `EventEmitter` 的访问权限。

const EventEmitter = require('events');
    
    const myEmitter = new EventEmitter();
    
    module.exports = myEmitter;

这是我们的服务器端程序的一部分，它负责接收HTTP请求，保存新用户并发出事件：

const myEmitter = require('./my_emitter');
    
    // Perform the registration steps
    
    // Pass the new user object as the message passed through by this event.
    myEmitter.emit('user-registered', user);

附加一个监听器的单独模块：

const myEmitter = require('./my_emitter');
    
    myEmitter.on('user-registered', (user) => { 
      // Send an email or whatever.
    });

*将策略与实现分开*是一种非常好的做法。在这种情况下，策略意味着哪些 listener 订阅了哪些事件。实现意味着 listener 自己。

const myEmitter = require('./my_emitter');
    const sendEmailOnRegistration = require('./send_email_on_registration');
    const someOtherListener = require('./some_other_listener');
    
    myEmitter.on('user-registered', sendEmailOnRegistration);
    myEmitter.on('user-registered', someOtherListener);

module.exports = (user) => { 
      // Send a welcome email or whatever.
    }

这种分离使 listener 也可以被重复使用，它可以被附加到发送相同消息的其他事件上（用户对象）。同样重要的是 *当多个 listener 被附加到单个事件时，它们将按照附加的顺序同步执行*。因此 `someOtherListener` 将在 `sendEmailOnRegistration` 完成执行后运行。

但是，如果你希望自己的 listener 以异步方式运行，只需用 `setImmediate` 包装它们的实现，如下所示：

module.exports = (user) => { 
      setImmediate(() => { 
        // Send a welcome email or whatever.
      });
    }

#### 让你的 Listeners 保持简洁 ####

在写 listener 时要坚持单一责任原则。一个 listener 应该只做一件事并把事情做好。例如：要避免在 listener 中编写太多的条件并根据事件传来的数据（消息）去决定做什么。在这种情况下使用不同的事件会更加合适：

const myEmitter = require('./my_emitter');
    
    // Perform the registration steps
    
    // The application should react differently if the new user has been activated instantly.
    if (user.activated) { 
      myEmitter.emit('user-registered:activated', user);
      
    } else { 
      myEmitter.emit('user-registered', user);
    }

const myEmitter = require('./my_emitter');
    const sendEmailOnRegistration = require('./send_email_on_registration');
    const someOtherListener = require('./some_other_listener');
    const doSomethingEntirelyDifferent = require('./do_something_entirely_different');
    
    
    myEmitter.on('user-registered', sendEmailOnRegistration);
    myEmitter.on('user-registered', someOtherListener);
    
    myEmitter.on('user-registered:activated', doSomethingEntirelyDifferent);
    view raw

#### 必要时明确分离 Listener ####

在前面的例子中，我们的 listener 是完全独立的函数。但是在 listener 与对象关联的情况下（这时是一种方法），必须手动将其从已订阅的事件中分离出来。否则对象将永远不会被垃圾回收，因为对象（ listener ）的一部分将会继续被外部对象（ emitter ）引用，所以存在内存泄漏的可能。

例如，如果我们正在开发一个聊天程序，并且希望当新消息到达用户进入的聊天室时，显示通知的功能应该位于该用户对象本身的内部，我们可能会这样做：

class ChatUser { 
      
      displayNewMessageNotification(newMessage) { 
        // Push an alert message or something.
      }
      
      // `chatroom` is an instance of EventEmitter.
      connectToChatroom(chatroom) { 
        chatroom.on('message-received', this.displayNewMessageNotification);
      }
    
      disconnectFromChatroom(chatroom) { 
        chatroom.removeListener('message-received', this.displayNewMessageNotification);
      }
    }

当用户关闭他的标签或暂时断开互联网连接时，我们可能希望在服务器端发起一个回调，通知其他用户有人刚刚下线。当然在这时为脱机用户调用 `displayNewMessageNotification` 没有任何意义。除非我们删除它，否则它将继续被用于调用新消息。如果不这样做，除了不必要的调用之外，用户对象也会被永久地保留在内存中。因此在用户脱机时应该在服务器端回调中调用 `disconnectFromChatroom`。

#### 注意事项 ####

如果不小心，即便是松散耦合的事件驱动架构也会导致复杂性的增加，可能会导致在系统中跟踪依赖关系变得很困难。如果我们从侦听器内部发出事件，程序会特别容易出现这类问题。这可能会触发意外的事件链。

--------------------

欢迎关注微信公众号：前端先锋，每天第一时间阅读最新技术文章。

![SouthEast][]

[https_medium.freecodecamp.org_how-to-keep-your-javascript-code-simple-and-easy-to-read-bff702523e7c]: https://medium.freecodecamp.org/how-to-keep-your-javascript-code-simple-and-easy-to-read-bff702523e7c
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2V5ZW9mYW5nZWw_size_16_color_FFFFFF_t_70]: /images/20220215/ebef75af19534486a2f27bfcb1080647.png
[20190424213501256.png]: /images/20220215/9835761cfbbb4cd0a0b2519dfa9159f1.png
[EventEmitter]: https://nodejs.org/api/events.html#events_class_eventemitter
[https_nodejs.org_api_events.html]: https://nodejs.org/api/events.html%EF%BC%89%E4%BB%A5%E8%8E%B7%E5%8F%96%E5%AF%B9
[SouthEast]: /images/20220215/78a8b2572add4df198719899f5258041.png