Guava 学习笔记之 Preconditions

详细内容请参考Google Guava官方教程（中文版）

Preconditions

前置条件：让方法调用的前置条件判断更简单。

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	IndexOutOfBoundsException
checkPositionIndex(int index, int size)	检查index作为位置值对某个列表、字符串或数组是否有效。index>=0 && index<=size *	IndexOutOfBoundsException
checkPositionIndexes(int start, int end, int size)	检查[start, end]表示的位置范围对某个列表、字符串或数组是否有效*	IndexOutOfBoundsException

代码

package com.test.guava.BasicUtilities;

import com.google.common.base.Preconditions;

/**
 * @ClassName Precondition
 * @Description TODO
 * @Author 听秋
 * @Date 2021/9/3 11:39
 * @Version 1.0
 **/
public class PreconditionTest {

    public static void main(String[] args) {
        /**
         * checkArgument() 检查第一个参数是否为true，第二个参数为抛出异常时的自定义错误消息
         * 如："IllegalArgumentException: boolean值不为true"
         * 没有返回值
         **/
        Preconditions.checkArgument(1 > 0, "boolean值不为true");
        System.out.println("boolean值为true");

        /**
         * checkNotNull() 不为null返回第一个参数，否则抛出异常，第二个参数为抛出异常时的自定义错误消息
         * 如："NullPointerException: 不为null"
         **/
        Integer value = Preconditions.checkNotNull(4 , "不为null");
        System.out.println(value);

        /**
         * checkState() 检查对象状态是否为true，否则抛出异常，第二个参数为抛出异常时的自定义错误消息
         * 如："NullPointerException: 对象状态是否为false"
         **/
        Preconditions.checkState(1 > 0, "对象状态是否为false");

        /**
         * checkElementIndex() 检查第一个参数作为索引值是否有效（从0开始），正确则返回索引值，否则抛出异常IndexOutOfBoundsException
         * 如："NullPointerException: 对象状态是否为false"
         **/
        int i = Preconditions.checkElementIndex(3, 4);
        System.out.println(i);

        /**
         * checkPositionIndex() 检查第一个参数作为位置值是否有效（从1开始），正确则返回索引值，否则抛出异常IndexOutOfBoundsException
         * 如："NullPointerException: 对象状态是否为false"
         **/
        int j = Preconditions.checkPositionIndex(4, 4);
        System.out.println(j);

        /**
         * checkPositionIndexes() 检查[start, end)位置值是否有效（，正确end不大于size）则返回索引值，否则抛出异常IndexOutOfBoundsException
         * 如："NullPointerException: 对象状态是否为false"
         **/
        Preconditions.checkPositionIndexes(0, 4, 4);
    }
}

运行结果

boolean值为true
4
3
4

Process finished with exit code 0