Guava学习笔记：Preconditions优雅的检验参数

1.概述

在日常开发中，我们经常会对方法的输入参数做一些数据格式上的验证，以便保证方法能够按照正常流程执行下去。对于可预知的一些数据上的错误，我们一定要做事前检测和判断，来避免程序流程出错，而不是完全通过错误处理来保证流程正确执行，毕竟错误处理是比较消耗资源的方式。在平常情况下我们对参数的判断都需要自己来逐个写方法判断，代码量不少并且复用性不高，如下所示：

import org.junit.Test;

public class PreconditionsTest {

    @Test
    public void preconditions() throws Exception{
        getPerson(8, "peida");
        getPerson(-9,"peida");
        getPerson(8,"");
        getPerson(8,null);
    }

    public void getPerson(int age, String name) {
        if(age > 0 && name != null && name.isEmpty() != true){
            System.out.println("a person age:" + age + ",name:" + name);
        }else {
            System.out.println("参数输入有误!");
        }
    }

}

运行结果如下：

a person age:8,name:peida
参数输入有误!
参数输入有误!
参数输入有误!

说明：参数验证，我们每次都要添加if语句来做判断, 重复的工作会做好多次。getPerson方法只有2个参数，验证规则也不是很复杂，如果参数过度，验证规则复杂后，上面代码的可读性都会很差的，复用性就更谈不上了。
Guava类库中提供了一个作参数检查的工具类–Preconditions类， 该类可以大大地简化我们代码中对于参数的预判断和处理，让我们对方法输入参数的验证实现起来更加简单优雅，下面我们看看Preconditions类的使用实例:

 public static void getPersonByPrecondition(int age, String name) throws Exception {
        Preconditions.checkNotNull(name, "name为null");
        Preconditions.checkArgument(name.length() > 0, "name为\'\'");
        Preconditions.checkArgument(age > 0, "age 必须大于0");
        System.out.println("a person age:" + age + ",name:" + name);
    }

    @Test
    public void preconditions_1() throws Exception {
        getPersonByPrecondition(8,"peida");

        try {
            getPersonByPrecondition(-9,"peida");
        } catch (Exception e) {
            System.out.println(e.getMessage());

        }

        try {
            getPersonByPrecondition(8,"");
        } catch (Exception e) {
            System.out.println(e.getMessage());
        }

        try {
            getPersonByPrecondition(8,null);
        } catch (Exception e) {
            System.out.println(e.getMessage());
        }
    }

运行结果如下：

a person age:8,name:peida
age 必须大于0
name为''
name为null

2.API

Preconditions类大致分为6种提供参数检验的方法，每种方法都有三个重载方法。重载方法的参数意义是：

• 仅有待校验的参数：抛出的异常中没有错误消息；
• 有一个Object对象作为额外参数：抛出的异常使用Object.toString() 作为错误消息；
• 有一个String对象作为额外参数,还有一个Object[]参数，这两个参数也是适用于异常错误消息的，处理的方式类似于String.format将Object的参数按顺序替换掉String中的占位符(如%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

3.Guava的preconditions有这样几个优点

• 在静态导入后, 方法很明确无歧义, checkNotNull可以清楚地告诉你它是干什么的, 它会抛出怎样的异常.
• checkNotNull在验证通过后直接返回, 可以这样方便地写代码: this.field = checkNotNull(field).
• 简单而又强大的可变参数’printf’风格的自定义错误信息.