服務(wù)總線接口規(guī)范標(biāo)準(zhǔn)(編輯修改稿)
2025-05-04 21:39 本頁面
【文章內(nèi)容簡介】 務(wù)通過 HTTP URL 中特定屬性進(jìn)行標(biāo)識，具體見接口協(xié)議。 數(shù)據(jù)格式統(tǒng)一原則. . . .. . 學(xué)習(xí)好幫手服務(wù)的接口數(shù)據(jù)包含業(yè)務(wù)所有的業(yè)務(wù)數(shù)據(jù)，數(shù)據(jù)采用 JSON格式表示，并且符合相應(yīng)的 JSON Schema。服務(wù)提供方和服務(wù)消費方必須同時使用同一種格式進(jìn)行數(shù)據(jù)交互。 服務(wù)定義唯一性原則一個服務(wù)應(yīng)該只實現(xiàn)一個業(yè)務(wù)功能，業(yè)務(wù)功能的區(qū)別通過服務(wù)編碼來區(qū)分，不應(yīng)通過定義不同的業(yè)務(wù)數(shù)據(jù)在同一個服務(wù)編碼下實現(xiàn)不同的業(yè)務(wù)功能。 服務(wù)無狀態(tài)原則服務(wù)應(yīng)是無狀態(tài)的，兩次請求之間無須狀態(tài)和會話的保持，并可以采用輪詢的方式在負(fù)載均衡器上進(jìn)行注冊 服務(wù)部署原則服務(wù)應(yīng)是全局的，不應(yīng)區(qū)分本地網(wǎng)、大區(qū)等，但可以部署多份用以提供不同優(yōu)先級的服務(wù)。 服務(wù)組合原則服務(wù)按照服務(wù)粒度設(shè)計成原子服務(wù)和組合服務(wù)。原子服務(wù)為最細(xì)粒度的服務(wù)，組合服務(wù)由原子服務(wù)組合而成。為有效提高組合服務(wù)的效率，跨系統(tǒng)的組合服務(wù)由服務(wù)總線調(diào)用. . . .. . 學(xué)習(xí)好幫手不同的原子服務(wù)實現(xiàn)組合，系統(tǒng)內(nèi)的組合服務(wù)由服務(wù)提供方在應(yīng)用內(nèi)部進(jìn)行組合。 報文內(nèi)容處理的原則服務(wù)請求和返回的的報文應(yīng)符合 JSON Schema 格式。服務(wù)請求方和提供方應(yīng)采用通用的 JSON 解析器來構(gòu)造和解析數(shù)據(jù)，JSON 不同含義的段落應(yīng)定義明確含義的字段名稱，相同內(nèi)容的數(shù)據(jù)應(yīng)采用數(shù)組來進(jìn)行描述，雙方可根據(jù) JSON名稱和路徑進(jìn)行精確定位，不應(yīng)根據(jù)字段的順序來獲取字段值，字段值不受字段順序調(diào)整的影響。報文統(tǒng)一采用 UTF8進(jìn)行編碼。 出入?yún)⒃O(shè)計原則為提高查詢類服務(wù)的通用性和性能，查詢類服務(wù)在入?yún)⒅卸x返回字段列表，服務(wù)提供方根據(jù)入?yún)⒅兄付ǖ淖侄畏祷匦畔?。查詢?nèi)接口應(yīng)在入?yún)⒅卸x分頁參數(shù)，返回參數(shù)中應(yīng)包含當(dāng)前頁數(shù)、總頁數(shù)或是已到最后一頁等信息。. . . .. . 學(xué)習(xí)好幫手返回參數(shù)中如返回靜態(tài)編碼值時應(yīng)同時返回此編碼值對應(yīng)的名稱。 規(guī)則校驗的原則 服務(wù)提供方應(yīng)對請求報文格式和關(guān)鍵信息進(jìn)行合規(guī)性和業(yè)務(wù)校驗，防止非法訪問和入侵。 數(shù)據(jù)量原則服務(wù)總線所傳遞的單條消息大小原則上不大于 1M，否則應(yīng)建議采用文件傳輸、接口表傳輸、直連等連接方式。 同步調(diào)用原則服務(wù)調(diào)用方和服務(wù)提供方采用同步調(diào)用的方式進(jìn)行請求，如需要使用異步調(diào)用可采用消息隊列或服務(wù)調(diào)用方定義異步通知接口來實現(xiàn)。 統(tǒng)一入口原則服務(wù)總線對外提供統(tǒng)一的調(diào)用地址。 持久化原則服務(wù)使用方在使用服務(wù)的過程中，由服務(wù)總線進(jìn)行整個過程的日志記錄，并對調(diào)用的詳細(xì)信息進(jìn)行持久化，便于對. . . .. . 學(xué)習(xí)好幫手賬和稽核。建議服務(wù)調(diào)用方和提供方對調(diào)用的關(guān)鍵信息（如流水號，源地址等）進(jìn)行持久化。第 3 章 服務(wù)接入規(guī)范對于服務(wù)調(diào)用的訪問方式，平臺采用標(biāo)準(zhǔn)的 HTTP 調(diào)用方式。 調(diào)用方式接口服務(wù)通過 訪問平臺服務(wù)。IP 和 PORT 根據(jù)實際生產(chǎn)環(huán)境情況對外公布。其中/oip/rest保持不變。 實例：基于 REST 的服務(wù)請求以使用“查詢 BSS 用戶短信詳單”服務(wù)為例，該服務(wù)的具體信息如下：服務(wù)名稱：查詢 BSS 用戶短信詳單；服務(wù)編碼：SelectSmsInfo；開發(fā)技術(shù)：采用 HTTP 協(xié)議技術(shù)；請求方式：采用 GET/POST 都可以 調(diào)用方信息不變。. . . .. . 學(xué)習(xí)好幫手根據(jù)上面這些信息，得出服務(wù)訪問地址為：GET 方式：amp。msgId=crm_20220718_10001amp。busiURl=/SelectSmsInf/1末位的“1”是模擬業(yè)務(wù)參數(shù)。POST 方式：amp。msgId=crm_20220718_10001amp。busiURl=/SelectSmsInf/1業(yè)務(wù)參數(shù)的內(nèi)容放在 的請求體中傳輸 參數(shù)說明 系統(tǒng)級參數(shù)以下參數(shù)是由服務(wù)總線定義的。表格 31
公司管理相關(guān)推薦
鄂ICP備17016276號-1