作为顺序员的你,代码中最多的就是各种办法了,你是如何对参数停止校验的呢?
背景
大部分的办法和结构函数对传入的参数值有一些限制,比如:常见的索引值必须是非正数,对象援用不能为空。
你应该运用明晰的文档来标注一切的这些限制,然后在办法体末尾的中央强迫他们反省。
应该在错误发作的时分尽快的反省出来,这是基本准绳。
假设你不这么做,当错误发作的时分,错误将不会被检测出来,这让定位错误的源头变得更困难。
假设一个合法参数传递到一个办法中,在办法执行行停止了参数反省。它将会快速失败,并给出明晰的异常信息。
假设办法没有反省参数,下面这些事情会发作。
水平阐明
蹩脚办法会在执行进程中失败然后抛出一个不明白的异常;
更蹩脚办法会正常前往,但是悄然的计算了一个错误的值。
最蹩脚办法正常前往,但是一些对象处在一个不正确的形状,未来一个不确定的时间点在某些有关联的点会形成一个错误。
一句话总结:参数不校验会招致原子性失败。
引荐做法
对公共和保护办法,运用java文档的@throws标签来标注参数值不合法将抛出的异常。
常见的参数校验的异常类型如下:
只需你曾经曾经在文档中标注了办法参数的限制和违犯限制会抛出的异常,限制将是一个复杂的事情,下面是一个典型的例子。
/**
*@param m 必须是正整数
*@throws ArithmeticException 假设m<=0
**/
public BigInteger mod(BigInteger m){
if(m<=0){
throw new ArithmeticException("modulus <=0: "+ m);
} //todo 其它代码
}
留意:
文档注释并没有说, 假设m是空,mod将抛出NullPointException, 虽然这个办法确实会这样。调用m.signum()的时分这个异常被标注在类级别BigInteger的文档注释上,类级别的注释适用于一切的公共办法的参数,这是一个避免在每个办法独自的文档化标注NullPointException这种混乱的好办法。
也容许以结合@Nullable或许相似的注解来指明特殊参数可以为空,但是这个实际并不是标准的,并且有很多注解可以用来到达这个目的。
Objects适用类
Objects.requireNonNull办法,在Java7中添加的,十分的灵敏和方便,所以没有理由手动的执行空指针反省。 你也可以指定异常的详细信息,这个办法前往本人的输入,所以你可以在运用该值的时分执行一个空指针反省。
//一行代码运用java的空指针反省
this.strategy = Objects.requireNonNull(strategy,"strategy")
假设你可以疏忽前往值,你也可以依据你的需求运用Objects.requireNonNull作为独立的空指针反省。在Java9中,一个范围反省的办法被添加到了java.util.Objects中,包含了3个办法:
这3个办法没有空指针反省办法灵敏,它无法让你指定本人的异常详细信息,它被设计用在List和Array的索引反省上。 它也无法处置闭区间,但是只需你需求,这就是一个小便利。
Java断言
对一个不开放的办法,你作为包的作者,控制着办法的调用状况,你必须保证只要合法的参数值传递出来了。所以,对非地下的办法,你可以运用断言来停止参数反省,如下所示:
//私有协助排序函数
private static void sort(long a[] , int offset, int length){
assert a != null ; //更多代码
}
本质下去讲,断言声明条件一定是true , 疏忽客户端如何运用对应的包。跟普通的合法性反省不同,断言失败的时分抛出AssertError;跟普通的合法性反省不同,除非你启用他们否则断言对你没有任何影响和消耗。在java命令行启用指令:
-ea
或许
-enableassertions
更多断言的信息,查看java手册的Asserts;
反省参数的合法性十分重要,即使你的办法中没有用到,但是存储起来了,前面会用到。
举个例子: 静态工厂办法: 输入一个 int数组 ,前往一个array的 list视图, 假设客户端传入 null, 这个办法会抛出NPE, 由于办法会有一个直接反省,调用了Objects.requireNonNull。假设疏忽反省,办法会前往一个援用新创立的List的实例;
而客户端尝试运用的时分回抛出NPE; 这个时分,原始的List实例很难决议,很大能够会复杂到变成一个调试义务。
结构函数代表了一个特殊例子的准绳: 你应该反省行将存储稍后会用到的参数的合法性。
反省结构函数参数的合法性十分重要,它可以避免结构一个违犯类的不变性的对象。
异常状况
在执行办法计算之前,你应该反省办法参数 。 这个规则也有异常状况。
(责任编辑:admin)