npm 包 node-express-json-rpc2-async 使用教程

前言

在现代 Web 开发中，不同的组件可以通过 API 进行互动。而 JSON-RPC 协议可以作为连接前后端的一个有效工具。在 Node.js 中，node-express-json-rpc2-async 是一个优秀的 JSON-RPC 库，本篇文章介绍如何使用该库进行前后端 API 的连接。

什么是 node-express-json-rpc2-async？

node-express-json-rpc2-async 是一个基于 Node.js 的 JSON-RPC 实现，可以很方便地与 Express 框架进行集成。该库具有异步处理请求的能力，并支持 Promise。

安装 node-express-json-rpc2-async

使用以下命令安装 node-express-json-rpc2-async：

npm install node-express-json-rpc2-async --save

使用 node-express-json-rpc2-async

首先，启动一个 Express 服务器，并引入 node-express-json-rpc2-async：

const express = require('express');
const app = express();
const rpc = require('node-express-json-rpc2-async');

接着，定义 JSON-RPC 方法：

rpc.expose('add', async (payload, respond) => {
    const {a, b} = payload;
    if (typeof a !== 'number' || typeof b !== 'number') {
        throw new rpc.JSONRPCError('Invalid params', rpc.JSONRPCError.INVALID_PARAMS);
    }
    const result = a + b;
    respond(null, result);
});

上述代码定义了一个名为 add 的方法，用于计算两个数字的和。在实际应用中，JSON-RPC 方法的实现可能比上述代码更加复杂，需要花费更多的时间和精力。

最后，将 JSON-RPC 方法与 Express 路由进行集成：

app.use('/rpc', rpc.expressMiddleware());

现在，我们就可以通过 HTTP POST 请求访问这个 JSON-RPC 服务。例如：

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

上述代码可以计算 1 + 2 的结果。POST 请求的返回值应如下所示：

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": 3
}

异常处理

在 JSON-RPC 服务中，异常处理是一项重要的任务。如果服务端出现了错误，或者参数或请求格式不正确，就需要抛出一些异常。

在上述示例中，如果参数 a 或 b 不是数字，就需要抛出一个 INVALID_PARAMS 类型的异常。可以使用 rpc.JSONRPCError 方法来创建自定义的 JSON-RPC 异常。例如：

throw new rpc.JSONRPCError('Invalid params', rpc.JSONRPCError.INVALID_PARAMS);

总结

node-express-json-rpc2-async 是一个非常好用的 JSON-RPC 库，能够很方便地与 Express 框架进行集成。通过本文的介绍，相信读者可以基于该库实现一个完整的 JSON-RPC API 服务。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/71378