一坨一坨的 if/else 參數校驗,終于被 SpringBoot 參數校驗組件整干凈了!
數據的校驗的重要性就不用說了,即使在前端對數據進行校驗的情況下,我們還是要對傳入后端的數據再進行一遍校驗,避免用戶繞過瀏覽器直接通過一些 HTTP 工具直接向后端請求一些違法數據。
最普通的做法就像下面這樣。我們通過 if/else 語句對請求的每一個參數一一校驗。

這樣的代碼,小伙伴們在日常開發(fā)中一定不少見,很多開源項目都是這樣對請求入參做校驗的。
但是,不太建議這樣來寫,這樣的代碼明顯違背了 單一職責原則。大量的非業(yè)務代碼混雜在業(yè)務代碼中,非常難以維護,還會導致業(yè)務層代碼冗雜!
實際上,我們是可以通過一些簡單的手段對上面的代碼進行改進的!這也是本文主要要介紹的內容!
廢話不多說!下面我會結合自己在項目中的實際使用經驗,通過實例程序演示如何在 SpringBoot 程序中優(yōu)雅地的進行參數驗證(普通的 Java 程序同樣適用)。
不了解的朋友一定要好好看一下,學完馬上就可以實踐到項目上去。
并且,本文示例項目使用的是目前最新的 Spring Boot 版本 2.4.5!(截止到 2021-04-21)
示例項目源代碼地址:https://github.com/CodingDocs/springboot-guide/tree/master/source-code/bean-validation-demo 。
添加相關依賴
如果開發(fā)普通 Java 程序的的話,你需要可能需要像下面這樣依賴:

不過,相信大家都是使用的 Spring Boot 框架來做開發(fā)。
基于 Spring Boot 的話,就比較簡單了,只需要給項目添加上 spring-boot-starter-web 依賴就夠了,它的子依賴包含了我們所需要的東西。另外,我們的示例項目中還使用到了 Lombok。


但是?。?!Spring Boot 2.3 1 之后,spring-boot-starter-validation 已經不包括在了 spring-boot-starter-web 中,需要我們手動加上!


驗證 Controller 的輸入
驗證請求體
驗證請求體即使驗證被 @RequestBody 注解標記的方法參數。
PersonController
我們在需要驗證的參數上加上了@Valid注解,如果驗證失敗,它將拋出MethodArgumentNotValidException。默認情況下,Spring 會將此異常轉換為 HTTP Status 400(錯誤請求)。

PersonRequest
我們使用校驗注解對請求的參數進行校驗!

正則表達式說明:
^string: 匹配以 string 開頭的字符串string$:匹配以 string 結尾的字符串^string$:精確匹配 string 字符串(^Man$|^Woman$|^UGM$): 值只能在 Man,Woman,UGM 這三個值中選擇
GlobalExceptionHandler
自定義異常處理器可以幫助我們捕獲異常,并進行一些簡單的處理。如果對于下面的處理異常的代碼不太理解的話,可以查看這篇文章 《SpringBoot 處理異常的幾種常見姿勢》。

通過測試驗證
下面我通過 MockMvc 模擬請求 Controller 的方式來驗證是否生效。當然了,你也可以通過 Postman 這種工具來驗證。

使用 Postman 驗證

驗證請求參數
驗證請求參數(Path Variables 和 Request Parameters)即是驗證被 @PathVariable 以及 @RequestParam 標記的方法參數。
PersonController
一定一定不要忘記在類上加上 Validated 注解了,這個參數可以告訴 Spring 去校驗方法參數。

ExceptionHandler

通過測試驗證

使用 Postman 驗證


驗證 Service 中的方法
我們還可以驗證任何 Spring Bean 的輸入,而不僅僅是 Controller 級別的輸入。通過使用@Validated和@Valid注釋的組合即可實現這一需求!
一般情況下,我們在項目中也更傾向于使用這種方案。
一定一定不要忘記在類上加上 Validated 注解了,這個參數可以告訴 Spring 去校驗方法參數。

通過測試驗證:

輸出結果如下:
name 不能為空
sex 值不在可選范圍
Validator 編程方式手動進行參數驗證
某些場景下可能會需要我們手動校驗并獲得校驗結果。
我們通過 Validator 工廠類獲得的 Validator 示例。另外,如果是在 Spring Bean 中的話,還可以通過 @Autowired 直接注入的方式。
@Autowired
Validator validate
具體使用情況如下:

輸出結果如下:
sex 值不在可選范圍
name 不能為空
自定以 Validator(實用)
如果自帶的校驗注解無法滿足你的需求的話,你還可以自定義實現注解。
案例一:校驗特定字段的值是否在可選范圍
比如我們現在多了這樣一個需求:PersonRequest 類多了一個 Region 字段,Region 字段只能是China、China-Taiwan、China-HongKong這三個中的一個。
第一步,你需要創(chuàng)建一個注解 Region。

第二步,你需要實現 ConstraintValidator接口,并重寫isValid 方法。

現在你就可以使用這個注解:
@Region
private String region;
通過測試驗證

使用 Postman 驗證

案例二:校驗電話號碼
校驗我們的電話號碼是否合法,這個可以通過正則表達式來做,相關的正則表達式都可以在網上搜到,你甚至可以搜索到針對特定運營商電話號碼段的正則表達式。
PhoneNumber.java

PhoneNumberValidator.java

搞定,我們現在就可以使用這個注解了。

通過測試驗證


使用驗證組
驗證組我們基本是不會用到的,也不太建議在項目中使用,理解起來比較麻煩,寫起來也比較麻煩。簡單了解即可!
當我們對對象操作的不同方法有不同的驗證規(guī)則的時候才會用到驗證組。
我寫一個簡單的例子,你們就能看明白了!
1.先創(chuàng)建兩個接口,代表不同的驗證組
public interface AddPersonGroup {
}
public interface DeletePersonGroup {
}
2.使用驗證組

通過測試驗證:

驗證組使用下來的體驗就是有點反模式的感覺,讓代碼的可維護性變差了!盡量不要使用!
常用校驗注解總結
JSR303 定義了 Bean Validation(校驗)的標準 validation-api,并沒有提供實現。Hibernate Validation是對這個規(guī)范/規(guī)范的實現 hibernate-validator,并且增加了 @Email、@Length、@Range 等注解。Spring Validation 底層依賴的就是Hibernate Validation。
JSR 提供的校驗注解:
@Null被注釋的元素必須為 null@NotNull被注釋的元素必須不為 null@AssertTrue被注釋的元素必須為 true@AssertFalse被注釋的元素必須為 false@Min(value)被注釋的元素必須是一個數字,其值必須大于等于指定的最小值@Max(value)被注釋的元素必須是一個數字,其值必須小于等于指定的最大值@DecimalMin(value)被注釋的元素必須是一個數字,其值必須大于等于指定的最小值@DecimalMax(value)被注釋的元素必須是一個數字,其值必須小于等于指定的最大值@Size(max=, min=)被注釋的元素的大小必須在指定的范圍內@Digits (integer, fraction)被注釋的元素必須是一個數字,其值必須在可接受的范圍內@Past被注釋的元素必須是一個過去的日期@Future被注釋的元素必須是一個將來的日期@Pattern(regex=,flag=)被注釋的元素必須符合指定的正則表達式
Hibernate Validator 提供的校驗注解:
@NotBlank(message =)驗證字符串非 null,且長度必須大于 0@Email被注釋的元素必須是電子郵箱地址@Length(min=,max=)被注釋的字符串的大小必須在指定的范圍內@NotEmpty被注釋的字符串的必須非空@Range(min=,max=,message=)被注釋的元素必須在合適的范圍內
拓展
經常有小伙伴問到:“@NotNull 和 @Column(nullable = false) 兩者有什么區(qū)別?”
我這里簡單回答一下:
@NotNull是 JSR 303 Bean 驗證批注,它與數據庫約束本身無關。@Column(nullable = false): 是 JPA 聲明列為非空的方法。
總結來說就是即前者用于驗證,而后者則用于指示數據庫創(chuàng)建表的時候對表的約束。
歡迎添加程序汪個人微信 itwang007 進粉絲群或圍觀朋友圈
往期資源 需要請自取
堪稱神級的Spring Boot手冊,從基礎入門到實戰(zhàn)進階
喜歡就"在看"唄^_^
