`
sungang_1120
  • 浏览: 321558 次
  • 性别: Icon_minigender_1
  • 来自: 成都
社区版块
存档分类

Guava API学习之Preconditions优雅的检验参数

阅读更多

 

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

	
	public static void main(String[] args) {
		
	getPerson(8,"peida");
        
        getPerson(-9,"peida");
        
        getPerson(8,"");
        
        getPerson(8,null);	
	}
	
	
	public static void getPerson(int age,String name){
		if (age > 0 && null != name && 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类的使用实例: 

	@Test
	public void test(){
		//getPersonByPrecondition(8,"peida");
        
		getPersonByPrecondition(-9,"peida");
        
       // getPersonByPrecondition(8,"");
        //getPersonByPrecondition(8,null);	
	}
	
	public static void getPersonByPrecondition(int age,String name){
		Preconditions.checkNotNull(name, "neme为null");
        Preconditions.checkArgument(name.length()>0, "neme为\'\'");
        Preconditions.checkArgument(age>0, "age 必须大于0");
        System.out.println("a person age:"+age+",neme:"+name);
}

  

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

 

下面一个比较实用实例:

@Test
	public void test2() throws Exception{

		getPersonByPrecondition(8, "sungang");
		// result : a person age:8,neme:sungang
		
		try {
			getPersonByPrecondition(-9, "sunang");
		} catch (Exception e) {
			System.out.println(e.getMessage());
			// result :age 必须大于0
		}
		
		try {
			getPersonByPrecondition(8,"");
		} catch (Exception e) {
			System.out.println(e.getMessage());
			// result : neme为''
		}
		
		try {
			getPersonByPrecondition(8,null);
		} catch (Exception e) {
			System.out.println(e.getMessage());
			//result : neme为null
		}
		
		
		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());
				break;
				//result : intList size 不能大于:9
			}
		}
		
		
		try {
			checkPositionIndex(intList, 4);
		} catch (Exception e) {
			System.out.println(e.getMessage());
		}
		
		try {
			checkPositionIndex(intList, 10);
		} 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 {
			checkPositionIndexes(intList, 3, 8);
		} 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:sungang
age 必须大于0
neme为''
neme为null
intList size 不能大于:9
index :10 不在 list中,list size为:9 (10) 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'风格的自定义错误信息.

 

分享到:
评论

相关推荐

    guava-18.0-API文档-中文版.zip

    包含翻译后的API文档:guava-18.0-javadoc-API文档-中文(简体)版.zip 对应Maven信息:groupId:com.google.guava,artifactId:guava,version:18.0 使用方法:解压翻译后的API文档,用浏览器打开“index.html”...

    guava-API文档

    guava-API文档

    guava-17.0-API文档-中文版.zip

    包含翻译后的API文档:guava-17.0-javadoc-API文档-中文(简体)版.zip; Maven坐标:com.google.guava:guava:17.0; 标签:google、guava、中文文档、jar包、java; 使用方法:解压翻译后的API文档,用浏览器打开...

    guava-20.0-API文档-中文版.zip

    包含翻译后的API文档:guava-20.0-javadoc-API文档-中文(简体)版.zip; Maven坐标:com.google.guava:guava:20.0; 标签:google、guava、jar包、java、中文文档; 使用方法:解压翻译后的API文档,用浏览器打开...

    guava 常用API说明

    通过以上对Guava常用API的介绍,我们可以看出Guava库的强大之处在于它为Java开发提供了许多实用工具和优化,帮助我们编写出更高效、更易于维护的代码。在实际开发中,合理利用Guava能显著提升代码质量,提高开发效率...

    guava-23.0-API文档-中文版.zip

    包含翻译后的API文档:guava-23.0-javadoc-API文档-中文(简体)版.zip; Maven坐标:com.google.guava:guava:23.0; 标签:google、guava、中文文档、jar包、java; 使用方法:解压翻译后的API文档,用浏览器打开...

    guava-20.0-API文档-中英对照版.zip

    包含翻译后的API文档:guava-20.0-javadoc-API文档-中文(简体)-英语-对照版.zip; Maven坐标:com.google.guava:guava:20.0; 标签:google、guava、jar包、java、中英对照文档; 使用方法:解压翻译后的API文档,用...

    Guava 16.0 API (CHM格式)

    下面我们就开启优雅Java编程学习之旅!  项目相关信息:  官方首页:http://code.google.com/p/guava-libraries  官方下载:http://code.google.com/p/guava-libraries/downloads/list  官方文档:...

    guava-19.0-API文档-中英对照版.zip

    包含翻译后的API文档:guava-19.0-javadoc-API文档-中文(简体)-英语-对照版.zip; Maven坐标:com.google.guava:guava:19.0; 标签:google、guava、中英对照文档、jar包、java; 使用方法:解压翻译后的API文档,用...

    Guava 23.0 API (CHM格式)

    Guava 23.0 API CHM格式,可以搜索,方便离线查阅。

    guava-12.0.1-API文档-中英对照版.zip

    包含翻译后的API文档:guava-12.0.1-javadoc-API文档-中文(简体)-英语-对照版.zip 对应Maven信息:groupId:com.google.guava,artifactId:guava,version:12.0.1 使用方法:解压翻译后的API文档,用浏览器打开...

    guava-28.0-android-API文档-中文版.zip

    包含翻译后的API文档:guava-28.0-android-javadoc-API文档-中文(简体)版.zip; Maven坐标:com.google.guava:guava:28.0-android; 标签:google、guava、中文文档、jar包、java; 使用方法:解压翻译后的API文档,...

    guava-18.0-API文档-中英对照版.zip

    赠送原API文档:guava-18.0-javadoc.jar 赠送源代码:guava-18.0-sources.jar 包含翻译后的API文档:guava-18.0-javadoc-API文档-中文(简体)-英语-对照版.zip 对应Maven信息:groupId:com.google.guava,...

    guava-16.0.1-API文档-中文版.zip

    包含翻译后的API文档:guava-16.0.1-javadoc-API文档-中文(简体)版.zip; Maven坐标:com.google.guava:guava:16.0.1; 标签:google、guava、中文文档、jar包、java; 使用方法:解压翻译后的API文档,用浏览器打开...

    guava-30.0-jre-API文档-中文版.zip

    包含翻译后的API文档:guava-30.0-jre-javadoc-API文档-中文(简体)版.zip; Maven坐标:com.google.guava:guava:30.0-jre; 标签:google、guava、中文文档、jar包、java; 使用方法:解压翻译后的API文档,用浏览器...

    最新guava17.0jar,17.0API与guava16.0jar,16.0API

    - `guava-17.chm`和`guava-16.chm`是两个版本的官方API帮助文档,提供了详细的方法说明和使用示例,是学习和理解Guava API的重要资源。 6. **jar文件**: - `guava-17.0.jar`和`guava-16.0.1.jar`分别是两个版本...

    guava-api16/17/18chm

    《Guava API 16/17/18 深度解析》 Guava是Google推出的一个Java库,它包含一系列高效的、经过充分测试的、用于解决常见编程问题的工具类。Guava API 16/17/18版本的发布,为开发者提供了更加丰富和强大的功能。本文...

    guava学习知识点

    - **Preconditions**:提供便利的预条件检验方法,确保方法调用的正确性。 - **Objects**:提供了更简洁的 `hashCode()` 和 `toString()` 实现,以及其它实用的 Object 工具方法。 - **Sorting**:提供强大的 ...

    Guava 19 API ( CHM格式 )

    Guava 中文是石榴的意思,该项目是 Google 的一个开源项目,包含许多 Google 核心的 Java 常用库。 目前主要包含: com.google.common.annotations com.google.common.base com.google.common.collect ...

Global site tag (gtag.js) - Google Analytics