輕量級通信協議 JSON-RPC 2.0 詳解

目錄

JSON-RPC 2.0 簡介

請求對象

響應對象

通知

批量請求

錯誤碼

使用場景

文檔和版本控制

社區和支持

小結

參考資料

JSON-RPC 2.0 簡介

JSON-RPC (JavaScript Object Notation - Remote Procedure Call) 是一種輕量級的遠程過程調用協議，使用 JSON（JavaScript 對象表示法）作為數據格式。JSON-RPC 2.0 是該協議的最新版本，在 1.0 版本的基礎上增加了一些特性，如錯誤代碼標準化、批量請求支持和無響應的通知。

JSON-RPC 的設計原則是簡單性和互操作性，旨在為不同編程語言之間提供一種方便的方法來執行遠程過程調用。通過定義一組簡單的規則，任何能夠解析 JSON 的語言或平臺都可以實現 JSON-RPC 客戶端或服務器。

接下來看下 JSON-RPC 2.0 協議的規范。

請求對象

一個 JSON-RPC 2.0 請求數據是一個單一的 JSON 對象，可以包含以下成員：

  • jsonrpc：字符串，指定 JSON-RPC 的版本號，對于 2.0 規范來說，這個值必須是 2.0。
  • method：字符串，指定要調用的遠程方法的名稱。
  • params：結構化值，可以是數組或者對象，傳遞給遠程方法的參數。如果方法不需要參數可以省略。
  • id：唯一標識符，可以是字符串或數字，用于關聯請求和響應，服務端必須返回相同的值。如果請求是一個通知類型，則此參數可以被省略。

一個標準的 JSON-RPC 2.0 請求示例如下：

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

響應對象

一個 JSON-RPC 2.0 響應數據也是一個單一的 JSON 對象，可以包含以下成員：

  • jsonrpc：字符串，指定 JSON-RPC 的版本號，對于 2.0 規范來說，這個值必須是2.0。
  • result：當請求成功時，包含由遠程方法返回的結果。如果請求失敗，則不包含此成員。
  • error：當請求失敗時，包含一個錯誤對象。如果請求成功，則不包含此成員。
  • id：與請求中的 id 相同，用于識別哪個請求對應的響應。

錯誤對象包括以下成員：

  • code：整數，用于說明錯誤類型。JSON-RPC 2.0 定義了一組標準的錯誤碼。
  • message：字符串，提供關于錯誤的簡短描述。
  • data：可選，可以包含額外的錯誤信息，比如堆棧信息等。

一個成功的響應示例如下：

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

而一個異常響應示例如下：

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

通知

通知是一種特殊類型的請求，沒有 id 成員，因此不會得到響應。這樣客戶端可以向服務器發送事件或命令而無需等待回復。一個通知示例如下：

{"jsonrpc": "2.0","method": "updateStatus","params": ["online"]
}

批量請求

JSON-RPC 2.0 支持批量請求，即可以在單個請求中發送多個 JSON-RPC 調用。每個調用都是獨立的 JSON-RPC 請求對象，被放在一個數組中。服務器處理這些請求后返回一個數組，其中每個元素對應于一個調用。需要注意的是，如果其中一個調用是通知，則不會有對應的響應項。

[{"jsonrpc": "2.0","method": "sum","params": [1, 3, 5, 7, 9],"id": "1"},{"jsonrpc": "2.0","method": "notify_hello","params": ["Alice"]},{"jsonrpc": "2.0","method": "subtract","params": [42, 23],"id": "2"}
]

錯誤碼

JSON-RPC 2.0 規范中定義了標準的錯誤碼，但開發者也可以根據自己的業務邏輯添加自定義的錯誤碼。這些自定義錯誤代碼應該在-32000到-32099之間，以避免與標準錯誤碼沖突。通過使用自定義錯誤碼，可以為客戶端提供更加具體的錯誤信息。

假如這樣一個場景，應用程序需要處理用戶認證失敗的情況，可以定義一個特定的錯誤碼，比如 -32001，并為這個錯誤碼配一個說明，如 Authentication failed。示例如下：

{"jsonrpc": "2.0","error": {"code": -32001,"message": "Authentication failed"},"id": "1"
}

此外，還可以在? error 的 data 參數中包含更多的錯誤細節，比如錯誤發生的具體位置或建議的解決方法。

JSON-RPC 2.0 定義的標準錯誤碼如下（自定義錯誤嗎不要使用如下幾個）：

  • -32700: 解析錯誤，服務器收到無效的 JSON。
  • -32600: 無效請求，發送的 JSON 不是有效的請求對象。
  • -32601: 方法未找到，方法不存在或無效。
  • -32602: 無效參數，提供的參數無效。
  • -32603: 內部錯誤，JSON-RPC 內部錯誤。

使用場景

JSON-RPC 2.0 的使用場景包括但不限于如下幾個：

  • Web 應用程序，客戶端與服務器之間的異步通信，例如瀏覽器與后端服務交互。
  • 微服務之間的通信，通過 JSON-RPC 調用其他微服務的接口。
  • 物聯網設備，設備與服務器之間的通信，由于 JSON-RPC 的輕量級特性，非常適合資源受限的設備。
  • 移動應用，移動客戶端與服務器之間的交互，減少數據傳輸量，提高響應速度。
  • 區塊鏈和加密貨幣，節點之間的通信或客戶端與節點的交互，許多區塊鏈系統（如以太坊）使用 JSON-RPC 進行接口調用。
  • 遠程過程調用（RPC）服務，替代傳統的 SOAP 或 XML-RPC，提供簡單的接口調用機制。

文檔和版本控制

良好的文檔對于任何 API 都至關重要，尤其是像 JSON-RPC 2.0 這樣依賴于明確的請求和響應格式的協議。

  • 編寫清晰的 API 文檔：詳細描述每個方法的用途、參數、返回值和可能的錯誤情況。可以使用工具如 Swagger 或 Postman 來生成交互式的 API 文檔。
  • 保持文檔更新：隨著 API 的發展，確保文檔始終保持最新狀態，反映最新的變更和改進。
  • 版本控制：為 API 引入版本控制，以便在不影響現有用戶的情況下進行更新。可以在 URL 中或通過請求頭指定 API 版本。

社區和支持

JSON-RPC 2.0 是一個開放的標準，擁有活躍的社區和豐富的資源。參與社區討論、閱讀官方文檔和技術博客、關注相關論壇和社交媒體，都可以幫助更快地解決問題，并獲取最新的最佳實踐。

此外，很多流行的編程語言和框架都有現成的 JSON-RPC 庫，可以大大簡化開發過程。選擇一個成熟且維護良好的庫，不僅可以節省時間，還能減少出錯的可能性。

小結

JSON-RPC 2.0作為一種輕量級的 RPC 協議，提供了如標準化的錯誤處理、批量請求支持和通知機制等功能，具有簡單、易用、跨語言等優點，適用于多種分布式系統場景。

參考資料

  • https://www.jsonrpc.org/specification

本文來自互聯網用戶投稿，該文觀點僅代表作者本人，不代表本站立場。本站僅提供信息存儲空間服務，不擁有所有權，不承擔相關法律責任。
如若轉載，請注明出處：http://www.pswp.cn/web/65163.shtml
繁體地址，請注明出處：http://hk.pswp.cn/web/65163.shtml
英文地址，請注明出處：http://en.pswp.cn/web/65163.shtml

如若內容造成侵權/違法違規/事實不符，請聯系多彩編程網進行投訴反饋email:809451989@qq.com，一經查實，立即刪除！

相關文章

ffmpeg之h264格式轉yuv

ffmpeg之h264格式轉yuv

h264格式轉yuv詳細步驟 初始化FFmpeg庫：通過av_register_all()來初始化必要的組件。打開輸入文件并查找解碼器：使用avformat_open_input和 avcodec_find_decoder 打開H.264文件，并查找視頻流。分配并配置解碼上下文：使用 avcodec…
閱讀更多...
創建VUE腳手架

創建VUE腳手架

1.輸入 npm create vuelatest2.創建完成
閱讀更多...
vue3如何實現防抖？

vue3如何實現防抖？

第一 防抖就是我們設置一個調用時間&#xff0c;點擊后設置時間開始倒計時&#xff0c;如果再次點擊會重新倒計時 npm或yarn安裝&#xff1a; npm install lodash <template><div click"debouncedInputHandler"><button>打印</button>…
閱讀更多...
JavaWeb開發（六）XML介紹

JavaWeb開發（六）XML介紹

1. XML介紹 1.1. 什么是XML &#xff08;1&#xff09;XML 指可擴展標記語言(EXtensible Markup Language)XML 是一種很像HTML的標記語言。 ??&#xff08;2&#xff09;XML 的設計宗旨是傳輸數據(目前主要是作為配置文件)&#xff0c;而不是顯示數據。 ??&#xff08;3&a…
閱讀更多...
用shell把(1到100)100個整數寫入到二進制文件

用shell把(1到100)100個整數寫入到二進制文件

author: hjjdebug date: 2025年 01月 05日 星期日 16:14:41 CST description: 用shell把(1到100)100個整數寫入到二進制文件 1. 問題分析(需求分析) 在c語言下, 整數int 是按4個字節存儲的,能表示最大0xffffffff的范圍 但shell并沒有一條命令能夠實現把一個整數寫入二進制文件…
閱讀更多...
SpringBoot下載文件的幾種方式

SpringBoot下載文件的幾種方式

小文件&#xff1a;直接將文件一次性讀取到內存中&#xff0c;文件大可能會導致OOM GetMapping("/download1")public void download1(HttpServletResponse response) throws IOException {// 指定要下載的文件File file new File("C:\\Users\\syd\\Desktop\\do…
閱讀更多...
Flink使用

Flink使用

Window下啟動支持 下載或復制老版本的放在bin目錄下即可&#xff1b; flink.bat echo off setlocalSET bin%~dp0 SET FLINK_HOME%bin%.. SET FLINK_LIB_DIR%FLINK_HOME%\lib SET FLINK_PLUGINS_DIR%FLINK_HOME%\pluginsSET JVM_ARGS-Xmx512mSET FLINK_JM_CLASSPATH%FLINK_LI…
閱讀更多...
Python基礎知識回顧-數據結構

Python基礎知識回顧-數據結構

Tuple 在 Python 中&#xff0c;我們經常使用 Tuple 來將相關數據分組。Tuple 指的是有序且不可變的元素集合。 形式&#xff1a;通常以逗號分隔的元素寫在括號"() "中。 數據類型和索引&#xff1a;包含 String、整數和浮點數&#xff0c;并使用正索引和負索引訪問…
閱讀更多...
8. C++ 面向對象之特性一（封裝）

8. C++ 面向對象之特性一（封裝）

面向對象主要包括三大類&#xff1a;封裝&#xff0c;繼承&#xff0c;多態 1.類和對象 c認為&#xff0c;萬物皆為對象&#xff0c;對象上有其屬性和行為 人可以作為對象&#xff0c;屬性有姓名、年齡、身高、體重...&#xff0c;行為有走、跑、跳、吃飯、唱歌... 車也可以作…
閱讀更多...
WebRtc02:WebRtc架構、目錄結構、運行機制

WebRtc02:WebRtc架構、目錄結構、運行機制

整體架構 WebRtc主要分為三層&#xff1a; CAPI層&#xff1a;外層調用Session管理核心層&#xff1a;包括視頻引擎、音頻引擎、網絡傳輸 可由使用者重寫視頻引擎&#xff1a;編解碼器、視頻緩存、視頻增強音頻引擎&#xff1a;編解碼器、音頻緩存、回音消除、降噪傳輸&#x…
閱讀更多...
【Qt】快速添加對應類所需的頭文件包含

【Qt】快速添加對應類所需的頭文件包含

快速添加對應類所需的頭文件包含 一&#xff0c;簡介二&#xff0c;操作步驟 一&#xff0c;簡介 本文介紹一下&#xff0c;如何快速添加對應類所需要包含的頭文件&#xff0c;可以提高開發效率&#xff0c;供參考。 二&#xff0c;操作步驟 以QTime類為例&#xff1a; 選中…
閱讀更多...
Apache MINA 反序列化漏洞CVE-2024-52046

Apache MINA 反序列化漏洞CVE-2024-52046

漏洞描述&#xff1a; Apache MINA 是一個功能強大、靈活且高性能的網絡應用框架。它通過抽象網絡層的復雜性&#xff0c;提供了事件驅動架構和靈活的 Filter 鏈機制&#xff0c;使得開發者可以更容易地開發各種類型的網絡應用。 Apache MINA 框架的 ObjectSerializationDeco…
閱讀更多...
服務器docker配置過程

服務器docker配置過程

1.docker安裝 參考官方文檔&#xff1a;https://docker.cadn.net.cn/manuals/engine_install_ubuntu 2.docker鏡像源替換 官方文檔&#xff1a;https://cloud.tencent.com/document/product/1207/45596 鏡像源根據你租了哪家的去找官方文檔即可。
閱讀更多...
RabbitMQ通過代碼創建交換機和隊列

RabbitMQ通過代碼創建交換機和隊列

常見交換機 RabbitMQ提供的交換機一共的四種&#xff0c;分別是&#xff1a; 1. Fanout&#xff1a;采用廣播形式來發送消息&#xff0c;會將消息路由到所有綁定了的隊列之中。 2. Direct&#xff1a;通過Binding Key與隊列綁定&#xff0c;生產者在發送信息的時候會通過Routin…
閱讀更多...
js es6 reduce函數， 通過規格生成sku

js es6 reduce函數， 通過規格生成sku

const specs [{ name: 顏色, values: [紅色, 藍色, 綠色] },{ name: 尺寸, values: [S, M, L] } ];function generateSKUs(specs) {return specs.reduce((acc, spec) > {const newAcc [];for (const combination of acc) {for (const value of spec.values) {newAcc.push(…
閱讀更多...
WPF通過反射機制動態加載控件

WPF通過反射機制動態加載控件

Activator.CreateInstance 是 .NET 提供的一個靜態方法&#xff0c;它屬于 System 命名空間。此方法通過反射機制根據提供的類型信息。 寫一個小demo演示一下 要求&#xff1a;在用戶反饋界面點擊建議或者評分按鈕 彈出相應界面 編寫MainWindow.xmal 主窗體 <Window x:C…
閱讀更多...
寬帶、光貓、路由器、WiFi、光纖之間的關系

寬帶、光貓、路由器、WiFi、光纖之間的關系

1、寬帶&#xff08;Broadband&#xff09; 1.1 寬帶的定義寬帶指的是一種高速互聯網接入技術&#xff0c;通常包括ADSL、光纖、4G/5G等不同類型的接入方式。寬帶的關鍵特點是能夠提供較高的數據傳輸速率&#xff0c;使得用戶可以享受到穩定的上網體驗。 1.2 寬帶的作用寬帶是…
閱讀更多...
Pytest鉤子函數，測試框架動態切換測試環境

Pytest鉤子函數，測試框架動態切換測試環境

在軟件測試中&#xff0c;測試環境的切換是個令人頭疼的問題。不同環境的配置不同&#xff0c;如何高效切換測試環境成為許多測試開發人員關注的重點。你是否希望在運行測試用例時&#xff0c;能夠動態選擇測試環境&#xff0c;而不是繁瑣地手動修改配置&#xff1f; Pytest 測…
閱讀更多...
印象筆記07——試一試PDF標注

印象筆記07——試一試PDF標注

印象筆記07——試一試PDF標注 [!CAUTION] 根據第六期&#xff0c;我再次查詢了資料&#xff0c;印象筆記還是有一些可圈可點的功能的&#xff08;當然部分有平替&#xff09;&#xff0c;針對會員作用&#xff0c;開發使用場景雖然是逆向的&#xff0c;但我堅信這是一部分人的現…
閱讀更多...
【Vue】分享一個快速入門的前端框架以及如何搭建

【Vue】分享一個快速入門的前端框架以及如何搭建

先上效果圖: 登錄 菜單: 下載地址: 鏈接&#xff1a;https://pan.baidu.com/s/1m-ZlBARWU6_2n8jZil_RAQ 提取碼&#xff1a;ui20 … 主要是可以自定義設置token,更改后端請求地址較為方便。 應用設置: 登錄與token設置: 在這里設置不用登錄,可以請求的接口: request.js i…
閱讀更多...
最新文章

Copyright @ 2022~2023