原文鏈接：https://mp.weixin.qq.com/s/KphcNU4W54L20uluPLEgQA
很痛苦遇到大量的參數進行校驗, 在業務中還要拋出異常或者不斷的返回異常時的校驗信息, 在代碼中相當冗長, 充滿了 if-else 這種校驗代碼, 今天我們就來學習 spring 的 javax.validation 註解式參數校驗.
爲什麼要用 validator
1.javax.validation 的一系列註解可以幫我們完成參數校驗, 免去繁瑣的串行校驗
不然我們的代碼就像下面這樣:
這被大佬看見, 一定說, 都 9102 了還這麼寫, 然後被勸退了….
2. 什麼是 javax.validation
JSR303 是一套 JavaBean 參數校驗的標準，它定義了很多常用的校驗註解，我們可以直接將這些註解加在我們 JavaBean 的屬性上面 (面向註解編程的時代)，就可以在需要校驗的時候進行校驗了, 在 SpringBoot 中已經包含在 starter-web 中, 再其他項目中可以引用依賴, 並自行調整版本:
3. 註解說明
-
@NotNull：不能爲 null，但可以爲 empty(""," "," ")
-
@NotEmpty：不能爲 null，而且長度必須大於 0 (""," ")
-
@NotBlank：只能作用在 String 上，不能爲 null，而且調用 trim() 後，長度必須大於 0("test") 即：必須有實際字符
此處只列出 Hibernate Validator 提供的大部分驗證約束註解，請參考 hibernate validator 官方文檔瞭解其他驗證約束註解和進行自定義的驗證約束註解定義。
實戰演練
話不多說, 直接走實踐路線, 同樣使用的是 SpringBoot 的快速框架
詳細代碼見:https://github.com/leaJone/mybot
1. @Validated 聲明要檢查的參數
這裏我們在控制器層進行註解聲明
2. 對參數的字段進行註解標註
3. 在全局校驗中增加校驗異常
MethodArgumentNotValidException 是 springBoot 中進行綁定參數校驗時的異常, 需要在 springBoot 中處理, 其他需要處理 ConstraintViolationException 異常進行處理.
爲了優雅一點, 我們將參數異常, 業務異常, 統一做了一個全局異常, 將控制層的異常包裝到我們自定義的異常中.
爲了優雅一點, 我們還做了一個統一的結構體, 將請求的 code, 和 msg,data 一起統一封裝到結構體中, 增加了代碼的複用性.
4. 測試
如下文: 確實做到了參數校驗時返回異常信息和對應的 code, 方便了我們不再繁瑣的處理參數校驗
在 ValidationMessages.properties 就是校驗的 message, 有着已經寫好的默認的 message, 且是支持 i18n 的, 大家可以閱讀源碼賞析
自定義參數註解
1. 比如我們來個 自定義身份證校驗 註解
這個註解是作用在 Field 字段上，運行時生效，觸發的是 IdentityCardNumber 這個驗證類。
-
message 定製化的提示信息，主要是從 ValidationMessages.properties 裏提取，也可以依據實際情況進行定製
-
groups 這裏主要進行將 validator 進行分類，不同的類 group 中會執行不同的 validator 操作
-
payload 主要是針對 bean 的，使用不多。
2. 然後自定義 Validator
這個是真正進行驗證的邏輯代碼：
IdCardValidatorUtils 在項目源碼中, 可自行查看
3. 使用自定義的註解
4. 使用 groups 的校驗
有的寶寶說同一個對象要複用, 比如 UserDTO 在更新時候要校驗 userId, 在保存的時候不需要校驗 userId, 在兩種情況下都要校驗 username, 那就用上 groups 了:
先定義 groups 的分組接口 Create 和 Update
再在需要校驗的地方 @Validated 聲明校驗組
在 DTO 中的字段上定義好 groups = {} 的分組類型
注意: 在聲明分組的時候儘量加上 extend javax.validation.groups.Default 否則, 在你聲明 @Validated(Update.class) 的時候, 就會出現你在默認沒添加 groups = {} 的時候的校驗組 @Email(message = "郵箱格式不對"), 會不去校驗, 因爲默認的校驗組是 groups = {Default.class}.
5.restful 風格用法
在多個參數校驗, 或者 @RequestParam 形式時候, 需要在 controller 上加註 @Validated
