每当编写方法或者构造器的时候,应该考虑他的参数有哪些限制。应该把这些限制写到文档中,并且在这个方法体的开头处,通过显式的检查来实施这些限制。养成这样的习惯是非常重要的。
demo:
1\对于公有的方法,要用Javadoc的@throws标签(tag)在文档中说明违反参数值限制会抛出异常。
手工抛出异常,并且添加@throws注解说明原因
/**
* hello.....
* @param m
* @return
* @throws NullPointerException if m is null
* @throws ArithmeticException if m is less than or equals to 0
*/
public BigInteger mod(BigInteger m) {
if(m == null){
throw new NullPointerException("m is null:" + m);
}
if (m.signum() <= 0) {
throw new ArithmeticException("Modulus <= 0: " + m);
}
// Do something
return null;
}
2\对于未被导出的方法(unexported method),作为包的创建者,你可以控制这个方法将在哪些情况下被使用,因此你可以,也应该确保只将有效的参数传递进来。
因此,非公有的方法通常应该使用断言(assertion)来检查他们的参数。
通过将-ea(或者-enableassertions)标记传递给java解释器,来启动他们。
(一般来说 assert 在开发的时候是检查程序的安全性的,在发布的时候通常都不使用 assert 。)
/**
*
* @param a
* @param offset
* @param length
*/
private static void sort(long[] a,int offset,int length){
assert a != null;
assert offset >= 0 && offset <= a.length;
System.out.println("sort do something");
}
不同于junit里的断言方法:
private static void sort2(long[] a, int offset, int length) {
Assert.assertTrue("a is null", a != null);
Assert.assertTrue(offset >= 0 && offset <= a.length);
System.out.println("sort do something");
}