博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
Preconditions优雅的检验参数
阅读量:6311 次
发布时间:2019-06-22

本文共 6686 字,大约阅读时间需要 22 分钟。

hot3.png

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

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);    }}

运行结果:

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

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
intList=new ArrayList
(); 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
intList,int index)throws Exception{ //表达式为true不抛异常 Preconditions.checkState(intList.size()
intList,int index) throws Exception{ Preconditions.checkPositionIndex(index, intList.size(), "index "+index+" 不在 list中, List size为:"+intList.size()); } public static void checkPositionIndexes(List
intList,int start,int end) throws Exception{ Preconditions.checkPositionIndexes(start, end, intList.size()); } public static void checkElementIndex(List
intList,int index) throws Exception{ Preconditions.checkElementIndex(index, intList.size(),"index 为 "+index+" 不在 list中, List size为: "+intList.size()); }}

输出结果:

a person age:8,neme:peidaage 必须大于0neme为''neme为null intList size 不能大于9index 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'风格的自定义错误信息.

转载于:https://my.oschina.net/u/2988360/blog/795612

你可能感兴趣的文章
BZOJ 2118 Dijkstra
查看>>
Go语言基础之结构体
查看>>
SpringCloud:Eureka Client项目搭建(Gradle项目)
查看>>
jqueryValidate
查看>>
ATL使用IE控件,并且屏蔽右键
查看>>
Jenkins
查看>>
linux下使用screen和ping命令对网络质量进行监控
查看>>
数据库设计技巧
查看>>
css定位概述
查看>>
C# 动态修改配置文件 (二)
查看>>
BOM:文档对象模型 --树模型
查看>>
我的Android进阶之旅------>WindowManager.LayoutParams介绍
查看>>
segment
查看>>
获取鼠标的原始移动值
查看>>
Linux信号 编程
查看>>
有关滚动与位置
查看>>
Box2D自定义重力
查看>>
chpasswd
查看>>
mysqldump --single-transaction 和--lock-tables参数详解
查看>>
android 数据库_sql语句总结
查看>>