一、步驟概覽

springboot-如何集成Validation進(jìn)行參數(shù)校驗(yàn)

二、步驟說明

1.引入依賴包

在 pom.xml 文件中引入 validation 組件,它提供了在 Spring Boot 應(yīng)用程序中進(jìn)行參數(shù)校驗(yàn)的支持。

<!-- WEB 程序依賴包 -->
<dependency>
  <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-web</artifactId>
</dependency>

<!-- 校驗(yàn)依賴包 -->
<dependency>
  <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

validation組件主要功能包括：

支持注解驅(qū)動(dòng)的校驗(yàn)：使用 JSR-380 提供的注解進(jìn)行參數(shù)校驗(yàn)，例如 @NotNull、@NotBlank、@Size 等。
對(duì) Controller 方法參數(shù)的校驗(yàn)支持：在 Controller 的方法參數(shù)上使用 @Valid 注解，觸發(fā)參數(shù)校驗(yàn)。
定制化校驗(yàn)錯(cuò)誤信息：支持自定義校驗(yàn)錯(cuò)誤信息，使得校驗(yàn)失敗時(shí)能夠返回友好的錯(cuò)誤提示。
校驗(yàn)結(jié)果處理：在校驗(yàn)失敗時(shí)，將校驗(yàn)結(jié)果存儲(chǔ)在 BindingResult 對(duì)象中，方便開發(fā)者獲取校驗(yàn)錯(cuò)誤信息進(jìn)行處理。
集成 Hibernate Validator：基于 Hibernate Validator 實(shí)現(xiàn)參數(shù)校驗(yàn)，支持豐富的校驗(yàn)功能，如自定義校驗(yàn)器、分組校驗(yàn)等。

2.使用校驗(yàn)注解

在實(shí)體類上添加對(duì)應(yīng)校驗(yàn)的注解，如@NotEmpty，@NotNull,@Max等。使用實(shí)例如下所示：

可使用的注解列表如下所示：

@NotNull：被注釋的元素必須不為 null。適用于所有類型。
@NotBlank：被注釋的字符串必須非空且長度大于 0（去掉兩端空白字符后）。
@NotEmpty：被注釋的字符串、集合、Map 或數(shù)組必須非空。
@Size：被注釋的元素的大小必須在指定范圍內(nèi)。
@Min ：被注釋的元素的值必須大于或等于最小值。
@Max：被注釋的元素的值必須小于或等于最大值。
@DecimalMin：被注釋的元素的值必須大于或等于最小值。
@DecimalMax：被注釋的元素的值必須小于或等于最大值。
@EmAIl：被注釋的元素必須是一個(gè)合法的電子郵件地址。
@Pattern：被注釋的字符串必須符合指定的正則表達(dá)式。
@AssertTrue：被注釋的元素必須為 true。
@AssertFalse：被注釋的元素必須為 false。
@Future：被注釋的日期必須是未來的。
@FutureOrPresent：被注釋的日期必須當(dāng)前或未來的。
@Past ：被注釋的日期必須是過去的。
@PastOrPresent：被注釋的日期必須是當(dāng)前或過去的。

3.處理綁定異常

如果我們程序中使用了參數(shù)校驗(yàn)，當(dāng)參數(shù)校驗(yàn)不通過，接口返回至前端的格式并不是我們統(tǒng)一定義的格式，我們需要將參數(shù)校驗(yàn)的異常處理并按照統(tǒng)一格式返回至前端，我們可以定義全局的異常處理器來統(tǒng)一處理。處理示例如下所示：

4.控制層啟用校驗(yàn)

在實(shí)體類上添加校驗(yàn)注解，這只是定義了校驗(yàn)規(guī)則，并沒有真正啟用，在 Controller 方法上還需要使用 @Valid 或 @Validated注解啟用校驗(yàn)。使用示例如下圖所示：

其中@Valid 注解和@Validated注解還是有點(diǎn)區(qū)別的，區(qū)別如下所示，我們?cè)谑褂脮r(shí)，可根據(jù)其特性按需使用。

區(qū)別	@Valid	@Validated
適用范圍	方法參數(shù)、方法返回值、字段和方法級(jí)別	方法參數(shù)和方法返回值
驗(yàn)證順序	會(huì)遞歸地校驗(yàn)參數(shù)對(duì)象的屬性	不會(huì)遞歸地校驗(yàn)參數(shù)對(duì)象的屬性
分組校驗(yàn)	不支持分組校驗(yàn)	支持分組校驗(yàn)
驗(yàn)證器選擇	默認(rèn)使用 JAVA 標(biāo)準(zhǔn)的 Bean Validation（JSR 380）規(guī)范的驗(yàn)證器，例如 Hibernate Validator	使用 Spring 的驗(yàn)證器，例如 Spring Validator