方法入?yún)z測(cè)工具類(lèi)
Web 應(yīng)用在接受表單提交的數(shù)據(jù)后都需要對(duì)其進(jìn)行合法性檢查,如果表單數(shù)據(jù)不合法,請(qǐng)求將被駁回。類(lèi)似的,當(dāng)我們?cè)诰帉?xiě)類(lèi)的方法時(shí),也常常需要對(duì)方法入?yún)⑦M(jìn)行合 法性檢查,如果入?yún)⒉环弦螅椒▽⑼ㄟ^(guò)拋出異常的方式拒絕后續(xù)處理。舉一個(gè)例子:有一個(gè)根據(jù)文件名獲取輸入流的方法:InputStream getData(String file),為了使方法能夠成功執(zhí)行,必須保證 file 入?yún)⒉荒転?null 或空白字符,否則根本無(wú)須進(jìn)行后繼的處理。這時(shí)方法的編寫(xiě)者通常會(huì)在方法體的最前面編寫(xiě)一段對(duì)入?yún)⑦M(jìn)行檢測(cè)的代碼,如下所示:
public InputStream getData(String file) {
if (file == null || file.length() == 0|| file.replaceAll("\s", "").length() == 0) {
throw new IllegalArgumentException("file入?yún)⒉皇怯行У奈募刂?);
}
…
}
類(lèi)似以上檢測(cè)方法入?yún)⒌拇a是非常常見(jiàn),但是在每個(gè)方法中都使用手工編寫(xiě)檢測(cè)邏輯的方式并不是一個(gè)好主意。閱讀 Spring 源碼,您會(huì)發(fā)現(xiàn) Spring 采用一個(gè) org.springframework.util.Assert 通用類(lèi)完成這一任務(wù)。
Assert 翻譯為中文為“斷言”,使用過(guò) JUnit 的讀者都熟知這個(gè)概念,它斷定某一個(gè)實(shí)際的運(yùn)行值和預(yù)期想一樣,否則就拋出異常。Spring 對(duì)方法入?yún)⒌臋z測(cè)借用了這個(gè)概念,其提供的 Assert 類(lèi)擁有眾多按規(guī)則對(duì)方法入?yún)⑦M(jìn)行斷言的方法,可以滿足大部分方法入?yún)z測(cè)的要求。這些斷言方法在入?yún)⒉粷M足要求時(shí)就會(huì)拋出 IllegalArgumentException。下面,我們來(lái)認(rèn)識(shí)一下 Assert 類(lèi)中的常用斷言方法:
斷言方法 說(shuō)明
notNull(Object object)
當(dāng) object 不為 null 時(shí)拋出異常,notNull(Object object, String message) 方法允許您通過(guò) message 定制異常信息。和 notNull() 方法斷言規(guī)則相反的方法是 isNull(Object object)/isNull(Object object, String message),它要求入?yún)⒁欢ㄊ?null;isTrue(boolean expression) / isTrue(boolean expression, String message)
當(dāng) expression 不為 true 拋出異常;notEmpty(Collection collection) / notEmpty(Collection collection, String message)
當(dāng)集合未包含元素時(shí)拋出異常。
notEmpty(Map map) / notEmpty(Map map, String message) 和 notEmpty(Object[] array, String message) / notEmpty(Object[] array, String message) 分別對(duì) Map 和 Object[] 類(lèi)型的入?yún)⑦M(jìn)行判斷;hasLength(String text) / hasLength(String text, String message) 當(dāng) text 為 null 或長(zhǎng)度為 0 時(shí)拋出異常;
hasText(String text) / hasText(String text, String message) text 不能為 null 且必須至少包含一個(gè)非空格的字符,否則拋出異常;
isInstanceOf(Class clazz, Object obj) / isInstanceOf(Class type, Object obj, String message) 如果 obj 不能被正確造型為 clazz 指定的類(lèi)將拋出異常;
isAssignable(Class superType, Class subType) / isAssignable(Class superType, Class subType, String message) subType 必須可以按類(lèi)型匹配于 superType,否則將拋出異常;
使用 Assert 斷言類(lèi)可以簡(jiǎn)化方法入?yún)z測(cè)的代碼,如 InputStream getData(String file) 在應(yīng)用 Assert 斷言類(lèi)后,其代碼可以簡(jiǎn)化為以下的形式:
public InputStream getData(String file){
Assert.hasText(file,"file入?yún)⒉皇怯行У奈募刂?);
① 使用 Spring 斷言類(lèi)進(jìn)行方法入?yún)z測(cè)
…
}
可見(jiàn)使用 Spring 的 Assert 替代自編碼實(shí)現(xiàn)的入?yún)z測(cè)邏輯后,方法的簡(jiǎn)潔性得到了不少的提高。Assert 不依賴于 Spring 容器,您可以大膽地在自己的應(yīng)用中使用這個(gè)工具類(lèi).