方法设计上面的注意点,焦点在于可用性,健壮性,灵活性。
1.有效性的检查很昂贵,方法参数的限制写道文档中,通过显示的检查来实施限制。
2.JAVA是安全性的语言对于缓冲区溢出,数组越界,非法指针内存错误都自动免疫,但是也要保护性的设计程序。
构造函数的每个可变参数进行保护性拷贝很重要,保护性拷贝动作是在检查参数的有效性之前进行,并且有效性检查是针对拷贝后的对象,而非原始对象。
请不要使用CLONE方法进行参数的保护性拷贝,因为参数类型可以被不可信方子类化。
容易被攻击的写法:
public final class Period {
private final Date start;
private final Date end;
public Period(Date start, Date end) {
// TODO Auto-generated constructor stub
if(start.compareTo(end) > 0) {
throw new IllegalArgumentException(start + " after: " +end);
}
this.start = start;
this.end = end;
}
public Date start() {
return this.start;
}
public Date end(){
return this.end;
}
}
被攻击的地方有:
1)构造函数的Date本身可变,在对period进行构造后,在传入的end对象中又可以修改,因为end是period的引用传入,所以period类里面的end也被改掉了
2)访问方法也是引用参数,所以也可能被修改。
进行保护性拷贝的修改后如下:
public final class Period {
private final Date start;
private final Date end;
public Period(Date start, Date end) {
// TODO Auto-generated constructor stub
this.start = new Date(start.getTime());
this.end = new Date(end.getTime());
if(start.compareTo(end) > 0) {
throw new IllegalArgumentException(start + " after: " +end);
}
}
public Date start() {
return (Date)this.start.clone();
}
public Date end(){
return (Date)this.end.clone();
}
}
3.内部组件返回给客户之前,对他们进行保护性拷贝也是同样的道理,非零长度的数组总是可变的。非零长度的数组要进行保护性拷贝。
或者给用户返回该数组的一个非可变视图。
另外一种方法就是使用非可变的对象作为对象内部组件。比如上面的例子中不用Date作为成员变量,而是用Date.getTime()的long原语类型。
4. API设计技巧
- 谨慎选择方法的名字,方便易懂,遵循规范。
- 不要过于追求便利方法,每个方法都有自己的功能特点。
- 避免长长的参数列表,免得传错参数。(多用几个方法,或子集方法)
- 参数类型,优先使用接口而不是类。
- 少用函数对象,除非万不得已.(语法上的混乱,功能的局限性上每次都要频繁地创建函数对象)
- 谨慎使用重载,对于重载方法的选择是静态的,改写方法是动态的。
(重载是在编译的时候做出的被调用,如果有相同的类型则被覆盖,改写是运行时子类覆盖父类的方法时子类相同的方法将被调用)
安全保守的策略是 永远不要导出两个具有相同参数数目的重载方法
- 返回零长度的数组,而不是NULL.这样很容易给客户程序员带来多余的代码或者崩溃。
非零长度的数组是可变的,而零长度的数组是非可变的。
private List<Cheese> cheeseInstock = new ArrayList<Cheese>();
private final static Cheese[] NULL_CHEESE_ARRAY = new Cheese[0];
public Cheese[] getCheese(){
//集合为空的时候则返回输入数组
return (Cheese[]) cheeseInstock.toArray(NULL_CHEESE_ARRAY);
}