Preconditions优雅的检验参数

时间 2019-11-13

标签 preconditions 优雅检验参数繁體版

原文原文链接

在平常开发中，咱们常常会对方法的输入参数作一些数据格式上的验证，以便保证方法可以按照正常流程执行下去。对于可预知的一些数据上的错误，咱们必定要作事前检测和判断，来避免程序流程出错，而不是彻底经过错误处理来保证流程正确执行，毕竟错误处理是比较消耗资源的方式。在日常状况下咱们对参数的判断都须要本身来逐个写方法判断，代码量很多而且复用性不高，以下所示：java

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 static void getPerson(int age,String neme)throws Exception{
        if(age>0&&neme!=null&&neme.isEmpty()!=true){
            System.out.println("a person age:"+age+",neme:"+neme);
        }else{
            System.out.println("参数输入有误！");
        }
    }
}

　说明：参数验证，咱们每次都要添加if语句来作判断, 重复的工做会作好屡次。getPerson方法只有2个参数，验证规则也不是很复杂，若是参数过分，验证规则复杂后，上面代码的可读性都会不好的，复用性就更谈不上了。less

　　Guava类库中提供了一个做参数检查的工具类--Preconditions类，该类能够大大地简化咱们代码中对于参数的预判断和处理，让咱们对方法输入参数的验证明现起来更加简单优雅，下面咱们看看Preconditions类的使用实例：　工具

import org.junit.Test;
import com.google.common.base.Preconditions;

public class PreconditionsTest {
    
    @Test
    public void Preconditions() 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());
        } 
    }
    
    public static void getPersonByPrecondition(int age,String neme)throws Exception{
        Preconditions.checkNotNull(neme, "neme为null");
        Preconditions.checkArgument(neme.length()>0, "neme为\'\'");
        Preconditions.checkArgument(age>0, "age 必须大于0");
        System.out.println("a person age:"+age+",neme:"+neme);
    }
}

运行结果：this

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

Preconditions里面的方法：google

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

　　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开发

　　一个比较实用实例：rem

import java.util.ArrayList;
import java.util.List;
import org.junit.Test;
import com.google.common.base.Preconditions;

public class PreconditionsTest {
    
    @Test
    public void Preconditions() 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());
        }
        
        List<Integer> intList=new ArrayList<Integer> ();
        for(int i=0;i<10;i++){            
            try {
                checkState(intList,9);
                intList.add(i);
            } catch (Exception e) {
                System.out.println(e.getMessage());
            }

        }
        
        try {
            checkPositionIndex(intList,3);    
        } catch (Exception e) {
            System.out.println(e.getMessage());
        }
        
        try {
            checkPositionIndex(intList,13);    
        } catch (Exception e) {
            System.out.println(e.getMessage());
        }
        
        try {
            checkPositionIndexes(intList,3,7);
        } catch (Exception e) {
            System.out.println(e.getMessage());
        }
        
        try {
            checkPositionIndexes(intList,3,17);
        } catch (Exception e) {
            System.out.println(e.getMessage());
        }
        
        try {
            checkPositionIndexes(intList,13,17);
        } catch (Exception e) {
            System.out.println(e.getMessage());
        }
        
        try {
            checkElementIndex(intList,6);
        } catch (Exception e) {
            System.out.println(e.getMessage());
        }
        
        try {
            checkElementIndex(intList,16);
        } catch (Exception e) {
            System.out.println(e.getMessage());
        }
    }
    
    public static void getPersonByPrecondition(int age,String neme)throws Exception{
        Preconditions.checkNotNull(neme, "neme为null");
        Preconditions.checkArgument(neme.length()>0, "neme为\'\'");
        Preconditions.checkArgument(age>0, "age 必须大于0");
        System.out.println("a person age:"+age+",neme:"+neme);
         
    }
    
    public static void checkState(List<Integer> intList,int index)throws Exception{
        //表达式为true不抛异常
        Preconditions.checkState(intList.size()<index, " intList size 不能大于"+index);
    }
    
    public static void checkPositionIndex(List<Integer> intList,int index) throws Exception{
        Preconditions.checkPositionIndex(index, intList.size(), "index "+index+" 不在 list中， List size为："+intList.size());
    }
    
    public static void checkPositionIndexes(List<Integer> intList,int start,int end) throws Exception{
        Preconditions.checkPositionIndexes(start, end, intList.size());
    }
    
    public static void checkElementIndex(List<Integer> intList,int index) throws Exception{
        Preconditions.checkElementIndex(index, intList.size(),"index 为 "+index+" 不在 list中， List size为： "+intList.size());
    }
}

输出结果：

a person age:8,neme:peida
age 必须大于0
neme为''
neme为null
 intList size 不能大于9
index 13 不在 list中， List size为：9 (13) must not be greater than size (9)
end index (17) must not be greater than size (9)
start index (13) must not be greater than size (9)
index 为 16 不在 list中， List size为： 9 (16) must be less than size (9)

Guava的preconditions有这样几个优势:

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