优雅的参数检验 — guava的Preconditions

最新推荐文章于 2024-06-24 23:28:59 发布

原创最新推荐文章于 2024-06-24 23:28:59 发布 · 341 阅读

0 ·

CC 4.0 BY-SA版权

Java语言专栏收录该内容

56 篇文章

订阅专栏

本文详细介绍了Guava框架中的Preconditions工具，包括其主要功能和如何进行参数检验，如checkArgument、checkNotNull等方法的使用，以及它们在失败时抛出的不同异常类型。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

##前言：
工具类就是封装平常用的方法，不需要你重复造轮子，节省开发人员时间，提高工作效率。谷歌作为大公司，当然会从日常的工作中提取中很多高效率的方法出来。所以就诞生了guava。。。它包含以下东西：

集合 [collections]
缓存 [caching]
原生类型支持 [primitives support]
并发库 [concurrency libraries]
通用注解 [common annotations]
字符串处理 [string processing]
I/O 等等。

Preconditions工具

今天我们介绍下Preconditions工具如何检验参数，先来看看它都能做哪些类型的参数检验：

1 .checkArgument(boolean) ：
　　功能描述：检查boolean是否为真。用作方法中检查参数
　　失败时抛出的异常类型: IllegalArgumentException

2.checkNotNull(T)：
　　功能描述：检查value不为null，直接返回value；
　　失败时抛出的异常类型：NullPointerException

3.checkState(boolean)：
　　功能描述：检查对象的一些状态，不依赖方法参数。例如， Iterator可以用来next是否在remove之前被调用。
　　失败时抛出的异常类型：IllegalStateException

4.checkElementIndex(int index, int size)：
　　功能描述：检查index是否为在一个长度为size的list， string或array合法的范围。 index的范围区间是[0, size)[包含0不包含size)。无需直接传入list， string或array，只需传入大小。返回index。
　　失败时抛出的异常类型：IndexOutOfBoundsException

5.checkPositionIndex(int index, int size)：
　　功能描述：检查位置index是否为在一个长度为size的list， string或array合法的范围。 index的范围区间是[0， size)[包含0不包含size)。无需直接传入list， string或array，只需传入大小。返回index。
　　失败时抛出的异常类型：IndexOutOfBoundsException

6.checkPositionIndexes(int start, int end, int size)：
　　功能描述：检查[start, end)是一个长度为size的list， string或array合法的范围子集。伴随着错误信息。
　　失败时抛出的异常类型：IndexOutOfBoundsException

举个栗子

import com.google.common.base.Preconditions;

public class PreconditionsDemo {
  public static void main(String args[]) {
    boolean demo=5<0;
    Preconditions.checkArgument(demo);
  }
}

输出：

Exception in thread "main" java.lang.IllegalArgumentException
   at com.google.common.base.Preconditions.checkArgument(Preconditions.java:108)
   at demo.PreconditionsDemo.main(PreconditionsDemo.java:8)

附录：

api ：
use