npm 包 rpc-protocol 使用教程

阅读时长 3 分钟读完

什么是 rpc-protocol

rpc-protocol 是一个基于 JSON-RPC 的协议封装库,可以帮助开发者快速构建 RPC 服务的协议层。JSON-RPC 通常作为跨语言调用的标准协议,rpc-protocol 相比原生实现,可以实现更好的错误处理、参数校验等功能。

如何安装

可以直接使用 npm 进行安装:

如何使用

使用 rpc-protocol 比较简单,仅需要定义一个 schema,即可生成对应的 RPC 调用函数。

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

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

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

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

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

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

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

客户端调用

客户端可以使用任意的 JSON-RPC 库(如 axios-json 或 jsonrpc-lite)进行调用。下面使用 jsonrpc-lite 为例:

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

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

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

总结

rpc-protocol 可以帮助我们快速构建 RPC 服务的协议层,使得服务端和客户端可以更加规范化的进行 JSON-RPC 调用。在使用时,需要定义一个 schema,定义可以调用的方法和参数校验等属性,后续生成一个 RPC 服务实例。客户端可以使用任意 JSON-RPC 库进行调用,如 axios-json 或者 jsonrpc-lite。

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