一分鐘了解“好”接口的設計與實現
作者：58沈劍
如何設計好的接口，下面，我們就簡單從特性、設計和實現的基本原則來快速了解一下。
一、好接口的特性
(1) 易讀
(2) 易用，難于誤用
(3) 功能獨立
(4) 容易擴展
二、好接口設計的基本原則
(1) 只做并做好一件事
- 函數名自解釋
- 不恰當的函數名，往往是不恰當設計的征兆
(2) 如果沒做到上一點，就將函數分解
- 只增加，永遠不要刪除函數與接口(你永遠不知道這個接口被誰在使用)
(3) 實現永遠不能影響接口
- 舉例：不能假定函數調用者只能使用hash
- 不能對外暴露實現細節
(4) 最小化訪問
- 盡量使用私有化成員
- 注意信息隱藏
(5) 注意文檔與注釋
- 接口不是只寫給自己(即使只給自己，也應該有說明)
三、好接口實現的基本原則
(1) 不要到處拷貝代碼
(2) 原子性盡量在一個接口內保證
(3) Fail-Fast原則
- 出錯盡量早點返回，交給上層處理，不要勉強搶救
(4) 避免數據直接訪問，而是提供訪問方法
(5) 注意參數與返回值類型
- 盡量明確類型
- 能不用string盡量不用
- 使用float的地方盡量用double，64bit
(6) 參數個數不宜太多
- 如果過多，就要考慮接口的合理性了
【本文為51CTO專欄作者“58沈劍”原創稿件，轉載請聯系原作者】
責任編輯：趙寧寧
來源：
51CTO專欄
