介面服務正規化

2021-10-18 23:02:40 字數 525 閱讀 8866

乙個好的後台介面,需要注意的細節:

1 介面名稱:動詞+名詞 簡潔明瞭,基本能說明介面的功能。

2 介面注釋:功能+作者+時間+出入引數

3 介面引數:定義清晰、規範定義(駝峰)、簡單明瞭,盡量直觀能表示其含義。

4 介面邏輯:

(1)入參引數的非空判斷

(2)入參引數格式校驗(型別:正則校驗、列舉校驗、資料字典校驗、大小寫校驗、業務資料校驗等。)

(3)介面業務邏輯**

資料庫互動(主意單個事物、整個服務型別事物的關係)、第三方接**互、內部接**互等略

(4)出參,result(泛型:業務引數,根據業務訴求合理設計業務引數)、status(狀態碼)、msg(資訊提示,場景覆蓋全)、success(布林型別,成功標識)。

5 注釋:介面分層次注釋,宣告每個私有方法的作用,簡潔明瞭。

6 日誌:介面出入口日誌標識、異常日誌資訊、可展示的業務資料日誌等(日誌級別遵照基本原則和專案組對日誌級別的要求)。

7 介面引數格式、協議、許可權等都遵照專案組的規定來處理。

客戶 伺服器程式設計正規化

本篇從基於tcp ip協議出發,現代流行的應對高併發請求網路服務端設計架構 1.tcp ip 模型 首先回顧一下tcp ip模型,並知道各個層次在作業系統的哪乙個層次 看上圖,osi模型的底下兩層是隨系統提供的裝置驅動程式和網路硬體。通常情況下,除需知道資料鏈路的某些特性外,我們不用關心這兩層的情況...

客戶 伺服器程式設計正規化

unix 網路程式設計第30章讀書筆記,這裡只記錄大致實現方式,具體 實現還請閱讀此書 tcp 迭代伺服器 完全同步方式,完全處理某個客戶的請求之後才專向下乙個客戶,優點是 簡單,並且沒有程序控制所需的時間 tcp 併發伺服器程式,每個客戶乙個子程序 傳統上併發伺服器呼叫fork 派生乙個子程序來處...

Linux C 伺服器程式設計正規化

unix網路程式設計 30章詳細介紹了幾種伺服器設計正規化。總結了其中的幾種,記錄一下 多程序的做法 1.每次建立乙個新的請求,fork乙個子程序,處理該連線的資料傳輸。2.預先派生一定數量的子程序,每個子程序都呼叫accept接收連線請求。當乙個請求到來之後會觸發所有程序的accept,但是只有最...