org.springframework.util.Assert

方法入参检测工具类

Web 应用在接受表单提交的数据后都需要对其进行合法性检查,如果表单数据不合法,请求将被驳回。

类似的,当我们在编写类的方法时,也常常需要对方法入参进行合 法性检查,如果入参不符合要求,方法将通过抛出异常的方式拒绝后续处理。

举一个例子:有一个根据文件名获取输入流的方法:InputStream getData(String file),为了使方法能够成功执行,必须保证 file 入参不能为 null 或空白字符,否则根本无须进行后继的处理。这时方法的编写者通常会在方法体的最前面编写一段对入参进行检测的代码,如下所示:

public InputStream getData(String file) {
    if (file == null || file.length() == 0|| file.replaceAll("\\s", "").length() == 0) {
        throw new IllegalArgumentException("file入参不是有效的文件地址");
    }
…
}

类似以上检测方法入参的代码是非常常见,但是在每个方法中都使用手工编写检测逻辑的方式并不是一个好主意

阅读 Spring 源码,您会发现 Spring 采用一个 org.springframework.util.Assert 通用类完成这一任务。

Assert 翻译为中文为“断言”,使用过 JUnit 的读者都熟知这个概念,它断定某一个实际的运行值和预期想一样,否则就抛出异常。

Spring 对方法入参的检测借用了这个概念,其提供的 Assert 类拥有众多按规则对方法入参进行断言的方法,可以满足大部分方法入参检测的要求。

这些断言方法在入参不满足要求时就会抛出 IllegalArgumentException。下面,我们来认识一下 Assert 类中的常用断言方法:

断言方法 说明
notNull(Object object) 当 object 不为 null 时抛出异常,notNull(Object object, String message) 方法允许您通过 message 定制异常信息。和 notNull() 方法断言规则相反的方法是 isNull(Object object)/isNull(Object object, String message),它要求入参一定是 null;
isTrue(boolean expression) / isTrue(boolean expression, String message) 当 expression 不为 true 抛出异常;
notEmpty(Collection collection) / notEmpty(Collection collection, String message) 当集合未包含元素时抛出异常。notEmpty(Map map) / notEmpty(Map map, String message) 和 notEmpty(Object[] array, String message) / notEmpty(Object[] array, String message) 分别对 Map 和 Object[] 类型的入参进行判断;
hasLength(String text) / hasLength(String text, String message) 当 text 为 null 或长度为 0 时抛出异常;
hasText(String text) / hasText(String text, String message) text 不能为 null 且必须至少包含一个非空格的字符,否则抛出异常;
isInstanceOf(Class clazz, Object obj) / isInstanceOf(Class type, Object obj, String message) 如果 obj 不能被正确造型为 clazz 指定的类将抛出异常;
isAssignable(Class superType, Class subType) / isAssignable(Class superType, Class subType, String message) subType 必须可以按类型匹配于 superType,否则将抛出异常;

使用 Assert 断言类可以简化方法入参检测的代码,如 InputStream getData(String file) 在应用 Assert 断言类后,其代码可以简化为以下的形式:

public InputStream getData(String file){
    Assert.hasText(file,"file入参不是有效的文件地址");
      使用 Spring 断言类进行方法入参检测
…
}

可见使用 Spring 的 Assert 替代自编码实现的入参检测逻辑后,方法的简洁性得到了不少的提高。Assert 不依赖于 Spring 容器,您可以大胆地在自己的应用中使用这个工具类。

转自:http://www.ibm.com/developerworks/cn/java/j-lo-spring-utils2/

时间: 2024-08-03 11:22:28

org.springframework.util.Assert的相关文章

java整合Jedis报错org.springframework.util.Assert.isTrue(ZLjava/util/function/Supplier;)V

<dependency> <groupId>org.springframework.data</groupId> <artifactId>spring-data-redis</artifactId> <version>2.0.5.RELEASE</version> </dependency> redis版本2.0.5 <dependency> <groupId>redis.clients

关于java.lang.NoSuchMethodError: org.springframework.util.ReflectionUtils.makeAccessible

<span style="font-size:18px;"> java.lang.NoSuchMethodError: org.springframework.util.ReflectionUtils.makeAccessible(Ljava/lang/reflect/Constructor;)V at org.springframework.beans.BeanUtils.instantiateClass(BeanUtils.java:146) at org.spring

源码分析六(org.springframework.util包之Assert类)

一:抽象类Assert 抽象类不能够实例化对象,但是可以被继承,Assert类是功能类,所以方法都是static修饰 所以可以直接  类名.方法 调用. public abstract class Assert 构造方法: 抽象类中的构造方法的意义,其实不是很大,因为它不能实例化对象,所以不会调用,但是 如果有类继承Assert类,那么就会在子类中调用父类的构造方法,如果父类中构造方法时自定义 的有参构造,那么在子类构造方法中就要显示的调用,如果是无参构造,那么不用再子类中显示的 调用,默认就会

源码分析八(org.springframework.util包之StringUtils类))

一:spring框架util包中的StringUtils类主要是处理关于字符串 的功能方法,下面直接结合代码分析: //判断字符串是否为空,如果为nul或者""则返回true,否则返回false public static boolean isEmpty(Object str) { return str == null || "".equals(str); } //判断字符串是否有长度,不等于null同时长度大于0,则为true //这里重载两个hasLength方

Spring Assert断言工具类

Spring 中 org.springframework.util.Assert 类实现合法性检测,Assert的方法如下: 断言方法说明: 1. notNull(Object object)  当 object 不为 null 时抛出异常,notNull(Object object, String message) 方法允许您通过 message 定制异常信息.和 notNull() 方法断言规则相反的方法是 isNull(Object object)/isNull(Object object

assert.notNull

今天我做JUnit关于MySQL测试时发现,类似于assertNull(tu)之类的代码不知道什么意思,因此稍微总结如下. org.springframework.util.AssertAssert翻译为中文为"断言".大概来说,就是断定某一个实际的值就为自己预期想得到的,如果不一样就抛出异常. spring源码如下: /*** Assert that an object is not <code>null</code> .* <pre class=&qu

Spring Assert断言 (方法入参检测工具类-断言)

Web 应用在接受表单提交的数据后都需要对其进行合法性检查,如果表单数据不合法,请求将被驳回.类似的,当我们在编写类的方法时,也常常需要对方法入参进行合 法性检查,如果入参不符合要求,方法将通过抛出异常的方式拒绝后续处理.举一个例子:有一个根据文件名获取输入流的方法:InputStream getData(String file),为了使方法能够成功执行,必须保证 file 入参不能为 null 或空白字符,否则根本无须进行后继的处理.这时方法的编写者通常会在方法体的最前面编写一段对入参进行检测

spring源码之—Assert.notNull

org.springframework.util.Assert Assert翻译为中文为"断言".用过JUNIT的应该都知道这个概念了. 就是断定某一个实际的值就为自己预期想得到的,如果不一样就抛出异常. Assert经常用于: 1.判断METHOD的参数是否属于正常值. 2.JUNIT中使用. 我发现SPRING1.2.6里面有BUG 请看: org.springframework.core.io.support.EncodedResource中 public EncodedReso

Spring Assert.notNull

Exception in thread "main" java.lang.IllegalArgumentException: Source must not be null at org.springframework.util.Assert.notNull(Assert.java:115) at Test.getaVoid(Test.java:11) at Test.main(Test.java:6) at sun.reflect.NativeMethodAccessorImpl.i