设计接口 是做什么的?
基于《软件设计哲学》中的“设计两次”原则:你的第一个想法不太可能最优。生成多个截然不同的设计,然后进行比较。
工作流程
1. 收集需求
在设计之前,理解:
- 此模块解决什么问题?
- 调用者是谁?(其他模块、外部用户、测试)
- 关键操作有哪些?
- 有什么约束?(性能、兼容性、现有模式)
- 哪些应隐藏在内部,哪些应暴露?
询问:“这个模块需要做什么?谁会用他?”
2. 生成设计(并行子代理)
使用任务工具同时启动 3 个以上的子代理。每个必须产生一个截然不同的方法。
每个子代理的提示模板:
为以下模块设计接口:[模块描述]
需求:[收集到的需求]
此设计的约束:[为每个代理分配不同的约束]
- 代理 1:“最小化方法数量 – 最多 1-3 个方法”
- 代理 2:“最大化灵活性 – 支持多种用例”
- 代理 3:“针对最常见的情况进行优化”
- 代理 4:“从 [特定范式/库] 汲取灵感”
输出格式:
1. 接口签名(类型/方法)
2. 使用示例(调用者如何使用)
3. 此设计隐藏了哪些内部细节
4. 此方法的权衡
3. 展示设计
逐个展示每个设计,包含:
- 接口签名 – 类型、方法、参数
- 使用示例 – 调用者如何在实际中使用
- 隐藏内容 – 保持在内部的复杂性
按顺序展示设计,以便用户在比较前充分吸收每个方案。
4. 比较设计
展示完所有设计后,基于以下标准进行比较:
- 接口简单性:更少的方法、更简单的参数
- 通用性与专用性:灵活性和针对性之间的权衡
- 实现效率:形状是否允许高效的内部实现?
- 深度:小接口隐藏大量复杂性(好)vs 大接口薄实现(差)
- 正确使用的难易度 vs 误用的可能性
用文字讨论权衡,而非表格。重点突出设计之间差异最大的地方。
5. 综合
通常最佳设计方案融合了多个选项的洞见。询问:
- “哪个设计最适合你的主要用例?”
- “是否有其他设计中的元素值得借鉴?”
评估标准
来自《软件设计哲学》:
接口简单性:更少的方法、更简单的参数 = 更易于学习和正确使用。
通用性:能够在无需更改的情况下处理未来用例。但注意避免过度泛化。
实现效率:接口的形状是否允许高效实现?还是会导致笨拙的内部结构?
深度:小接口隐藏大量复杂性 = 深层模块(好)。大接口薄实现 = 浅层模块(避免)。
反模式
- 不要让子代理产生相似的设计 – 强制要求截然不同的方案
- 不要跳过比较步骤 – 价值在于对比
- 不要实现 – 这纯粹关乎接口形状
- 不要基于实现工作量进行评估