(译) JSON-RPC 2.0 规范(中文版)

http://wiki.geekdream.com/Specification/json-rpc_2.0.html

 

  • 起源时间: 2010-03-26(基于2009-05-24版本)

  • 更新: 2013-01-04

  • 作者: JSON-RPC工作组< json-rpc@googlegroups.com >

  • 原文链接: http://www.jsonrpc.org/specification
  • 翻译: leozvc < xxfs91@gmail.com >

1.概述

JSON-RPC是一个无状态且轻量级的远程过程调用(RPC)协议。 本规范主要定义了一些数据结构及其相关的处理规则。它允许运行在基于socket,http等诸多不同消息传输环境的同一进程中。其使用JSON（RFC 4627）作为数据格式。1.概述

 

它为简单而生!

2.约定

文档中关键字"MUST"、"MUST NOT"、"REQUIRED"、"SHALL"、"SHALL NOT"、"SHOULD"、"SHOULD NOT"、"RECOMMENDED"、"MAY"和 "OPTIONAL" 将在RFC 2119 中得到详细的解释及描述。

由于JSON-RPC使用JSON，它具有与其相同的类型系统(见http://www.json.org或RFC 4627)。JSON可以表示四个基本类型(String、Numbers、Booleans和Null)和两个结构化类型(Objects和Arrays)。 规范中，术语“Primitive”标记那4种原始类型，“Structured”标记两种结构化类型。任何时候文档涉及JSON数据类型，第一个字母都必须大写：Object，Array，String，Number，Boolean，Null。包括True和False也要大写。

在客户端与任何被匹配到的服务端之间交换的所有成员名字应是区分大小写的。 函数、方法、过程都可以认为是可以互换的。

客户端被定义为请求对象的来源及响应对象的处理程序。

服务端被定义为响应对象的起源和请求对象的处理程序。

该规范的一种实现为可以轻而易举的填补这两个角色,即使是在同一时间,同一客户端或其他不相同的客户端。 该规范不涉及复杂层。

3.兼容性

JSON-RPC 2.0 的请求对象和响应对象可能无法在现用的JSON-RPC 1.0 客户端或服务端工作，然而我们可以很容易在两个版本间区分出2.0，总会包含一个成员命名为 “jsonrpc” 且值为“2.0”， 而1.0版本是不包含的。大部分的2.0实现应该考虑尝试处理1.0的对象，即使不是对等的也应给其相关提示。

4.请求对象

发送一个请求对象至服务端代表一个rpc调用， 一个请求对象包含下列成员：

jsonrpc

指定JSON-RPC协议版本的字符串，必须准确写为“2.0”

method

包含所要调用方法名称的字符串，以rpc开头的方法名，用英文句号（U+002E or ASCII 46）连接的为预留给rpc内部的方法名及扩展名，且不能在其他地方使用。

params

调用方法所需要的结构化参数值，该成员参数可以被省略。

id

已建立客户端的唯一标识id，值必须包含一个字符串、数值或NULL空值。如果不包含该成员则被认定为是一个通知。该值一般不为NULL[1]，若为数值则不应该包含小数[2]。

服务端必须回答相同的值如果包含在响应对象。 这个成员用来两个对象之间的关联上下文。

[1] 在请求对象中不建议使用NULL作为id值，因为该规范将使用空值认定为未知id的请求。另外，由于JSON-RPC 1.0 的通知使用了空值，这可能引起处理上的混淆。

[2] 使用小数是不确定性的，因为许多十进制小数不能精准的表达为二进制小数。

4.1通知

没有包含“id”成员的请求对象为通知， 作为通知的请求对象表明客户端对相应的响应对象并不感兴趣，本身也没有响应对象需要返回给客户端。服务端必须不回复一个通知，包含那些批量请求中的。

由于通知没有返回的响应对象，所以通知不确定是否被定义。同样，客户端不会意识到任何错误（例如参数缺省，内部错误）。

4.2参数结构

rpc调用如果存在参数则必须为基本类型或结构化类型的参数值，要么为索引数组，要么为关联数组对象。

  • 索引：参数必须为数组，并包含与服务端预期顺序一致的参数值。

  • 关联名称：参数必须为对象，并包含与服务端相匹配的参数成员名称。没有在预期中的成员名称可能会引起错误。名称必须完全匹配，包括方法的预期参数名以及大小写。

5.响应对象

当发起一个rpc调用时，除通知之外，服务端都必须回复响应。响应表示为一个JSON对象，使用以下成员：

jsonrpc

指定JSON-RPC协议版本的字符串，必须准确写为“2.0”

result

该成员在成功时必须包含。

当调用方法引起错误时必须不包含该成员。

服务端中的被调用方法决定了该成员的值。

error

该成员在失败是必须包含。

当没有引起错误的时必须不包含该成员。

该成员参数值必须为5.1中定义的对象。

id

该成员必须包含。

该成员值必须于请求对象中的id成员值一致。

若在检查请求对象id时错误（例如参数错误或无效请求），则该值必须为空值。

响应对象必须包含result或error成员，但两个成员必须不能同时包含。

5.1错误对象

当一个rpc调用遇到错误时，返回的响应对象必须包含错误成员参数，并且为带有下列成员参数的对象：

code

使用数值表示该异常的错误类型。 必须为整数。

message

对该错误的简单描述字符串。 该描述应尽量限定在简短的一句话。

data

包含关于错误附加信息的基本类型或结构化类型。该成员可忽略。 该成员值由服务端定义（例如详细的错误信息，嵌套的错误等）。

-32768至-32000为保留的预定义错误代码。在该范围内的错误代码不能被明确定义，保留下列以供将来使用。错误代码基本与XML-RPC建议的一样，url： http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php

codemessagemeaning
-32700Parse error语法解析错误服务端接收到无效的json。该错误发送于服务器尝试解析json文本
-32600Invalid Request无效请求发送的json不是一个有效的请求对象。
-32601Method not found找不到方法该方法不存在或无效
-32602Invalid params无效的参数无效的方法参数。
-32603Internal error内部错误JSON-RPC内部错误。
-32000 to -32099Server error服务端错误预留用于自定义的服务器错误。

除此之外剩余的错误类型代码可供应用程序作为自定义错误。

6.批量调用

当需要同时发送多个请求对象时，客户端可以发送一个包含所有请求对象的数组。

当批量调用的所有请求对象处理完成时，服务端则需要返回一个包含相对应的响应对象数组。每个响应对象都应对应每个请求对象，除非是通知的请求对象。服务端可以并发的，以任意顺序和任意宽度的并行性来处理这些批量调用。

这些相应的响应对象可以任意顺序的包含在返回的数组中，而客户端应该是基于各个响应对象中的id成员来匹配对应的请求对象。

若批量调用的rpc操作本身非一个有效json或一个至少包含一个值的数组，则服务端返回的将单单是一个响应对象而非数组。若批量调用没有需要返回的响应对象，则服务端不需要返回任何结果且必须不能返回一个空数组给客户端。

7.示例

Syntax:

--> data sent to Server
<-- data sent to Client

带索引数组参数的rpc调用:

--> {"jsonrpc": "2.0", "method": "subtract", "params": [42, 23], "id": 1} <-- {"jsonrpc": "2.0", "result": 19, "id": 1} --> {"jsonrpc": "2.0", "method": "subtract", "params": [23, 42], "id": 2} <-- {"jsonrpc": "2.0", "result": -19, "id": 2}

带关联数组参数的rpc调用:

--> {"jsonrpc": "2.0", "method": "subtract", "params": {"subtrahend": 23, "minuend": 42}, "id": 3} <-- {"jsonrpc": "2.0", "result": 19, "id": 3} --> {"jsonrpc": "2.0", "method": "subtract", "params": {"minuend": 42, "subtrahend": 23}, "id": 4} <-- {"jsonrpc": "2.0", "result": 19, "id": 4}

通知:

--> {"jsonrpc": "2.0", "method": "update", "params": [1,2,3,4,5]} --> {"jsonrpc": "2.0", "method": "foobar"}

不包含调用方法的rpc调用:

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

包含无效json的rpc调用:

--> {"jsonrpc": "2.0", "method": "foobar, "params": "bar", "baz] <-- {"jsonrpc": "2.0", "error": {"code": -32700, "message": "Parse error"}, "id": null}

包含无效请求对象的rpc调用:

--> {"jsonrpc": "2.0", "method": 1, "params": "bar"} <-- {"jsonrpc": "2.0", "error": {"code": -32600, "message": "Invalid Request"}, "id": null}

包含无效json的rpc批量调用:

--> [{"jsonrpc": "2.0", "method": "sum", "params": [1,2,4], "id": "1"}, {"jsonrpc": "2.0", "method" ] <-- {"jsonrpc": "2.0", "error": {"code": -32700, "message": "Parse error"}, "id": null}

包含空数组的rpc调用:

--> []
<-- {"jsonrpc": "2.0", "error": {"code": -32600, "message": "Invalid Request"}, "id": null}

非空且无效的rpc批量调用:

--> [1]
<-- [ {"jsonrpc": "2.0", "error": {"code": -32600, "message": "Invalid Request"}, "id": null} ]

无效的rpc批量调用:

--> [1,2,3] <-- [ {"jsonrpc": "2.0", "error": {"code": -32600, "message": "Invalid Request"}, "id": null}, {"jsonrpc": "2.0", "error": {"code": -32600, "message": "Invalid Request"}, "id": null}, {"jsonrpc": "2.0", "error": {"code": -32600, "message": "Invalid Request"}, "id": null} ]

rpc批量调用:

--> [{"jsonrpc": "2.0", "method": "sum", "params": [1,2,4], "id": "1"}, {"jsonrpc": "2.0", "method": "notify_hello", "params": [7]}, {"jsonrpc": "2.0", "method": "subtract", "params": [42,23], "id": "2"}, {"foo": "boo"}, {"jsonrpc": "2.0", "method": "foo.get", "params": {"name": "myself"}, "id": "5"}, {"jsonrpc": "2.0", "method": "get_data", "id": "9"} ] <-- [ {"jsonrpc": "2.0", "result": 7, "id": "1"}, {"jsonrpc": "2.0", "result": 19, "id": "2"}, {"jsonrpc": "2.0", "error": {"code": -32600, "message": "Invalid Request"}, "id": null}, {"jsonrpc": "2.0", "error": {"code": -32601, "message": "Method not found"}, "id": "5"}, {"jsonrpc": "2.0", "result": ["hello", 5], "id": "9"} ]

所有都为通知的rpc批量调用:

--> [{"jsonrpc": "2.0", "method": "notify_sum", "params": [1,2,4]}, {"jsonrpc": "2.0", "method": "notify_hello", "params": [7]} ] <-- //Nothing is returned for all notification batches

7.扩展

以rpc开头的方法名预留作为系统扩展，且必须不能用于其他地方。每个系统扩展都应该有相关规范文档，所有系统扩展都应是可选的。

Copyright (C) 2007-2010 by the JSON-RPC Working Group

This document and translations of it may be used to implement JSON-RPC, it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not bemodified in any way.

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/395063.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

ios pusher使用_如何使用JavaScript和Pusher实时更新用户状态

ios pusher使用_如何使用JavaScript和Pusher实时更新用户状态

ios pusher使用by Rahat Khanna通过拉哈特汉娜 如何使用JavaScript和Pusher实时更新用户状态 (How to update a User’s Status in realtime using JavaScript and Pusher) “Hey, what’s up?” is not a phrase we need to ask someone these days. These days knowing wha…
阅读更多...
python + pyqt5 UI和信号槽分离方法

python + pyqt5 UI和信号槽分离方法

初级菜鸟&#xff0c;知识点记录。 每次重新生成UI.py文件的时候&#xff0c;里面的按钮方法都会被清除&#xff0c;想一个方法可以把按钮响应方法放到外面&#xff0c;利于维护。 新建一个按钮文件并继承UI代码&#xff0c;把信号槽及按钮响应方法写在按钮文件里面&#xff0c…
阅读更多...
学习之路~sqh

学习之路~sqh

推荐博客 Edison Chou&#xff1b;Vamei&#xff1b;算法∙面试专题 - 简书&#xff1b;xingoo - 博客园&#xff1b;设计模式 极速理解设计模式系列【目录索引】- Caleung&#xff1b;Net设计模式 - 灵动生活&#xff1b;宅男程序员给老婆的计算机课程系列&#xff1b;C设计模…
阅读更多...
python format函数保留两位小数_python format函数

python format函数保留两位小数_python format函数

在Python 3.0中&#xff0c;%操作符通过一个更强的格式化方法format()进行了增强。对str.format()的支持已经被反向移植到了Python 2.6在2.6中&#xff0c;8-bit字符串和Unicode字符串都有一个format()方法&#xff0c;这个方法会把字符串当作一个模版&#xff0c;通过传入的参…
阅读更多...
蓝牙 sig base uuid_蓝牙模块采用陶瓷天线和PCB天线的区别

蓝牙 sig base uuid_蓝牙模块采用陶瓷天线和PCB天线的区别

一、陶瓷天线陶瓷天线是一种适合于蓝牙设备使用的小型化天线,又分为块状陶瓷天线和多层陶瓷天线。陶瓷天线占用空间很小、性能比较好&#xff1b; 带宽窄&#xff0c;比较难做到多频段&#xff1b;有效提高主板的整合度&#xff0c;并可降低天线对ID的限制&#xff1b;需要在主…
阅读更多...
kubernetes系列12—二个特色的存储卷configmap和secret

kubernetes系列12—二个特色的存储卷configmap和secret

本文收录在容器技术学习系列文章总目录 1、configmap 1.1 认识configmap ConfigMap用于保存配置数据的键值对&#xff0c;可以用来保存单个属性&#xff0c;也可以用来保存配置文件。ConfigMap跟secret很类似&#xff0c;但它可以更方便地处理不包含敏感信息的字符串。 1.2 创建…
阅读更多...
华为完成拉美铜网宽带G.fast技术部署测试

华为完成拉美铜网宽带G.fast技术部署测试

1/11/2016,英国大东通信巴拿马分公司日前与华为公司发布消息称&#xff0c;覆盖拉丁美洲地区的最快铜缆宽带服务系统成功完成初次测试。 作为巴拿马地区领先的移动宽带服务提供商&#xff0c;大东通信巴拿马分公司也是当地最大的电信服务提供商&#xff0c;此次与华为合作在现有…
阅读更多...
kotlin调用类中的方法_一种轻松的方法来测试Kotlin中令人沮丧的静态方法调用

kotlin调用类中的方法_一种轻松的方法来测试Kotlin中令人沮丧的静态方法调用

kotlin调用类中的方法by Oleksii Fedorov通过Oleksii Fedorov 一种轻松的方法来测试Kotlin中令人沮丧的静态方法调用 (A stress-free way to test frustrating static method calls in Kotlin) Let me make a wild guess… You have encountered some code in Kotlin that is …
阅读更多...
python图像加密模块_使用Pycryp的图像加密和解密

python图像加密模块_使用Pycryp的图像加密和解密

这和加密或解密文本是一样的。示例首先导入一些模块&#xff1a;from Crypto.Cipher import AESfrom Crypto import Random然后&#xff0c;让我们生成一个键和一个初始化向量。key Random.new().read(AES.block_size)iv Random.new().read(AES.block_size)加密下面的代码加载…
阅读更多...
遇到attemp to invoke virtual method

遇到attemp to invoke virtual method

这个很大原因是没有预先初始化sdk&#xff0c;检查application的配置是否配置了application&#xff1a;name 转载于:https://www.cnblogs.com/caimuqing/p/5894099.html
阅读更多...
app启动页自动跳转源码_关于移动端App启动页的策划方案

app启动页自动跳转源码_关于移动端App启动页的策划方案

App启动页是指app在启东时需要加载必要的运行环境和配置&#xff0c;在这个过程中提示用户等待的一个过渡页面。在产品经理眼里启动页是app给予用户重要的第一印象&#xff1b;也是App最重要的黄金页面之一&#xff0c;所有用户100%都会看到的页面。启动页适合用来做以下几个事…
阅读更多...
电信运营商占IDC市场65%：中国电信占行业半数以上

电信运营商占IDC市场65%：中国电信占行业半数以上

随着云计算、大数据的快速发展&#xff0c;作为重要基础设施的IDC数据中心也在高速扩张。 近日&#xff0c;DCA常务理事长何宝宏介绍&#xff0c;我国规划在建数据中心共计246个&#xff0c;总设计机架数约为103万个&#xff0c;总设计服务器规模约1326万台。在用超大型、大型数…
阅读更多...
Python 日期和时间戳的转换

Python 日期和时间戳的转换

Python 日期和时间戳的转换 1. Python中处理时间的模块 Python中处理时间的模块有time、datetime和calendar。 在Python中表示时间的方式&#xff1a; 时间戳&#xff1a;10位整数位和若干小数位&#xff0c;例如 1551153156.6358607元组&#xff08;struct_time&#xff09;: …
阅读更多...
快应用比赛_我的应用如何在国际学生比赛中获得第三名

快应用比赛_我的应用如何在国际学生比赛中获得第三名

快应用比赛by Rafael Melo通过拉斐尔梅洛 我的应用如何在国际学生比赛中获得第三名 (How my App won third place in an International Student Competition) I developed an App that won third place at the IEEE Mobile Applications Development Contest 2017 (IEEEmadC 2…
阅读更多...
JAVA中String类的intern()方法的作用

JAVA中String类的intern()方法的作用

一般我们变成很少使用到 intern这个方法&#xff0c;今天我就来解释一下这个方法是干什么的&#xff0c;做什么用的 首先请大家看一个例子&#xff1a; public static void main(String[] args) throws Exception { String a "b" ; String b "b" ; …
阅读更多...
java 如何排查内存溢出_java 内存溢出排查

java 如何排查内存溢出_java 内存溢出排查

测试代码&#xff0c;如下示例&#xff1a;import java.util.ArrayList;import java.util.List;/*** Description 测试内存溢出, 启动时设置参数&#xff0c;最大堆内存为1m, 内存溢出时dump出内存文件 -Xmx1m -XX:HeapDumpOutOfMemoryError* Author luzy* Date 2018/10/5 11:0…
阅读更多...
《企业级ios应用开发实战》一2.2 iOS框架介绍

《企业级ios应用开发实战》一2.2 iOS框架介绍

2.2 iOS框架介绍 iOS衍生自Mac OS X的成熟内核&#xff0c;但iOS操作系统更紧凑和高效&#xff0c;支持iPhone和iPod Touch的硬件。iOS继承了Mac OS X的风格&#xff0c;包括&#xff1a;统一的OS X 内核&#xff0c;针对网络的BSD套接字&#xff0c;以及Objective-C和C/C编译器…
阅读更多...
python的opencv 车牌识别 开源_毕节进出口车牌识别系统怎么样

python的opencv 车牌识别 开源_毕节进出口车牌识别系统怎么样

毕节进出口车牌识别系统怎么样 gzheu8il毕节进出口车牌识别系统怎么样 系统拓扑图如下&#xff1a;该系统以社区中心机房为枢纽&#xff0c;有机的将智慧家居住户、社区数字化服务、物业数字化管理、社区智能化管理结合起来&#xff0c;真正的实现&#xff1a;住户与住户之间的…
阅读更多...
了解使用JavaScript进行面向对象编程的基础（并增强您的编码…

了解使用JavaScript进行面向对象编程的基础（并增强您的编码…

by Kris Baillargeon通过克里斯拜伦 学习使用JavaScript进行面向对象编程的基础知识(并增强您的编码能力&#xff01;) (Learn the basics of object-oriented programming with JavaScript (and supercharge your coding abilities!)) As a moderator of the freeCodeCamp ch…
阅读更多...
postgresql的别名要用双引号才可以

postgresql的别名要用双引号才可以

postgresql的别名要用双引号""才可以 转载于:https://www.cnblogs.com/handsome1013/p/10443001.html
阅读更多...
最新文章

Copyright @ 2022~2023