一、步驟概覽

二、步驟說明

1.引入依賴包

在 pom.xml 文件中引入 validation 組件,它提供了在 Spring Boot 應用程序中進行參數校驗的支持。

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

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

validation組件主要功能包括：

• 支持注解驅動的校驗： 使用 JSR-380 提供的注解進行參數校驗，例如 @NotNull、@NotBlank、@Size 等。
• 對 Controller 方法參數的校驗支持： 在 Controller 的方法參數上使用 @Valid 注解，觸發參數校驗。
• 定制化校驗錯誤信息： 支持自定義校驗錯誤信息，使得校驗失敗時能夠返回友好的錯誤提示。
• 校驗結果處理： 在校驗失敗時，將校驗結果存儲在 BindingResult 對象中，方便開發者獲取校驗錯誤信息進行處理。
• 集成 Hibernate Validator： 基于 Hibernate Validator 實現參數校驗，支持豐富的校驗功能，如自定義校驗器、分組校驗等。

2.使用校驗注解

在實體類上添加對應校驗的注解，如@NotEmpty，@NotNull,@Max等。使用實例如下所示：

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

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

3.處理綁定異常

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

4.控制層啟用校驗

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

其中@Valid 注解和@Validated注解還是有點區別的，區別如下所示，我們在使用時，可根據其特性按需使用。

三、測試結果

測試如圖所示：

返回的信息按照統一的格式返回，并提示我們哪個參數校驗失敗。