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

更新時(shí)間：2022年07月21日 17:17:32 作者：zyqok

本文將以新增一個(gè)員工為功能切入點(diǎn)，以常規(guī)寫法為背景，慢慢烘托出?@Valid?和?@Validated?注解用法詳解，文中的示例代碼講解詳細(xì)，感興趣的可以了解一下

案例引入

下面我們以新增一個(gè)員工為功能切入點(diǎn)，以常規(guī)寫法為背景，慢慢烘托出 @Valid 和 @Validated 注解用法詳解。

那么，首先，我們會(huì)有一個(gè)員工對(duì)象 Employee，如下：

/**
 * 員工對(duì)象
 * 
 * @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 中會(huì)有一個(gè)對(duì)應(yīng)都新增方法 add()，如下：

@Controller
public class TestController {
 
    @RequestMapping("/add")
    @ResponseBody
    public String add(Employee employee) {
        // TODO 保存到數(shù)據(jù)庫
        return "新增員工成功";
    }
 
}

現(xiàn)在要求：員工的名稱不能為空，且長度不能超過10個(gè)字符，那么我們以前的做法大致如下：

寫完，我們啟動(dòng)項(xiàng)目測試下：

（1）名稱為空情況

（2）正常情況

（3）超過長度情況

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

除了名稱外，我們規(guī)定年齡也是必填項(xiàng)，且范圍在1到100歲，那么此時(shí)，我們需要增加對(duì)應(yīng)判定代碼如下：

那么問題來了，現(xiàn)在員工對(duì)象 Employee 就 2 個(gè)字段，我們就寫了 10 多行的代碼驗(yàn)證，要是有20個(gè)字段，豈不是要寫 100 多行代碼？通常來說，當(dāng)一個(gè)方法中的無效業(yè)務(wù)代碼量過多時(shí)，往往代碼設(shè)計(jì)有問題，當(dāng)然這不是我們所想看到都結(jié)果。

那么如何解決呢？首先大家應(yīng)該會(huì)想到將對(duì)應(yīng)的驗(yàn)證過程抽成一個(gè)驗(yàn)證方法，如下：

這樣來看，我們的業(yè)務(wù)方法就清爽多了。

但這種方式只是抽了一個(gè)方法，有一種換湯不換藥的感覺，雖然業(yè)務(wù)方法看起來清爽了很多，但書寫代碼量并沒有下降，反而還多出了一個(gè)方法，這也不是我們理想中的樣子。

@Valid 詳解

此時(shí)，我們引出 Spring 中的 @valid 注解，這些問題就可以迎刃而解了，具體如下：

首先，我們?cè)?Maven 配置中引入 @valid 的依賴：

如果你是 springboot 項(xiàng)目，那么可以不用引入了，已經(jīng)引入了，他就存在于最核心的 web 開發(fā)包里面。

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

如果你不是 springboot 項(xiàng)目，那么引入下面依賴即可：

<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>

那么針對(duì)上面情景，我們可以對(duì)我們的代碼進(jìn)行優(yōu)化了。

首先我們?cè)?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;
 
/**
 * 員工對(duì)象
 * 
 * @author sunnyzyq
 * @since 2019/12/13
 */
public class Employee {
 
    /** 姓名 */
    @NotBlank(message = "請(qǐng)輸入名稱")
    @Length(message = "名稱不能超過個(gè) {max} 字符", max = 10)
    public String name;
 
    /** 年齡 */
    @NotNull(message = "請(qǐng)輸入年齡")
    @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 對(duì)應(yīng)方法上，對(duì)這個(gè)員工標(biāo)上 @Valid 注解，表示我們對(duì)這個(gè)對(duì)象屬性需要進(jìn)行驗(yàn)證，

既然驗(yàn)證，那么就肯定會(huì)有驗(yàn)證結(jié)果，所以我們需要用一個(gè)東西來存放驗(yàn)證結(jié)果，做法也很簡單，在參數(shù)直接添加一個(gè)BindingResult，具體如下：

對(duì)應(yīng)獲取驗(yàn)證結(jié)果的代碼如下：

OK ! 萬事俱備！我們進(jìn)行測試下：

（1）名稱為空

（2）名稱正常，年齡為空

（3）名稱超出范圍，年齡正常

（4）名稱正常，年齡超出范圍

可以看到，代碼不但簡潔了很多，結(jié)果和預(yù)期的也一模一樣！很棒吧??！

常用注解：

除了剛剛都注解，最后再附加2個(gè)常用注解，我就直接貼圖了，基本上這6個(gè)注解可以解決99%的字段，其他注解我就不貼圖了，如果不滿足，自己問百度。

@Validated 詳解

上面，我們講述了 @Valid 注解，現(xiàn)在我們來說說 @Validated 這個(gè)注解，在我看來，@Validated 是在 @Valid 基礎(chǔ)上，做的一個(gè)升級(jí)版。

我們可以看到，我們?cè)谑褂?@Valid 進(jìn)行驗(yàn)證的時(shí)候，我們需要用一個(gè)對(duì)象去接收校驗(yàn)結(jié)果，最后根據(jù)校驗(yàn)結(jié)果判斷，從而提示用戶。

如果我們把手動(dòng)校驗(yàn)的這段代碼刪除或注釋掉，那么即使當(dāng)我們的字段不滿足規(guī)則時(shí)，方法種的程序也是能夠被執(zhí)行的。

比如，我們將字段值置空時(shí)，正常情況是會(huì)進(jìn)行提示的。

當(dāng)我們把校驗(yàn)邏輯注釋掉后，再次執(zhí)行上面的請(qǐng)求后。

可以看到我們的程序繼續(xù)往后面去執(zhí)行完成了。

現(xiàn)在，我們?nèi)サ舴椒▍?shù)上的 @Valid 注解和其配對(duì)的 BindingResult 對(duì)象，

然后再校驗(yàn)的對(duì)象前面添加上 @Validated 注解。

這個(gè)時(shí)候，我們?cè)俅握?qǐng)求，可以看到，我們請(qǐng)求報(bào)400錯(cuò)誤了。

而我們通過程序的異常日志來看，提示說是 age 和 name 字段為了空，致使請(qǐng)求失敗。

那么，從這里我們可以得知，當(dāng)我們的數(shù)據(jù)存在校驗(yàn)不通過的時(shí)候，程序就會(huì)拋出

org.springframework.validation.BindException 的異常。

在實(shí)際開發(fā)的過程中，我們肯定不能講異常直接展示給用戶，而是給能看懂的提示。

于是，我們不妨可以通過捕獲異常的方式，將該異常進(jìn)行捕獲。

首先我們創(chuàng)建一個(gè)校驗(yàn)異常捕獲類 ValidExceptionHandler ，然后打上 @RestControllerAdvice 注解，該注解表示他會(huì)去抓所有 @Controller 標(biāo)記類的異常，并在異常處理后返回以 JSON 或字符串的格式響應(yīng)前端。

算了，我直接將這段代碼貼出來吧。

在異常捕捉到后，我們同上面的 @valid 校驗(yàn)一樣，只返回第一個(gè)錯(cuò)誤提示。

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();
    }
 
}

那么，我們現(xiàn)在重啟程序，然后重新請(qǐng)求，就可以發(fā)現(xiàn)界面已經(jīng)不報(bào)400錯(cuò)誤了，而是直接提示了我們的錯(cuò)誤信息。