前提条件
Guava提供了许多前置条件检查实用程序。我们强烈建议您静态导入这些内容。
每种方法都有三种变体:
- 没有额外的争论。抛出任何异常都没有错误消息。
- 一个额外的
Object
论点。抛出任何异常并显示错误消息object.toString()
。 - 一个额外的
String
参数,带有任意数量的附加Object
参数。这类似于printf,但对于GWT的兼容性和效率,它只允许使用%s
指标。- 注:
checkNotNull
,checkArgument
并且checkState
有大量服用的原始组合和过载的Object
参数,而不是一个可变参数阵列-这使得上面的调用,如那些以避免两个原始拳击,并在绝大多数情况下varags数组分配。
- 注:
第三种变体的例子:
checkArgument(i > = 0,“参数是%s但预期非负”,i);
checkArgument(i < j,“预期i <j,但%s> =%s ”,i,j);
签名(不包括额外的args) | 描述 | 失败时抛出异常 |
---|---|---|
checkArgument(boolean) |
检查boolean 是的true 。用于验证方法的参数。 |
IllegalArgumentException |
checkNotNull(T) |
检查该值是否为null。直接返回值,因此您可以使用checkNotNull(value) 内联。 |
NullPointerException |
checkState(boolean) |
检查对象的某些状态,而不依赖于方法参数。例如,Iterator 可以使用它来检查next 在调用之前是否已调用remove 。 |
IllegalStateException |
checkElementIndex(int index, int size) |
检查index 是具有指定大小的列表,字符串或数组的有效元素索引。元素索引的范围可以从0到size 包含。您不直接传递列表,字符串或数组; 你只是通过它的大小。 |
|
退货index 。 |
IndexOutOfBoundsException |
|
checkPositionIndex(int index, int size) |
检查具有指定大小的列表,字符串或数组中index 的有效位置索引。位置索引的范围可以从0到size 包括 0 。您不直接传递列表,字符串或数组; 你只是通过它的大小。 |
|
退货index 。 |
IndexOutOfBoundsException |
|
checkPositionIndexes(int start, int end, int size) |
检查[start, end) 具有指定大小的列表,字符串或数组的有效子范围。附带自己的错误消息。 |
IndexOutOfBoundsException |
出于几个原因,我们倾向于使用自己的前置条件检查,例如来自Apache Commons的类似实用程序。简述:
- 静态导入后,Guava方法清晰明确。
checkNotNull
清楚地表明正在做什么,以及将抛出什么异常。 -
checkNotNull
验证后返回其参数,允许构造函数中的简单单行:this.field = checkNotNull(field);
。 - 简单,varargs“printf-style”异常消息。(这个优势也是我们建议继续使用
checkNotNull
的原因Objects.requireNonNull
)
我们建议您将前提条件拆分为不同的行,这可以帮助您确定调试时哪些前提条件失败。此外,您应该提供有用的错误消息,这在每个检查都在自己的行上时更容易。
代码
public class Test {
static User user ;
public static void main(String[] args) {
//错误一
Preconditions.checkArgument(1==1,"{%s}","sss");
//错误二
Preconditions.checkNotNull(user);
//错误三
Preconditions.checkElementIndex(20,19,"越界");
}
}
错误一
Exception in thread "main" java.lang.IllegalArgumentException: {出错了}
at com.google.common.base.Preconditions.checkArgument(Preconditions.java:216)
at com.boolib.vcheck.Test.main(Test.java:11)
错误二
Exception in thread "main" java.lang.NullPointerException
at com.google.common.base.Preconditions.checkNotNull(Preconditions.java:877)
at com.boolib.vcheck.Test.main(Test.java:13)
错误三
Exception in thread "main" java.lang.IndexOutOfBoundsException: 越界 (20) must be less than size (19)
at com.google.common.base.Preconditions.checkElementIndex(Preconditions.java:1329)
at com.boolib.vcheck.Test.main(Test.java:14)
网友评论