呼叫簡單
- SDK集成成本
- 呼叫簡單
- 功能可定制
- 功能可擴展
- 便于除錯
API介面設計
- 介面命名、引數名稱規范
- 命名（方法名稱、引數）明確無歧義，寧可名稱長，不可出現詞不達意，例如：name與userName，
- 通用名稱要統一，例如：userId與userID與mUserID；
- 能不用縮寫盡量不用縮寫
- 一個介面盡量只做一件事
- 條理清晰
- 呼叫者可能后面會有不同組合使用
- 引數設計
- 一些固定的引數可以通過config配置引數在SDK初始化的時候設定
- 介面引數盡量少
- 引數過多，可合并成一個物件
- 能同步盡量同步呼叫，回傳結果能不用回呼就別用回呼
- 多執行緒能自己處理就自己處理
性能高效
- 記憶體占用，記憶體抖動
- 多執行緒控制，避免主執行緒阻塞
- 電量消耗
回呼設計
- 減少全域回呼；必須全域回呼的，分模塊回呼
- 回呼中介面盡可能的少
- 例外情況回呼
- 錯誤回呼采用errorCode+errorMsg組合
日志設計
- 核心處理log
- log日志可配置，可控制列印log級別
穩定性，自主處理例外
- 先去驗證引數正確性
代碼注釋要規范和清楚
- 介面注釋要特別完善
- 注釋
幫助檔案，參考github高Star專案
- 如何接入
- 如何使用
- 版本更新記錄
注意
- TODO寫法：TODO 負責人 資訊
- 向后兼容
- 資源檔案命名
- 用統一前綴，并且可以區分到模塊
- 這樣即有利于不同模塊的資源區分，又可以防止資源沖突，
轉載請註明出處，本文鏈接：https://www.uj5u.com/yidong/264188.html
標籤：其他