Preconditions前置条件 - Google Guava

Guava Preconditions类

前置条件：让方法调用的前置条件判断更简单,可以简单理解为 guava 提供的 assert 断言。

 

Guava 在 Preconditions 类中提供了若干前置条件判断的实用方法，每个方法都有三个变种：

• 没有额外参数：抛出的异常中没有错误消息；
• 有一个 Object 对象作为额外参数：抛出的异常使用 Object.toString() 作为错误消息；
• 有一个 String 对象作为额外参数，并且有一组任意数量的附加 Object 对象：这个变种处理异常消息的方式有点类似 printf，但考虑 GWT 的兼容性和效率，只支持%s 指示符。

 

 

常用方法

方法声明（不包括额外参数）	描述	检查失败时抛出的异常
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

 

[ checkNotNull ] 检查value是否为null，该方法直接返回value

   Preconditions.checkNotNull(T reference)：检查条件是否为空，为空就抛出NullPointerException

try {
    Object object1 = Preconditions.checkNotNull("str");
    System.out.println(object1); // str

    Object object2 = Preconditions.checkNotNull(null);
    System.out.println(object2);
} catch (NullPointerException e){
    e.printStackTrace(); // java.lang.NullPointerException
}

 

   Preconditions.checkNotNull(T reference, Object errorMessage)：

检查条件是否为空，为空就抛出NullPointerException，并打印提示语

try {
    Object object = Preconditions.checkNotNull(null, "参数不能为空");
    System.out.println(object);
} catch (NullPointerException e){
    e.printStackTrace(); // java.lang.NullPointerException: 参数不能为空
}

 

   Preconditions.checkNotNull(T obj, @Nullable String errorMessageTemplate, int p1)

   Preconditions.checkNotNull(T obj, @Nullable String errorMessageTemplate, int p1, int p2)

   Preconditions.checkNotNull(T reference, @Nullable String errorMessageTemplate,

                                                         Object @Nullable ... errorMessageArgs)

   . . .

   检查条件是否为空，为空就抛出NullPointerException，并打印提示语，允许在错误信息中使用占位符。

             

try {
    Object object = Preconditions.checkNotNull(null, "参数不能为空，并且长度必须为 %s", 6);
    System.out.println(object);
} catch (NullPointerException e){
    e.printStackTrace(); // java.lang.NullPointerException: 参数不能为空，并且长度必须为 6
}

 

try {
    Object object = Preconditions.checkNotNull(null, "参数不能为空，并且长度必须为 %s - %s 位", 6, "12");
    System.out.println(object);
} catch (NullPointerException e){
    e.printStackTrace(); // java.lang.NullPointerException: 参数不能为空，并且长度必须为 6 - 12 位
}

 

try {
    Object object= Preconditions.checkNotNull(null, "参数不能为空，并且参数必须为 [%s, %s, %s, %s, %s] 中的一个", 1, "2", 3, true, 1.11);
    System.out.println(object);
} catch (NullPointerException e){
    e.printStackTrace(); // java.lang.NullPointerException: 参数不能为空，并且参数必须为 [1, 2, 3, true, 1.11] 中的一个
}

 

 

[ checkArgument ] 用来检查传递给方法的参数

   注意： 同时使用多个 Preconditions.checkArgument，在第一个抛出异常后，后面的checkArgument都不会执行

 

   Preconditions.checkArgument(boolean expression)：检查条件是否为真，为true就没有任何操作，

      为false抛出IllegalArgumentException

try{
    Preconditions.checkArgument(false);
}catch (IllegalStateException e){
    e.printStackTrace(); // java.lang.IllegalArgumentException
}

 

   Preconditions.checkArgument(boolean expression, Object errorMessage)：
      检查条件是否为真，为true就没有任何操作，为false抛出IllegalArgumentException，并打印提示语

try{
    Preconditions.checkArgument(false, "参数校验不通过");
}catch (IllegalStateException e){
    e.printStackTrace(); // java.lang.IllegalArgumentException: 参数校验不通过
}

 

   Preconditions.checkArgument(boolean expression, String errorMessageTemplate,Object ... errorMessageArgs)

   . . .

      检查条件是否为true，为true就没有任何操作，

      为false抛出IllegalArgumentException，并打印提示语，允许在错误信息中使用占位符。

             

try{
    Preconditions.checkArgument(1 > 3, "参数校验不通过, 数值不能小于 %s", 3);
}catch (IllegalStateException e){
    e.printStackTrace(); // java.lang.IllegalArgumentException: 参数校验不通过, 数值不能小于 3
}

 

 

[ checkState ] 用来检查对象的某些状态

   Preconditions.checkState(boolean expression)：检查条件是否为真，为true就没有任何操作，

      为false抛出IllegalArgumentException

try{
    Preconditions.checkState(false);
}catch (IllegalStateException e){
    e.printStackTrace(); // java.lang.IllegalArgumentException
}

 

   Preconditions.checkState(boolean expression, Object errorMessage)：
      检查条件是否为真，为true就没有任何操作，为false抛出IllegalArgumentException，并打印提示语

try{
    Preconditions.checkState(false, "参数校验不通过");
}catch (IllegalStateException e){
    e.printStackTrace(); // java.lang.IllegalArgumentException: 参数校验不通过
}

 

   Preconditions.checkState(boolean expression, String errorMessageTemplate,Object ... errorMessageArgs)

   . . .

      检查条件是否为true，为true就没有任何操作，

      为false抛出IllegalArgumentException，并打印提示语，允许在错误信息中使用占位符。

             

try{
    Preconditions.checkState(1 > 3, "参数校验不通过, 数值不能小于 %s", 3);
}catch (IllegalStateException e){
    e.printStackTrace(); // java.lang.IllegalArgumentException: 参数校验不通过, 数值不能小于 3
}

 

 

[ checkElementIndex ] 用于检查索引是否小于指定数值

   Preconditions.checkElementIndex(int index, int size)：

      用于检查索引是否小于指定数值，超出范围则抛出IndexOutOfBoundsException

try{
    List<String> list = Arrays.asList("A", "B", "C");
    int i = Preconditions.checkElementIndex(2, list.size());
    System.out.println(i); // 在范围内：返回索引：2

    int j = Preconditions.checkElementIndex(10, list.size());
    System.out.println(j);
} catch (IndexOutOfBoundsException e){
    e.printStackTrace(); // java.lang.IndexOutOfBoundsException: index (10) must be less than size (3)
}

 

   Preconditions.checkElementIndex(int index, int size, String desc)：

      用于检查索引是否小于指定数值，超出范围则抛出IndexOutOfBoundsException，并打印提示语

try{
    List<String> list = ImmutableList.of();
    int i = Preconditions.checkElementIndex(10, list.size(), "元素长度不正确");
    System.out.println(i);
} catch (IndexOutOfBoundsException e){
    e.printStackTrace(); // java.lang.IndexOutOfBoundsException: 元素长度不正确 (10) must be less than size (0)
}

 

 

[ checkPositionIndex ] 检查索引不得大于某个数值

   Preconditions.checkPositionIndex(int index, int size)：

      检查索引不得大于某个数值，超出范围则抛出IndexOutOfBoundsException

try{
    List<String> list = Arrays.asList("A", "B", "C");
    int i = Preconditions.checkPositionIndex(2, list.size());
    System.out.println(i); // 在范围内：返回索引：2

    int j = Preconditions.checkPositionIndex(10, list.size());
    System.out.println(j);
} catch (IndexOutOfBoundsException e){
    e.printStackTrace(); // java.lang.IndexOutOfBoundsException: index (10) must not be greater than size (3)
}

 

   Preconditions.checkPositionIndex(int index, int size, String desc)：

      检查索引不得大于某个数值，超出范围则抛出IndexOutOfBoundsException，并打印提示语

try{
    List<String> list = ImmutableList.of();
    int i = Preconditions.checkPositionIndex(10, list.size(), "元素长度不正确");
    System.out.println(i);
} catch (IndexOutOfBoundsException e){
    e.printStackTrace(); // java.lang.IndexOutOfBoundsException: 元素长度不正确 (10) must not be greater than size (0)
}

 

 

[ checkPositionIndexes ] 表示的位置范围，对对象、数组、集合等是否有效

   Preconditions.checkPositionIndexes：

      检查是否对象大小是否在指定范围内，如果不在，抛出IndexOutOfBoundsException

try{
    List<String> list = Arrays.asList("A", "B", "C");
    Preconditions.checkPositionIndexes(0, 4, list.size());
} catch (IndexOutOfBoundsException e){
    e.printStackTrace(); // java.lang.IndexOutOfBoundsException: end index (4) must not be greater than size (3)
}