json-rpc如何传递

浅出：JSON-RPC 如何高效传递数据与请求

在现代分布式系统和微服务架构中,服务间的通信是核心环节，我们熟知的 RESTful API 以其直观的 HTTP 方法和资源定位而广受欢迎，但在某些场景下，我们需要一种更轻量、更专注于“过程调用”的通信协议，JSON-RPC（Remote Procedure Call）正是这样一种基于 JSON 的轻量级远程过程调用协议，本文将探讨 JSON-RPC 是如何传递数据、构建请求和响应的，以及它的核心优势。

JSON-RPC 是什么？

JSON-RPC 的核心思想非常简单：它允许一个客户端程序像调用本地函数一样，去执行另一个（远程）服务器上的函数或方法，并获取返回结果，整个过程通过 JSON 格式的消息在网络上传递。

与 REST 不同，JSON-RPC 不关心资源的 URI（统一资源标识符），而是直接关注“调用哪个方法”以及“传递什么参数”，这使得它在需要频繁执行特定操作的场景下，比 REST 更加简洁和高效。

JSON-RPC 的核心：如何传递请求与响应

JSON-RPC 的一切都围绕两个核心概念：请求和响应，它们都是结构化的 JSON 对象。

请求的传递

当客户端需要调用一个远程方法时,它会构造一个 JSON-RPC 请求对象并发送给服务器，一个标准的 JSON-RPC 2.0 请求必须包含以下四个字段：

jsonrpc: 一个字符串，必须设置为 "2.0"，表示遵循 JSON-RPC 2.0 协议版本。
method: 一个字符串，指定了要调用的远程方法的名称，这是请求的核心。
params: 一个数组或对象，包含了传递给远程方法的参数，使用数组（位置参数）还是对象（关键字参数）取决于服务端的定义。
id: 一个任意类型的值（通常是数字或字符串），用于唯一标识这个请求，客户端会使用这个 id 来匹配后续收到的响应。

示例：一个简单的请求

假设我们有一个远程服务,它提供了一个名为 subtract 的方法，用于计算两个数的差，客户端想计算 42 - 23 的结果。

客户端会构造如下的 JSON 请求：

{
  "jsonrpc": "2.0",
  "method": "subtract",
  "params": [42, 23],
  "id": 1
}

这个请求的含义是：

协议版本是 2.0。
请调用名为 subtract 的方法。
传递两个参数,分别是 42 和 23（按顺序对应方法的参数）。
这个请求的 ID 是 1。

这个 JSON 对象通过 HTTP（通常是 POST 请求）、WebSocket 或其他 TCP 连议被发送到服务器。

响应的传递

服务器收到请求后,会执行指定的方法，然后将结果封装成一个 JSON-RPC 响应对象返回给客户端，一个标准的 JSON-RPC 2.0 响应必须包含以下三个字段：

jsonrpc: 一个字符串，必须设置为 "2.0"。
result: 一个 JSON 数据类型，包含了远程方法执行成功后返回的结果。注意：如果请求失败，这个字段将不存在，取而代之的是 error 字段。
id: 必须与请求中的 id 完全一致，这使得客户端能够将响应与它之前发出的请求正确匹配。

示例：对应的成功响应

对于上面的 subtract 请求，服务器计算 42 - 23 = 19，然后返回如下响应：

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

这个响应的含义是：

协议版本是 2.0。
你请求的 subtract 方法执行成功，结果是 19。
这个结果是针对 ID 为 1 的请求的。

错误处理

如果服务器在处理请求时发生错误（方法不存在、参数类型错误、内部服务器错误等），它将不会返回 result 字段，而是返回一个 error 对象。

error 对象通常包含以下字段：

code: 一个数值，表示错误类型（-32601 表示方法未找到，-32602 表示无效参数）。
message: 一个简短的错误描述字符串。
data: （可选）一个包含详细错误信息的值。

示例：一个错误响应

如果客户端请求一个名为 foo 的方法，但服务器上并不存在这个方法，服务器会返回如下错误响应：

{
  "jsonrpc": "2.0",
  "error": {
    "code": -32601,
    "message": "Method not found"
  },
  "id": 1
}

JSON-RPC 的传递方式

JSON-RPC 协议本身不规定底层传输协议，它只定义了消息的格式，它非常灵活，可以通过多种方式传递：

HTTP/HTTPS: 这是最常见的传输方式，客户端将 JSON-RPC 请求作为 HTTP POST 请求的 body 发送到服务端的一个特定 endpoint（/rpc），服务端将响应作为 HTTP 响应的 body 返回，这种方式简单、通用，且能利用现有的 Web 基础设施（如防火墙、负载均衡器）。
WebSocket: 对于需要实时、双向通信的应用（如在线游戏、聊天应用），WebSocket 是理想的选择，客户端和服务器之间建立一个持久连接，JSON-RPC 消息可以像数据流一样在两个方向上高效传递，无需为每个请求/响应建立新的 HTTP 连接，延迟更低。
TCP Socket: 在对性能要求极高且不依赖标准 Web 协议的场景下，可以直接在 TCP Socket 上传输 JSON-RPC 消息，这种方式最为轻量，但实现起来相对复杂。