知識(shí)學(xué)習(xí)之Json-RPC
JSON-RPC技術(shù)
JSON-RPC是一個(gè)無(wú)狀態(tài)且輕量級(jí)的遠(yuǎn)程過(guò)程調(diào)用(RPC)協(xié)議。 本規(guī)范主要定義了一些數(shù)據(jù)結(jié)構(gòu)及其相關(guān)的處理規(guī)則。它允許運(yùn)行在基于socket,http等諸多不同消息傳輸環(huán)境的同一進(jìn)程中。
協(xié)議描述
data sent to Server
<code>{ "method": "sayHello", "params": ["Hello JSON-RPC"], "id": 1}</code>
參數(shù)介紹:
method: 調(diào)用的方法名
params: 方法傳入的參數(shù),若無(wú)參數(shù)則傳入 []
id : 調(diào)用標(biāo)識(shí)符,用于標(biāo)示一次遠(yuǎn)程調(diào)用過(guò)程;已建立客戶端的唯一標(biāo)識(shí)id,值必須包含一個(gè)字符串、數(shù)值或NULL空值。如果不包含該成員則被認(rèn)定為是一個(gè)通知。
Note
服務(wù)端必須回答相同的值如果包含在響應(yīng)對(duì)象。 這個(gè)成員用來(lái)兩個(gè)對(duì)象之間的關(guān)聯(lián)上下文。
[1] 在請(qǐng)求對(duì)象中不建議使用NULL作為id值,因?yàn)樵撘?guī)范將使用空值認(rèn)定為未知id的請(qǐng)求。另外,由于JSON-RPC 1.0 的通知使用了空值,這可能引起處理上的混淆。
[2] 使用小數(shù)是不確定性的,因?yàn)樵S多十進(jìn)制小數(shù)不能精準(zhǔn)的表達(dá)為二進(jìn)制小數(shù)。
data sent to Client
<code>
{ "result":"Hello JSON-RPC","error",null,"id":1}
</code>
參數(shù)介紹:
result: 方法返回值,若無(wú)返回值,則返回null。若調(diào)用錯(cuò)誤,返回null。
error :調(diào)用時(shí)錯(cuò)誤,無(wú)錯(cuò)誤返回null。
該成員在失敗是必須包含。
當(dāng)沒(méi)有引起錯(cuò)誤的時(shí)必須不包含該成員。
id: 調(diào)用標(biāo)識(shí)符,與調(diào)用方傳入的標(biāo)識(shí)符一致。
該成員值必須于請(qǐng)求對(duì)象中的id成員值一致。
若在檢查請(qǐng)求對(duì)象id時(shí)錯(cuò)誤(例如參數(shù)錯(cuò)誤或無(wú)效請(qǐng)求),則該值必須為空值。
通知模式
沒(méi)有包含“id”成員的請(qǐng)求對(duì)象為通知
example
所有都為通知的rpc批量調(diào)用:
--> [
{"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
rpc調(diào)用如果存在參數(shù)則必須為基本類型或結(jié)構(gòu)化類型的參數(shù)值,要么為索引數(shù)組,要么為關(guān)聯(lián)數(shù)組對(duì)象。
索引:參數(shù)必須為數(shù)組,并包含與服務(wù)端預(yù)期順序一致的參數(shù)值。
關(guān)聯(lián)名稱:參數(shù)必須為對(duì)象,并包含與服務(wù)端相匹配的參數(shù)成員名稱。沒(méi)有在預(yù)期中的成員名稱可能會(huì)引起錯(cuò)誤。名稱必須完全匹配,包括方法的預(yù)期參數(shù)名以及大小寫。
error object
{"code":"", message:"","data":""}
code:使用數(shù)值表示該異常的錯(cuò)誤類型。 必須為整數(shù)。
message:對(duì)該錯(cuò)誤的簡(jiǎn)單描述字符串。 該描述應(yīng)盡量限定在簡(jiǎn)短的一句話。
data:包含關(guān)于錯(cuò)誤附加信息的基本類型或結(jié)構(gòu)化類型。該成員可忽略。 該成員值由服務(wù)端定義(例如詳細(xì)的錯(cuò)誤信息,嵌套的錯(cuò)誤等)。
總結(jié)
json-rpc是一種非常輕量級(jí)的跨語(yǔ)言遠(yuǎn)程調(diào)用協(xié)議,實(shí)現(xiàn)及使用簡(jiǎn)單。僅需幾十行代碼,即可實(shí)現(xiàn)一個(gè)遠(yuǎn)程調(diào)用的客戶端,方便語(yǔ)言擴(kuò)展客戶端的實(shí)現(xiàn)。
至于 ****WEB開(kāi)發(fā)中,使用JSON-RPC好,還是RESTful API好?****
可以移步這里http://www.zhihu.com/question/28570307