Java-类库-Guava-Preconditions检验参数
2016-07-02 17:16
411 查看
在日常开发中,我们经常会对方法的输入参数做一些数据格式上的验证,以便保证方法能够按照正常流程执行下去。对于可预知的一些数据上的错误,我们一定要做事前检测和判断,来避免程序流程出错,而不是完全通过错误处理来保证流程正确执行,毕竟错误处理是比较消耗资源的方式。在平常情况下我们对参数的判断都需要自己来逐个写方法判断,代码量不少并且复用性不高,如下所示:
说明:参数验证,我们每次都要添加if语句来做判断, 重复的工作会做好多次。getPerson方法只有2个参数,验证规则也不是很复杂,如果参数过度,验证规则复杂后,上面代码的可读性都会很差的,复用性就更谈不上了。
Guava类库中提供了一个作参数检查的工具类–Preconditions类, 该类可以大大地简化我们代码中对于参数的预判断和处理,让我们对方法输入参数的验证实现起来更加简单优雅,下面我们看看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
checkNotNull在验证通过后直接返回, 可以这样方便地写代码: this.field = checkNotNull(field).
简单而又强大的可变参数’printf’风格的自定义错误信息.
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个参数,验证规则也不是很复杂,如果参数过度,验证规则复杂后,上面代码的可读性都会很差的,复用性就更谈不上了。
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); } }
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 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()); } }
总结
在静态导入后, 方法很明确无歧义, checkNotNull可以清楚地告诉你它是干什么的, 它会抛出怎样的异常.checkNotNull在验证通过后直接返回, 可以这样方便地写代码: this.field = checkNotNull(field).
简单而又强大的可变参数’printf’风格的自定义错误信息.
相关文章推荐
- mac上安装android studio出现Error:compileSdkVersion android-x requires compiling with JDK 7问题
- maven 构建项目时出错 “Dynamic Web Module 3.1 requires Java 1.7 or newer” in Eclipse
- Spring MVC 使用Servlet原生API作为参数
- Java-类库-Guava
- 问题:在MyEclipse中导入项目后遇到 building workspace has encountered problem
- java.io 文件分类
- Java中的多线程编程(一)
- Eclipse做安卓的时候,button按钮把那个textview文本挡住了
- Zookeeper的Java客户端(要把zookeeper用的足够熟练,才能说掌握了它)
- eclipse 编码助手 之 代码模板的设置
- Java中的异常
- 寻找最快的Java可随机访问排序列表
- JavaSE 基础 第61节 石头剪刀布小游戏
- Spring MVC POJO传参方式
- Struts2 MVC基础介绍
- Java入门笔记1
- spring mvc 的Controller类里的方法线程安全问题
- me常用的Eclipse 快捷操作
- Spring并发访问的线程安全性问题
- 如何利用记事本编写并运行一个java程序