Preconditions

Preconditions类提供了一个静态方法列表，用于检查方法或构造函数是否以有效的参数值被调用。如果一个先决条件失败，就会抛出一个定制的异常。Preconditions类中的每个静态方法都有三个变体：

没有参数，抛出的异常没有错误信息。
一个额外的Object参数作为错误信息。异常会被抛出一个错误信息。
一个额外的字符串参数，以及任意数量的额外对象参数作为一个占位符的错误信息。它的行为有点像printf，但为了GWT的兼容性和效率，它只允许使用%s指示器

我们来看看如何使用Preconditions类。

checkArgument

Preconditions类的方法checkArgument确保传递给调用方法的参数的真实性。该方法接受一个布尔条件，并在条件为假时抛出一个IllegalArgumentException。我们可以在不向checkArgument方法传递任何额外参数的情况下使用checkArgument：

@Test
public void whenCheckArgumentEvaluatesFalse_throwsException() {
    int age = -18;

    assertThatThrownBy(() -> Preconditions.checkArgument(age > 0))
      .isInstanceOf(IllegalArgumentException.class)
      .hasMessage(null).hasNoCause();
}

我们可以通过传递错误信息从checkArgument方法中得到一个有意义的错误信息：

@Test
public void givenErrorMsg_whenCheckArgEvalsFalse_throwsException() {
    int age = -18;
    String message = "Age can't be zero or less than zero.";

    assertThatThrownBy(() -> Preconditions.checkArgument(age > 0, message))
      .isInstanceOf(IllegalArgumentException.class)
      .hasMessage(message).hasNoCause();
}

我们可以通过传递一个错误信息，从checkArgument方法中得到一个有意义的错误信息以及动态数据：

@Test
public void givenTemplateMsg_whenCheckArgEvalsFalse_throwsException() {
    int age = -18;
    String message = "Age should be positive number, you supplied %s.";

    assertThatThrownBy(
      () -> Preconditions.checkArgument(age > 0, message, age))
      .isInstanceOf(IllegalArgumentException.class)
      .hasMessage(message, age).hasNoCause();
}

checkElementIndex

方法checkElementIndex检查一个索引是否是列表、字符串或指定大小的数组中的有效索引。元素索引的范围可以从0到大小不等。你不需要直接传递一个list、字符串或数组，你只需要传递它的大小。如果索引不是有效的元素索引，这个方法就会抛出IndexOutOfBoundsException，否则就会返回一个正在传递给方法的索引。

让我们看看如何使用这个方法，通过在检查ElementIndex方法抛出异常时传递一个错误信息来显示它的有意义的错误信息：

@Test
public void givenArrayAndMsg_whenCheckElementEvalsFalse_throwsException() {
    int[] numbers = { 1, 2, 3, 4, 5 };
    String message = "Please check the bound of an array and retry";

    assertThatThrownBy(() ->
      Preconditions.checkElementIndex(6, numbers.length - 1, message))
      .isInstanceOf(IndexOutOfBoundsException.class)
      .hasMessageStartingWith(message).hasNoCause();
}

checkNotNull

方法checkNotNull检查作为参数提供的值是否为空。它返回被检查的值。如果传递给这个方法的值是空的，那么就会抛出一个NullPointerException。接下来，我们将展示如何使用这个方法，通过传递错误信息，从checkNotNull方法中获取有意义的错误信息：

@Test
public void givenNullString_whenCheckNotNullWithMessage_throwsException () {
    String nullObject = null;
    String message = "Please check the Object supplied, its null!";

    assertThatThrownBy(() -> Preconditions.checkNotNull(nullObject, message))
      .isInstanceOf(NullPointerException.class)
      .hasMessage(message).hasNoCause();
}

我们还可以通过向错误信息传递一个参数，从checkNotNull方法中得到一个基于动态数据的有意义的错误信息：

@Test
public void whenCheckNotNullWithTemplateMessage_throwsException() {
    String nullObject = null;
    String message = "Please check the Object supplied, its %s!";

    assertThatThrownBy(
      () -> Preconditions.checkNotNull(nullObject, message,
        new Object[] { null }))
      .isInstanceOf(NullPointerException.class)
      .hasMessage(message, nullObject).hasNoCause();
}

checkPositionIndex

方法checkPositionIndex检查作为参数传递给本方法的索引是否是指定大小的列表、字符串或数组中的有效索引。一个位置索引的范围可以从0（含）到大小（含）。你不需要直接传递列表、字符串或数组，你只需要传递它的大小。

如果传递的索引不在0和给定的大小之间，这个方法就会抛出一个IndexOutOfBoundsException，否则就会返回索引值。让我们看看如何从checkPositionIndex方法中得到有意义的错误信息。

@Test
public void givenArrayAndMsg_whenCheckPositionEvalsFalse_throwsException() {
    int[] numbers = { 1, 2, 3, 4, 5 };
    String message = "Please check the bound of an array and retry";

    assertThatThrownBy(
      () -> Preconditions.checkPositionIndex(6, numbers.length - 1, message))
      .isInstanceOf(IndexOutOfBoundsException.class)
      .hasMessageStartingWith(message).hasNoCause();
}

checkState

方法checkState检查对象状态的有效性，并且不依赖于方法的参数。例如，一个Iterator可能会使用这个方法来检查在调用remove之前是否已经调用了next。如果对象的状态（作为方法参数传递的布尔值）处于无效状态，该方法会抛出一个IllegalStateException。

让我们看看如何使用这个方法，通过在checkState方法抛出异常时传递一个错误信息来显示它的有意义的错误信息。

@Test
public void givenStatesAndMsg_whenCheckStateEvalsFalse_throwsException() {
    int[] validStates = { -1, 0, 1 };
    int givenState = 10;
    String message = "You have entered an invalid state";

    assertThatThrownBy(
      () -> Preconditions.checkState(
        Arrays.binarySearch(validStates, givenState) > 0, message))
      .isInstanceOf(IllegalStateException.class)
      .hasMessageStartingWith(message).hasNoCause();
}

最近更新于0001-01-01