前置条件
前置条件:让方法调用的前置条件判断更简单。
Guava 在 Preconditions 类中提供了若干前置条件判断的实用方法,我们强烈建议在 Eclipse 中静态导入这些方法。每个方法都有三个变种:
- 没有额外参数:抛出的异常中没有错误消息;
- 有一个 Object 对象作为额外参数:抛出的异常使用 Object.toString() 作为错误消息;
- 有一个 String 对象作为额外参数,并且有一组任意数量的附加 Object 对象:这个变种处理异常消息的方式有点类似 printf,但考虑 GWT 的兼容性和效率,只支持%s 指示符。例如:
checkArgument(i >= 0, "Argument was %s but expected nonnegative", i);
checkArgument(i < j, "Expected i < j, but %s > %s", i, j);
方法声明(不包括额外参数) | 描述 | 检查失败时抛出的异常 |
checkArgument(boolean) | 检查 boolean 是否为 true,用来检查传递给方法的参数。 | IllegalArgumentException |
checkNotNull(T) | 检查 value 是否为 null,该方法直接返回 value,因此可以内嵌使用 checkNotNull。 | NullPointerException |
checkState(boolean) | 用来检查对象的某些状态。 | IllegalStateException |
checkElementIndex(int index, int size) | 检查 index 作为索引值对某个列表、字符串或数组是否有效。index>=0 && index<size * | IndexOutOfBoundsException |
checkPositionIndex(int index, int size) | 检查 index 作为位置值对某个列表、字符串或数组是否有效。index>=0 && index<=size * | IndexOutOfBoundsException |
checkPositionIndexes(int start, int end, int size) | 检查[start, end]表示的位置范围对某个列表、字符串或数组是否有效* | IndexOutOfBoundsException |
译者注:
索引值常用来查找列表、字符串或数组中的元素,如 List.get(int), String.charAt(int)
位置值和位置范围常用来截取列表、字符串或数组,如 List.subList(int,int), String.substring(int)
相比 Apache Commons 提供的类似方法,我们把 Guava 中的 Preconditions 作为首选。Piotr Jagielski 在他的博客中简要地列举了一些理由:
- 在静态导入后,Guava 方法非常清楚明晰。checkNotNull 清楚地描述做了什么,会抛出什么异常;
- checkNotNull 直接返回检查的参数,让你可以在构造函数中保持字段的单行赋值风格:this.field = checkNotNull(field)
- 简单的、参数可变的 printf 风格异常信息。鉴于这个优点,在 JDK7 已经引入 Objects.requireNonNull 的情况下,我们仍然建议你使用 checkNotNull。
在编码时,如果某个值有多重的前置条件,我们建议你把它们放到不同的行,这样有助于在调试时定位。此外,把每个前置条件放到不同的行,也可以帮助你编写清晰和有用的错误消息。
上一篇: 使用和避免 null
下一篇: 常见 Object 方法