Spring Assert 斷言

Spring 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 類中的常用斷言方法：

Spring Assert的所有方法：

斷言方法 說明

1. notNull(Object object) 

當 object 不為 null 時抛出異常，notNull(Object object, String message) 方法允許您通過 message 定制異常資訊。和 notNull() 方法斷言規則相反的方法是 isNull(Object object)/isNull(Object object, String message)，它要求入參一定是 null；

2. isTrue(boolean expression) / isTrue(boolean expression, String message) 

當 expression 不為 true 抛出異常；

3. 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[] 類型的入參進行判斷；

4. hasLength(String text) / hasLength(String text, String message) 

當 text 為 null 或長度為 0 時抛出異常；

5. hasText(String text) / hasText(String text, String message) 

text 不能為 null 且必須至少包含一個非空格的字元，否則抛出異常；

6. isInstanceOf(Class clazz, Object obj) / isInstanceOf(Class type, Object obj, String message) 

如果 obj 不能被正确造型為 clazz 指定的類将抛出異常；

7. 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 斷言類進行方法入參檢測

…

}