本条目是若干API 设计技巧的总结:java
一、谨慎选择方法的名称设计模式
- 始终遵循标准的命名习惯
- 易于理解,与同包的其余名称保持一致风格
- 选择大众承认名称相一致的名称,参见 java 类库 api
二、不要过于追求提供便利的方法api
- 每一个方法尽其所能,方法太多增长学习、使用、文档化、测试和维护的难度
- 只有一项操做被常常使用时,才考虑提供便捷方式;不然,不提供为好
三、避免过长参数列表学习
- 目标是四个参数,或者更少
- 相同类型长参数危害格外大,使用者顺序搞错后,仍能编译经过(运行时暴漏错误,不易排查)
四、有三种方法能够缩短参数列表测试
(1)把方法分解成多个方法,每一个方法参数仅仅是参数列表子集ui
(2)建立辅助类用来保存参数分组设计
- 辅助类通常是静态成员类
- 对于频繁出现的参数序列,能够被看作是做为某个独特实体,建议使用辅助类
(3)结合前两种,使用Builder(建造者)模式接口
五、对于参数类型优先使用接口,而不是类文档
- 好比应该使用Map 作参数而不是 HashMap等实现类
- 方便之后扩展
六、对于Boolean 参数,优先使用两个参数的 枚举类型编译