谨慎设计方法签名（40）

2019独角兽企业重金招聘Python工程师标准>>>

本条目是若干API 设计技巧的总结：

1、谨慎选择方法的名称

• 始终遵循标准的命名习惯
• 易于理解，与同包的其他名称保持一致风格
• 选择大众认可名称相一致的名称，参见 java 类库 api

2、不要过于追求提供便利的方法

• 每个方法尽其所能，方法太多增加学习、使用、文档化、测试和维护的难度
• 只有一项操作被经常使用时，才考虑提供便捷方式；否则，不提供为好

3、避免过长参数列表

• 目标是四个参数，或者更少
• 相同类型长参数危害格外大，使用者顺序搞错后，仍能编译通过（运行时暴漏错误，不易排查）

4、有三种方法可以缩短参数列表

（1）把方法分解成多个方法，每个方法参数仅仅是参数列表子集

• 一不小心，会导致方法数量过多
• 多提炼公共子方法

（2）创建辅助类用来保存参数分组

• 辅助类一般是静态成员类
• 对于频繁出现的参数序列，可以被看做是作为某个独特实体，建议使用辅助类

（3）结合前两种，使用Builder（建造者）模式

• 详情参看建造者设计模式

5、对于参数类型优先使用接口，而不是类

• 比如应该使用Map 做参数而不是 HashMap等实现类
• 方便以后扩展

6、对于Boolean 参数，优先使用两个参数的 枚举类型

• 代码更加易于阅读和编写

转载于:https://my.oschina.net/u/3847203/blog/1839749