什么是 @feathersjs/transport-commons
@feathersjs/transport-commons 是一个用于 Feathers.js 框架的通用传输库。它可以帮助前端开发者在编写 Feathers.js 应用程序时，更快地构建 APIs 和前端服务。其主要功能包括：
- 使用 JSON、消息和 SocketIO 等多种传输类型。
- 兼容 Feathers.js 中的所有客户端、服务和钩子。
- 支持插件式的中间件和自定义的插件。
- 提供一套简单的 API，易于使用和扩展。
如何安装和使用
在您的项目中，使用 npm 安装 @feathersjs/transport-commons：
npm install @feathersjs/transport-commons
然后，您可以使用该库的内置传输类型（如 SocketIO、JSON 和消息）之一，实现简单的数据交换。以下是使用 SocketIO 实现此操作的示例代码：
-- -------------------- ---- ------- ----- -- - ---------------------------- ----- -------- - -------------------------------- ----- -------- - --------------------------------------- ----- --------- - ----------------------------------------- ----- ------ - ---------------------------- ----- --- - ----------- -------------------------------- -----------------------------
在这段代码中，我们建立了一个连接到本地主机上的 SocketIO 服务器。然后，我们配置了一个 Feathers 应用程序，该应用程序使用 @feathersjs/socketio-client 和 @feathersjs/transport-commons 的客户端和传输组件来创建客户端和服务端之间的通信通道。通过这种方式，我们可以使用 Feathers.js 的通用 API 与我们的 SocketIO 服务器进行交互。
深入理解
@feathersjs/transport-commons 的核心实现是一个 plugin 函数，该函数接受一个选项对象，可用于配置传输库的行为。该函数返回一个 Feathers 应用程序对象。本节将详细说明如何使用 @feathersjs/transport-commons 实现以下行为：
- 如何添加自定义传输类型。
- 如何使用钩子在传输过程中进行操作。
- 如何使用中间件对请求进行附加处理。
添加自定义传输类型
默认情况下，@feathersjs/transport-commons 支持三种传输类型：JSON、消息和 SocketIO。但是，您可以通过实现自己的传输插件来添加更多的传输类型。以下是一个示例插件，它添加了一个新的 XML-RPC 传输类型：
-- -------------------- ---- -------
----- --------- - -----------------------------------------
-------------- - -------- -------- - --- -
------ -------- ------ ---------- -
-- ----------------- -
----- --- ------------- ------ -------- - ------ -----------
-
------------------------- -------- -- -
---------- - -----------------------------------------------
---
------------------------- -------- -- -
------ -----------
---
-------- ------------ ------ -
------ --- ----------------- ------- -- -
--------------------------------------- ------------ ----- ---- -- -
-- ----- -
------------
- ---- -
-------------
-
---
---
-
------------------------------
------- -------------
----
--
--该插件会将 'connection' 和 'disconnect' 事件绑定到 Feathers 应用程序对象上。当新的客户端连接到服务器时，该插件会在 socket 上创建一个新的 RPC 客户端，并将其存储在 socket.rpc 中。然后，该插件将调用由 feathers.configure() 提供的 @feathersjs/transport-commons 插件，使用 rpcTransport 方法来处理与新客户端的通信。
钩子操作
您可以使用钩子在传输过程中执行操作。以下是一个示例钩子，它使用使用 JWT 来验证客户端的身份：
-- -------------------- ---- -------
----- --- - ------------------------
-------- --------------- ----- -
------ -------- --------- -
----- ----- - ---------------------
-- -------- -
----- --- --------------------- ----- -- -----------
-
----- ------- - ------------------------ ------ -----------------------
-- ----------------- -
----- --- -------------- -------------- --------
-
------------------- - --------
------ --------
--
-
----- --- - -----------
--------------------- ----------------------该示例中，我们首先定义了一个名为 jwtAuthenticate 的函数，该函数接受一个 Feathers 应用程序，并返回一个新的 middleware 函数。当被调用时，这个中间件会检查在 params.token 中传入的 token 是否有效。如果无效，它将抛出一个错误。否则，它会通过调用 jwt.verify() 来解码 token，将解码的用户信息存储在 params.user 中，并将这个新的 context 对象返回。最后，我们会向 authenticate() 钩子添加此 middleware。
添加中间件
中间件是一种特殊的函数，它可以在请求处理之前或之后对请求进行操作。以下是一个示例中间件，它用于将 GUID 自动生成器附加到所有的服务方法：
-- -------------------- ---- -------
----- ---- - ----------------
-------- ------------ --------- -
---------------------------------- - -----
------ --------
-
-------- ---------- --------- -
-- ------------------------------------ -
-- ------------------ -
--------------- - -----------
-
------ -----------------------------------
-
------ --------
-
----- --- - -----------
----- ----- - ---------------------
--------------
------- ---------------
------- -------------
---该示例中，我们首先定义了两个分别负责创建和更新服务对象的中间件函数：generateGuid() 和 attachGuid()。generateGuid() 仅仅向请求参数中添加一个 $generateGuid 属性。然后，我们向 users 服务的 'create' 和 'update' 方法添加了相应的中间件操作。在实际执行请求处理之前，generateGuid() 将添加一个唯一的 GUID 标识符，而 attachGuid() 函数则负责在请求结果中附加该标识符。
总结
在本教程中，我们介绍了 @feathersjs/transport-commons - Feathers.js 框架的通用传输库。我们探讨了如何安装和使用该库，如何添加自定义传输类型，如何使用钩子在传输过程中执行操作，以及如何使用中间件对请求进行附加处理。希望这篇文章能够帮助您更好地理解 @feathersjs/transport-commons，并能够快速地在您的项目中使用它。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/93199