简介
ws-jsonrpc 是一个基于 WebSocket 协议的 JSON-RPC 客户端和服务器端实现。它可以用来实现前后端分离的 Web 应用中的异步通信。
安装
npm install ws-jsonrpc
使用
服务器端
-- -------------------- ---- ------- ----- - ------------ - - ---------------------- ----- ------ - --------------- ---------------------------- -- ---- -- -- - ------ ------- ---------- --- ------------------- -- -- - ------------------- -- --------- -- ---- ------- ---
以上代码创建了一个 JSON-RPC 服务器，监听端口 3001，暴露了一个名为 "greet" 的方法，可以接受一个名为 "name" 的参数，返回一个问候语。
客户端
-- -------------------- ---- ------- ----- - ------------ - - ---------------------- ----- ------ - ------------------------------------ ----------------------- - ----- ------- ---------------- -- - -------------------- -- ------- ------- --- ---------------------------- - ----- ----- ---
以上代码创建了一个 JSON-RPC 客户端，连接到了本地的服务器端，发送了一个带参数的请求，并打印出返回结果。同时，还发送了一个不带返回值的通知。
深入理解
协议
JSON-RPC 是一种用来在不同的计算机进程或网络节点之间传输数据和消息的通信协议。它基于 JSON 格式，支持异步请求和通知，可以用于实现远程过程调用（RPC）和事件驱动架构。与 HTTP 协议不同，JSON-RPC 可以在 WebSocket、TCP、UDP 等协议上运行，具有更高的效率和灵活性。
方法暴露
在服务器端，我们可以使用 exposeMethod 方法来暴露一个方法，参数为方法名和一个函数。这个函数接受一个对象类型的参数，包含了这个请求的上下文信息和参数。我们可以从这个参数中取出需要的参数值，并返回一个结果或抛出一个异常。客户端发送的请求会被分派给对应的方法进行处理。相应地，在客户端，我们使用 request 方法来发送一个请求，参数为方法名和一个对象类型的参数。如果这个方法需要返回一个值，我们可以使用 then 方法来获取结果。如果这个方法不需要返回值，则可以使用 notification 方法来发送一个通知。
对象序列化
在 JSON-RPC 中，所有传递的参数和返回值都必须是 JSON 格式的对象。如果我们需要传递一个复杂的对象，例如一个日期对象、一个正则表达式对象或一个自定义类实例，我们需要将它们序列化为 JSON 格式的字符串。在服务器端，我们可以使用 wrapMethod 方法来注册一个方法，它将在执行前将参数中的 JSON 字符串反序列化为对应的对象，并将执行结果序列化为 JSON 字符串。在客户端，我们需要自己进行对象序列化和反序列化，或者使用第三方的序列化库，例如 json-bigint 和 json-stringify-safe 等。
结论
ws-jsonrpc 是一个简单易用、功能丰富的 JSON-RPC 库，它可以帮助我们在 Web 应用中实现高效、可靠的通信。我们可以轻松地创建服务器端和客户端，暴露和调用方法，并发送异步请求和通知。同时，我们需要注意序列化和反序列化的细节，以便正确地处理复杂的数据类型。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600671158dd3466f61ffe608