java编程中的断言工具类org.springframework.util.Assert
java编程中的断言工具类(org.springframework.util.Assert)
断言工具类:Assert类,
java.lang.Object —>org.springframework.util.Assert
先举个例子,
当我们在编写类的方法时,常常需要对方法入参进行合法性检查,如果入参不符合要求,方法将通过抛出异常的方式拒绝后续处理。如下所示:
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 容器,您可以大胆地在自己的应用中使用这个工具类。
方法摘要 | |
---|---|
static void | doesNotContain (java.lang.String textToSearch, java.lang.String substring) 断言,给定的文本不包含给定的子串。 |
static void | doesNotContain (java.lang.String textToSearch, java.lang.String substring, java.lang.String message) 断言,给定的文本不包含给定的子串。 |
static void | hasLength (java.lang.String text) 断言,由于String是不是空的,也就是说,它不能 null ,而不是空字符串。 |
static void | hasLength (java.lang.String text, java.lang.String message) 断言,由于String是不是空的,也就是说,它不能 null ,而不是空字符串。 |
static void | hasText (java.lang.String text) 断言定String具有有效的文本内容,即它不能 null ,并且必须至少包含一个非空格字符。 |
static void | hasText (java.lang.String text, java.lang.String message) 断言定String具有有效的文本内容,即它不能 null ,并且必须至少包含一个非空格字符。 |
static void | isAssignable (java.lang.Class superType, java.lang.Class subType) 断言 superType.isAssignableFrom(subType) 是 true 。 |
static void | isAssignable (java.lang.Class superType, java.lang.Class subType, java.lang.String message) 断言 superType.isAssignableFrom(subType) 是 true 。 |
static void | isInstanceOf (java.lang.Class clazz, java.lang.Object obj) 断言提供的对象是所提供的类的实例。 |
static void | isInstanceOf (java.lang.Class type, java.lang.Object obj, java.lang.String message) 断言提供的对象是所提供的类的实例。 |
static void | isNull (java.lang.Object object) 断言一个对象是 null 。 |
static void | isNull (java.lang.Object object, java.lang.String message) 断言一个对象是 null 。 |
static void | isTrue (boolean expression) 断言一个布尔表达式,扔 IllegalArgumentException 如果测试结果是 false 。 |
static void | isTrue (boolean expression, java.lang.String message) 断言一个布尔表达式,扔 IllegalArgumentException 如果测试结果是 false 。 |
static void | noNullElements (java.lang.Object[] array) 断言一个数组没有null元素。 |
static void | noNullElements (java.lang.Object[] array, java.lang.String message) 断言一个数组没有null元素。 |
static void | notEmpty (java.util.Collection collection) 断言,一个集合有元素,也就是说,它不能 null ,而且必须有至少一个元素。 |
static void | notEmpty (java.util.Collection collection, java.lang.String message) 断言,一个集合有元素,也就是说,它不能 null ,而且必须有至少一个元素。 |
static void | notEmpty (java.util.Map map) 断言,一个地图的作品,也就是说,它不能 null ,并且必须至少有一个条目。 |
static void | notEmpty (java.util.Map map, java.lang.String message) 断言,一个地图的作品,也就是说,它不能 null ,并且必须至少有一个条目。 |
static void | notEmpty (java.lang.Object[] array) 断言一个数组元素,即它不能 null ,而且必须有至少一个元素。 |
static void | notEmpty (java.lang.Object[] array, java.lang.String message) 断言一个数组元素,即它不能 null ,而且必须有至少一个元素。 |
static void | notNull (java.lang.Object object) 断言一个对象不 null 。 |
static void | notNull (java.lang.Object object, java.lang.String message) 断言一个对象不 null 。 |
static void | state (boolean expression) 断言一个布尔表达式,扔 IllegalStateException 如果测试结果是 false 。 |
static void | state (boolean expression, java.lang.String message) 断言一个布尔表达式,扔 IllegalStateException 如果测试结果是 false 。 |
从类 java.lang.Object 继承的方法 |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |