第四十条 谨慎设计方法签名


本条目是若干API的设计技巧总结,是总结性文字。


一、谨慎地选择方法的名称。这个我们应该遵循命名模式的规范,比如驼峰命名,言简意赅,不要词不达意,应该与包名的风格一样,同时大众化的,不要选择生僻的单词,也不要使用拼音,更多的命名规范后面会细讲; 二、不要过于追求提供便利的方法。方法应尽其所能,方法太多的话,会把人绕晕,需要花费大量时间学习和维护,要尽量简化; 三、避免过长的参数列表。一个方法中,如果形参的个数太多的话,我们看起来会比较费力,尽量控制在四个以内,过多的参数容易使人眼晕,并且一旦使用者把两个参数的位置颠倒了,就出错了。

有几种方法可以缩短过长的参数类表:第一,把方法拆分,分解成一个个的小函数,各司其职。之前有个同事就是写代码,正常情况下每个方法不会超过20行,相同的功能就会抽取封装;第二,创建辅助类,比如静态类,来保存参数的分组;第三,例如用Builder模式,第二条中有讲解,允许用setter方法设置参数;第四,对于参数类型,接口优先于class类,便于抽象和扩展;第五,对于boolean和数字类型,可以使用枚举代替,这样更容易理解。

你可能感兴趣的:(java,effective,注解)