一、检查参数的有效性
1、考虑参数有哪些限制,把限制写到文档中,在方法的开头处通过显式地检查来实施这些限制。
二、必要时进行保护性拷贝
1、如果类具有从客户端得到或者返回的可变组件,类就必须考虑保护性拷贝这些组件。
2、如果拷贝成本比较高,类又可以信任他的客户端,不进行拷贝保护,但要进行文档的说明。
三、谨慎设计方法签名
1、谨慎地选择方法的名称:遵守规范,保持风格一致。
2、不要过于追求提供便利的方法。
3、编码过长的参数列表
a、一个方法分解成多个方法
b、创建辅助类,保存参数的分组。
c、使用Builder模式
4、对于参数类型,要优先使用接口而不是类
5、对于boolean参数,优先使用两个元素的枚举类型。
四、慎用重载
1、重载方法的调用是在编译时做出决定。覆盖方法的选择是在运行时做出决定。
2、尽量不要导出多个具有相同参数数目的重载方法。
3、不要重载具有可变参数的方法
五、慎用可变参数
六、返回零长度的数组或者集合,而不是null
1、返回类型为数组或者集合的方法应该返回一个零长度的数组或者集合,而不是null。
七、为所有导出的API元素编写文档注释
时间: 2024-11-13 16:52:48