Guava学习笔记：Preconditions优雅的检验参数
简介
在日常开发中，我们经常会对方法的输入参数做一些数据格式上的验证，以便保证方法能够按照正常流程执行下去。对于可预知的一些数据上的错误，我们一定要做事前检测和判断，来避免程序流程出错，而不是完全通过错误处理来保证流程正确执行，毕竟错误处理是比较消耗资源的方式。在平常情况下我们对参数的判断都需要自己来逐个写方法判断，代码量不少并且复用性不高，如下所示：
import org.junit.Test;
public class PreconditionsTest {
@Test
public void preconditions() throws Exception{
getPerson(8, "peida");
getPerson(-9,"peida");
getPerson(8,"");
getPerson(8,null);
}
public void getPerson(int age, String name) {
if(age > 0 && name != null && name.isEmpty() != true){
System.out.println("a person age:" + age + ",name:" + name);
}else {
System.out.println("参数输入有误!");
}
}
}
运行结果如下：
a person age:8,name:peida
参数输入有误!
参数输入有误!
参数输入有误!
说明：参数验证，我们每次都要添加if语句来做判断, 重复的工作会做好多次。getPerson方法只有2个参数，验证规则也不是很复杂，如果参数过度，验证规则复杂后，上面代码的可读性都会很差的，复用性就更谈不上了。
Guava类库中提供了一个作参数检查的工具类--Preconditions类， 该类可以大大地简化我们代码中对于参数的预判断和处理，让我们对方法输入参数的验证实现起来更加简单优雅，下面我们看看Preconditions类的使用实例:
@Test
public void preconditions_1() throws Exception {
getPersonByPrecondition(8,"peida");
try {
getPersonByPrecondition(-9,"peida");
} catch (Exception e) {
System.out.println(e.getMessage());
}
try {
getPersonByPrecondition(8,"");
} catch (Exception e) {
System.out.println(e.getMessage());
}
try {
getPersonByPrecondition(8,null);
} catch (Exception e) {
System.out.println(e.getMessage());
}
}
public static void getPersonByPrecondition(int age,String name)throws Exception{
Preconditions.checkNotNull(name, "name为null");
Preconditions.checkArgument(name.length()>0, "name为\'\'");
Preconditions.checkArgument(age>0, "age 必须大于0");
System.out.println("a person age:"+age+",name:"+name);
}
运行结果如下：
a person age:8,name:peida
age 必须大于0
name为''
name为null
Preconditions里面的方法
1.checkArgument(boolean)
功能描述：检查boolean是否为真。 用作方法中检查参数
失败时抛出的异常类型: IllegalArgumentException2.checkNotNull(T)
功能描述：检查value不为null， 直接返回value；
失败时抛出的异常类型：NullPointerException3.checkState(boolean)
功能描述：检查对象的一些状态，不依赖方法参数。例如，Ierator可以用来next是否在remove之前被调用。失败时抛出的异常类型：IllegalStateException4.checkElementIndex(int index, int size)
功能描述：检查index是否为在一个长度为size的list， string或array合法的范围。 index的范围区间是[0, size)(包含0不包含size)。无需直接传入list， string或array， 只需传入大小。返回index。失败时抛出的异常类型：IndexOutOfBoundsException5.checkPositionIndex(int index, int size)
功能描述：检查位置index是否为在一个长度为size的list， string或array合法的范围。 index的范围区间是[0， size)(包含0不包含size)。无需直接传入list， string或array， 只需传入大小。返回index。失败时抛出的异常类型：IndexOutOfBoundsException6.checkPositionIndexes(int start, int end, int size)
功能描述：检查[start, end)是一个长度为size的list，string或array合法的范围子集。伴随着错误信息。失败时抛出的异常类型：IndexOutOfBoundsException
一个比较实用的实例：
@Test
public void preconditions_2() throws Exception {
getPersonByPrecondition(8, "peida");
try {
getPersonByPrecondition(-9, "peida");
} catch (Exception e) {
System.out.println("e.getStackTrace():" + e.getStackTrace());
System.out.println("e.getMessage():" + e.getMessage());
System.out.println("e.getCause():" + e.getCause());
System.out.println("e.getSuppressed():" + e.getSuppressed());
}
try {
getPersonByPrecondition(8, "");
} catch (Exception e) {
System.out.println(e.getMessage());
}
System.out.println("getPersonByPrecondition(8, \"\")==============");
try {
getPersonByPrecondition(8, null);
} catch (Exception e) {
System.out.println(e.getMessage());
}
System.out.println("getPersonByPrecondition(8, null)==============");
List<Integer> intList = new ArrayList<Integer>();
for (int i = 0; i < 10; i++) {
try {
System.out.println("i:" + i);
checkState(intList, 9);
intList.add(i);
} catch (Exception e) {
System.out.println(e.getMessage());
}
}
System.out.println("checkState(intList, 9)===========");
try {
checkPositionIndex(intList, 3);
} catch (Exception e) {
System.out.println(e.getMessage());
}
System.out.println("checkPositionIndex(intList, 3)================");
try {
checkPositionIndex(intList, 13);
} catch (Exception e) {
System.out.println(e.getMessage());
}
System.out.println("checkPositionIndex(intList, 13)==============");
try {
checkPositionIndexes(intList, 3, 7);
} catch (Exception e) {
System.out.println(e.getMessage());
}
System.out.println("checkPositionIndexes(intList, 3, 7)============");
try {
checkPositionIndexes(intList, 3, 17);
} catch (Exception e) {
System.out.println(e.getMessage());
}
System.out.println("checkPositionIndexes(intList, 3, 17)===============");
try {
checkPositionIndexes(intList, 13, 17);
} catch (Exception e) {
System.out.println(e.getMessage());
}
System.out.println("checkPositionIndexes(intList, 13, 17)==============");
try {
checkElementIndex(intList, 6);
} catch (Exception e) {
System.out.println(e.getMessage());
}
System.out.println("checkElementIndex(intList, 6)===================");
try {
checkElementIndex(intList, 16);
} catch (Exception e) {
System.out.println(e.getMessage());
}
System.out.println("checkElementIndex(intList, 16)=================");
}
public static void getPersonByPrecondition(int age, String name) throws Exception {
Preconditions.checkNotNull(name, "name为null");
Preconditions.checkArgument(name.length() > 0, "name为\'\'");
Preconditions.checkArgument(age > 0, "age 必须大于0");
System.out.println("a person age:" + age + ",name:" + name);
}
public static void checkState(List<Integer> intList, int index) throws Exception {
//表达式为true不抛异常
Preconditions.checkState(intList.size() < index, " intList size 不能大于" + index);
}
public static void checkPositionIndex(List<Integer> intList, int index) throws Exception {
Preconditions.checkPositionIndex(index, intList.size(), "index " + index + " 不在 list中， List size为：" + intList.size());
}
public static void checkPositionIndexes(List<Integer> intList, int start, int end) throws Exception {
Preconditions.checkPositionIndexes(start, end, intList.size());
}
public static void checkElementIndex(List<Integer> intList, int index) throws Exception {
Preconditions.checkElementIndex(index, intList.size(), "index 为 " + index + " 不在 list中， List size为： " + intList.size());
}
打印结果如下：
a person age:8,name:peida
e.getStackTrace():[Ljava.lang.StackTraceElement;@6833ce2c
e.getMessage():age 必须大于0
e.getCause():null
e.getSuppressed():[Ljava.lang.Throwable;@725bef66
name为''
getPersonByPrecondition(8, "")==============
name为null
getPersonByPrecondition(8, null)==============
i:0
i:1
i:2
i:3
i:4
i:5
i:6
i:7
i:8
i:9
intList size 不能大于9
checkState(intList, 9)===========
checkPositionIndex(intList, 3)================
index 13 不在 list中， List size为：9 (13) must not be greater than size (9)
checkPositionIndex(intList, 13)==============
checkPositionIndexes(intList, 3, 7)============
end index (17) must not be greater than size (9)
checkPositionIndexes(intList, 3, 17)===============
start index (13) must not be greater than size (9)
checkPositionIndexes(intList, 13, 17)==============
checkElementIndex(intList, 6)===================
index 为 16 不在 list中， List size为： 9 (16) must be less than size (9)
checkElementIndex(intList, 16)=================
Guava的preconditions有这样几个优点
- 在静态导入后, 方法很明确无歧义, checkNotNull可以清楚地告诉你它是干什么的, 它会抛出怎样的异常.
- checkNotNull在验证通过后直接返回, 可以这样方便地写代码: this.field = checkNotNull(field).
- 简单而又强大的可变参数'printf'风格的自定义错误信息.
