google guava的base包中提供的Preconditions类用来方便的做参数的校验,他主要提供如下方法:
- checkArgument 接受一个boolean类型的参数和一个可选的errorMsg参数,这个方法用来判断参数是否符合某种条件,符合什么条件google guava不关心,在不符合条件时会抛出IllegalArgumentException异常
- checkState 和checkArgument参数和实现基本相同,从字面意思上我们也可以知道这个方法是用来判断状态是否正确的,如果状态不正确会抛出IllegalStateException异常
- checkNotNull方法用来判断参数是否不是null,如果为null则会抛出NullPointerException空指针异常
- checkElementIndex方法用来判断用户传入的数组下标或者list索引位置,是否是合法的,如果不合法会抛出IndexOutOfBoundsException
- checkPositionIndexes方法的作用和checkElementIndex方法相似,只是此方法的索引范围是从0到size包括size,而上面的方法不包括size。
下面我们看一个具体的使用示例:
package cn.outofmemory.guava.base; import com.google.common.base.Preconditions; public class PreconditionsDemo { public static void main(String[] args) { PreconditionsDemo demo = new PreconditionsDemo(); demo.doSomething("Jim", 19, "hello world, hello java"); } public void doSomething(String name, int age, String desc) { Preconditions.checkNotNull(name, "name may not be null"); Preconditions.checkArgument(age >= 18 && age < 99, "age must in range (18,99)"); Preconditions.checkArgument(desc !=null && desc.length() < 10, "desc too long, max length is ", 10); //do things } }
上面例子中的doSomething()方法的开头我们调用了三次Preconditions的方法,来对参数做校验。
看似Preconditions实现很简单,他的意义在于为我们提供了同一的参数校验,并对不同的异常情况抛出合适类型的异常,并对异常信息做格式化