首頁 > 軟體

詳解Spring中@Valid和@Validated註解用法

2022-07-21 22:00:19

案例引入

下面我們以新增一個員工為功能切入點,以常規寫法為背景,慢慢烘托出 @Valid 和 @Validated 註解用法詳解。

那麼,首先,我們會有一個員工物件 Employee,如下 :

/**
 * 員工物件
 * 
 * @author sunnyzyq
 * @since 2019/12/13
 */
public class Employee {
 
    /** 姓名 */
    public String name;
 
    /** 年齡 */
    public Integer age;
 
    public String getName() {
        return name;
    }
 
    public void setName(String name) {
        this.name = name;
    }
 
    public Integer getAge() {
        return age;
    }
 
    public void setAge(Integer age) {
        this.age = age;
    }
 
}

然後 Cotroller 中會有一個對應都新增方法 add(),如下:

@Controller
public class TestController {
 
    @RequestMapping("/add")
    @ResponseBody
    public String add(Employee employee) {
        // TODO 儲存到資料庫
        return "新增員工成功";
    }
 
}

現在要求:員工的名稱不能為空,且長度不能超過10個字元,那麼我們以前的做法大致如下:

寫完,我們啟動專案測試下:

(1)名稱為空情況

(2)正常情況

(3)超過長度情況

可以看到,和我們料想中的一樣,毫無問題。

除了名稱外,我們規定年齡也是必填項,且範圍在1到100歲,那麼此時,我們需要增加對應判定程式碼如下:

那麼問題來了,現在員工物件 Employee 就 2 個欄位,我們就寫了 10 多行的程式碼驗證,要是有20個欄位,豈不是要寫 100 多行程式碼?通常來說,當一個方法中的無效業務程式碼量過多時,往往程式碼設計有問題,當然這不是我們所想看到都結果。

那麼如何解決呢?首先大家應該會想到將對應的驗證過程抽成一個驗證方法,如下:

這樣來看,我們的業務方法就清爽多了。

但這種方式只是抽了一個方法,有一種換湯不換藥的感覺,雖然業務方法看起來清爽了很多,但書寫程式碼量並沒有下降,反而還多出了一個方法,這也不是我們理想中的樣子。

@Valid 詳解

此時,我們引出 Spring 中的 @valid 註解,這些問題就可以迎刃而解了,具體如下:

首先,我們在 Maven 設定中引入 @valid 的依賴:

如果你是 springboot 專案,那麼可以不用引入了,已經引入了,他就存在於最核心的 web 開發包裡面。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <version>2.0.5.RELEASE</version>
</dependency>

如果你不是 springboot 專案,那麼引入下面依賴即可:

<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>1.1.0.Final</version>
</dependency>
 
<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>5.4.1.Final</version>
</dependency>

那麼針對上面情景,我們可以對我們的程式碼進行優化了。

首先我們在 Employee 類的屬性上打上如下註解:

package com.zyq.beans;
 
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
 
import org.hibernate.validator.constraints.Length;
import org.hibernate.validator.constraints.Range;
 
/**
 * 員工物件
 * 
 * @author sunnyzyq
 * @since 2019/12/13
 */
public class Employee {
 
    /** 姓名 */
    @NotBlank(message = "請輸入名稱")
    @Length(message = "名稱不能超過個 {max} 字元", max = 10)
    public String name;
 
    /** 年齡 */
    @NotNull(message = "請輸入年齡")
    @Range(message = "年齡範圍為 {min} 到 {max} 之間", min = 1, max = 100)
    public Integer age;
 
    public String getName() {
        return name;
    }
 
    public void setName(String name) {
        this.name = name;
    }
 
    public Integer getAge() {
        return age;
    }
 
    public void setAge(Integer age) {
        this.age = age;
    }
 
}

然後再 Controller 對應方法上,對這個員工標上 @Valid 註解,表示我們對這個物件屬性需要進行驗證,

既然驗證,那麼就肯定會有驗證結果,所以我們需要用一個東西來存放驗證結果,做法也很簡單,在引數直接新增一個BindingResult,具體如下:

對應獲取驗證結果的程式碼如下:

OK ! 萬事俱備 !我們進行測試下:

(1)名稱為空

(2)名稱正常,年齡為空

(3)名稱超出範圍,年齡正常

(4)名稱正常,年齡超出範圍

可以看到,程式碼不但簡潔了很多,結果和預期的也一模一樣!很棒吧!!

常用註解:

除了剛剛都註解,最後再附加2個常用註解,我就直接貼圖了,基本上這6個註解可以解決99%的欄位,其他註解我就不貼圖了,如果不滿足,自己問百度。

@Validated 詳解

上面,我們講述了 @Valid 註解,現在我們來說說 @Validated 這個註解,在我看來,@Validated 是在 @Valid 基礎上,做的一個升級版。

我們可以看到,我們在使用 @Valid 進行驗證的時候,我們需要用一個物件去接收校驗結果,最後根據校驗結果判斷,從而提示使用者。

如果我們把手動校驗的這段程式碼刪除或註釋掉,那麼即使當我們的欄位不滿足規則時,方法種的程式也是能夠被執行的。

比如,我們將欄位值置空時,正常情況是會進行提示的。

 當我們把校驗邏輯註釋掉後,再次執行上面的請求後。

可以看到我們的程式繼續往後面去執行完成了。 

現在,我們去掉方法引數上的 @Valid 註解和其配對的 BindingResult 物件,

然後再校驗的物件前面新增上 @Validated 註解。

這個時候,我們再次請求,可以看到,我們請求報400錯誤了。

而我們通過程式的異常紀錄檔來看,提示說是 age 和 name 欄位為了空,致使請求失敗。

那麼,從這裡我們可以得知,當我們的資料存在校驗不通過的時候,程式就會丟擲

org.springframework.validation.BindException 的異常。

在實際開發的過程中,我們肯定不能講異常直接展示給使用者,而是給能看懂的提示。

於是,我們不妨可以通過捕獲異常的方式,將該異常進行捕獲。

首先我們建立一個校驗異常捕獲類 ValidExceptionHandler ,然後打上 @RestControllerAdvice 註解,該註解表示他會去抓所有 @Controller 標記類的異常,並在例外處理後返回以 JSON 或字串的格式響應前端。

算了,我直接將這段程式碼貼出來吧。

在異常捕捉到後,我們同上面的 @valid 校驗一樣,只返回第一個錯誤提示。

package com.zyq.config;
 
import org.springframework.validation.BindException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
 
@RestControllerAdvice
public class ValidExceptionHandler {
 
    @ExceptionHandler(BindException.class)
    public String validExceptionHandler(BindException exception) {
        return exception.getAllErrors().get(0).getDefaultMessage();
    }
 
}

那麼,我們現在重啟程式,然後重新請求,就可以發現介面已經不報400錯誤了,而是直接提示了我們的錯誤資訊。

@Valid 和 @Validated 比較

最後我們來對 @Valid 和 @Validated 兩個註解進行總結下:

(1)@Valid 和 @Validated 兩者都可以對資料進行校驗,待校驗欄位上打的規則註解(@NotNull, @NotEmpty等)都可以對 @Valid 和 @Validated 生效;

(2)@Valid 進行校驗的時候,需要用 BindingResult 來做一個校驗結果接收。當校驗不通過的時候,如果手動不 return ,則並不會阻止程式的執行;

(3)@Validated 進行校驗的時候,當校驗不通過的時候,程式會丟擲400異常,阻止方法中的程式碼執行,這時需要再寫一個全域性校驗異常捕獲處理類,然後返回校驗提示。

(4)總體來說,@Validated 使用起來要比 @Valid 方便一些,它可以幫我們節省一定的程式碼,並且使得方法看上去更加的簡潔。

到此這篇關於詳解Spring中@Valid和@Validated註解用法的文章就介紹到這了,更多相關Spring @Valid @Validated內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com!


IT145.com E-mail:sddin#qq.com