npm 包 moleculer 使用教程

阅读时长 8 分钟读完

前言

随着前端技术的不断发展,前端工作中所涉及到的内容也越来越多。其中,后端服务的封装是前端开发者不可忽略的一部分。为了避免重复造轮子,开发者们采用了各种各样的开源库来解决问题。其中,npm 包 moleculer 就是在后端服务封装中经常使用的一款库。本文将带领大家详细了解 moleculer 的使用方法,包括其核心概念、基本操作、生命周期和服务发现等。

moleculer 简介

moleculer 是一款现代化的微服务框架,主要用于解决分布式系统中服务之间的调用问题。其最大的特点是轻量级和易于使用,支持多种开箱即用的传输机制和序列化协议,例如 NodeJS 本地传输、TCP、Redis、NATS、MQTT、AMQP 等。除此之外,moleculer 还具有高扩展性、高度可靠性等特点,从而在云原生、微服务、IOT 等不同领域中得到了广泛应用。

核心概念

在学习 moleculer 之前,需要先了解其中的一些核心概念。下面是 moleculer 中的几个重要概念:

服务(Service)

服务是 moleculer 中最基本的单元。每个服务都是独立的、可传输的,并且使用 API Gateway 为其他服务提供服务。服务有多种类型,包括普通服务、网关服务和中间件等。

动作(Action)

动作是服务中的最小单元,用于执行某些操作并返回结果。每个动作都有一个名称和一个处理程序(handler)。其中处理程序可以是同步函数,也可以是异步函数。

事件(Event)

事件是 moleculer 中另一个非常重要的概念。一个事件通常代表服务中的某些状态发生了变化,或者是发生了一些错误等。事件可以被其他服务或客户端监听。

生命周期钩子(Hook)

钩子是在服务生命周期中被调用的回调函数。它们可以帮助我们做一些必要的初始化或清理操作,例如在服务启动时连接数据库,在服务停止时断开连接等。

中间件(Middleware)

中间件是在执行动作前后执行的一个函数,它可以进行某些修改和逻辑处理。它可以用于实现各种功能,例如身份验证、日志记录和性能测量等。

基本操作

接下来,我们将介绍 moleculer 中的基本操作。在开始学习之前,我们需要先安装 moleculer。

创建服务

要创建一个新的服务,我们需要创建一个 JavaScript 文件,然后声明一个名为 broker 的 moleculer 实例,并在其中定义我们的服务逻辑。例如:

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

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

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

上述代码中,我们定义了一个名为 greeter 的服务,其中有一个 hello 动作。当用户调用该动作并传递参数 name 时,服务将返回 Hello, [name]!

调用服务

要调用服务,我们需要在调用代码中声明一个 moleculer 实例,并使用它来调用服务。

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

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

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

上述代码中,我们首先启动了 moleculer 实例,然后调用了 greeter 服务中的 hello 动作,并传递了一个名为 John 的参数。最后,打印出了服务的返回结果,并停止 moleculer 实例。

订阅事件

要订阅事件,我们可以使用 broker.on 函数,该函数接受两个参数:事件名称和处理程序。例如:

上述代码中,我们订阅了一个名为 user.created 的事件,并在触发事件时打印一条消息。

使用钩子

在 moleculer 中,你可以使用钩子函数在服务的生命周期中添加自己的逻辑。例如:

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

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

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

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

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

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

上述代码中,我们添加了三个钩子函数:createdstartedstopped。这些钩子会在服务的生命周期中自动调用,并执行相应的操作。

使用中间件

要使用中间件,我们可以使用 moleculer 的 middleware 配置选项,例如:

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

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

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

上述代码中,我们定义了一个 hello 动作,并添加了一个名为 middleware 的中间件。该中间件会在调用动作之前被调用,并打印一条日志。注意,中间件应该返回 next() 来继续执行下一个中间件或最后的动作处理程序。

生命周期

在 moleculer 中,服务的生命周期共有三个阶段:createdstartedstopped。其中,created 用于做一些初始化操作,started 用于启动服务,stopped 用于停止服务。

在上述基础操作中,我们已经通过钩子函数和示例代码展示了各种生命周期的应用。

服务发现

服务发现在 microservices 中发挥着至关重要的作用。在 moleculer 中,服务发现是自动完成的,任何一个 moleculer 服务都可以使用 $node 和 $services 来查询所有已知的节点和服务。

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

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

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

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

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

上述代码中,我们首先启动了 moleculer 实例,并创建了一个名为 greeter 的服务。服务的动作 hello 访问了两个默认的 “$node” 和 “$services” 变量,分别代表所有节点和服务的名称和状态。在服务调用时,我们能够查询到所有已知的服务和节点,以便调试和故障排除。

总结

本文详细介绍了 node.js 包 moleculer 的使用方法,包括了 moleculer 的核心概念、基本操作、生命周期和服务发现。通过本文的学习,读者们可以更快地掌握 moleculer 的基本操作方法,从而提升自己的开发效率。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/moleculer