設計一個介面 是做什麼的?
基於《軟體設計哲學》中的「設計兩次」:你的第一個想法不太可能最好。生成多種截然不同的設計,然後進行比較。
工作流程
1. 收集需求
設計之前,先了解:
- 這個模組解決什麼問題?
- 誰是呼叫者?(其他模組、外部使用者、測試)
- 關鍵操作是什麼?
- 有什麼限制?(效能、相容性、現有模式)
- 哪些應該隱藏在內部,哪些應該暴露?
提問:「這個模組需要做什麼?誰會用它?」
2. 生成設計(平行子代理)
使用任務工具同時生成 3 個以上的子代理。每個必須產生截然不同的方法。
每個子代理的提示模板:
為 [模組描述] 設計一個介面
需求:[收集到的需求]
此設計的限制:[為每個代理指派不同的限制]
- 代理 1:「最小化方法數量——最多 1-3 個方法」
- 代理 2:「最大化靈活性——支援多種使用情境」
- 代理 3:「為最常見的案例最佳化」
- 代理 4:「從 [特定典範/函式庫] 汲取靈感」
輸出格式:
1. 介面簽名(型別/方法)
2. 使用範例(呼叫者如何使用)
3. 此設計隱藏在內部的東西
4. 此方法的取捨
3. 呈現設計
展示每種設計,包含:
- 介面簽名 - 型別、方法、參數
- 使用範例 - 呼叫者實際上如何使用
- 隱藏的內容 - 保留在內部的複雜度
依序呈現設計,讓使用者在比較之前先吸收每種方法。
4. 比較設計
顯示所有設計後,從以下方面比較:
- 介面簡潔性:方法較少、參數簡單
- 通用性 vs 專門化:靈活性 vs 專注度
- 實作效率:形狀是否允許高效的內部實作?
- 深度:小介面隱藏大量複雜度(好)vs 大介面搭配薄實作(壞)
- 正確使用的容易度 vs 誤用的可能性
以敘述方式討論取捨,不要用表格。重點說明設計之間分歧最大的部分。
5. 綜合
通常最佳設計會結合多個選項的見解。詢問:
- 「哪個設計最符合你的主要使用案例?」
- 「其他設計中有沒有值得納入的元素?」
評估標準
來自《軟體設計哲學》:
介面簡潔性:方法越少、參數越簡單,越容易學習和正確使用。
通用性:能否不需修改就處理未來的使用案例。但小心過度一般化。
實作效率:介面形狀是否允許高效的實作?還是會強迫使用彆扭的內部邏輯?
深度:小介面隱藏大量複雜度 = 深度模組(好)。大介面搭配薄實作 = 淺層模組(避免)。
反模式
- 不要讓子代理產出相似的設計——強制要求截然不同
- 不要跳過比較——價值在於對比
- 不要進行實作——這只關乎介面形狀
- 不要根據實作工作量來評估