SpringBoot實現通用的接口參數校驗,註解實戰
回覆“ 1024 ”或 “ 面試題 ” 獲取 4T架構師 資料
本文介紹基於 SpringBoot
和 JDK8
編寫一個結合自定義註解實現通用的接口參數校驗。
緣由
目前參數校驗常用的方法是在實體類上添加註解,但對於不同的方法,所應用的校驗規則也是不一樣的,例如有一個 AccountVO
實體:
假設存在這樣一個業務:用戶註冊時需要填寫姓名和年齡,用戶登陸時只需要填寫姓名就可以了。那麼把校驗規則加在實體類上顯然就不合適了。
所以一直想實現一種方法級別的參數校驗,對於同一個實體參數,不同的方法可以應用不同的校驗規則,由此便誕生了這個工具,而且在日常工作中使用了很久。
介紹
先來看看使用的方式:
其中方法上的 @Check
註解指明瞭參數 AccountVO
中的 name
、 age
屬性不能爲空。除了非空校驗外,還支持大小判斷、是否等於等校驗:
默認的錯誤信息會返回字段,錯誤原因和調用的方法,例如:
也支持自定義錯誤返回信息:
只需要在校驗規則後加上 :
,後面寫上自定義信息,就會替換默認的錯誤信息。
PS:核心原理是通過反射獲取參數實體中的字段的值,然後根據規則進行校驗, 所以目前只支持含有一個參數的方法,並且參數不能是基礎類型。
使用
spring-boot
中如何使用 AOP
這裏不再贅述,主要介紹 AOP
中的核心代碼。
Maven 依賴
除了 spring-boot
依賴之外,需要的第三方依賴,不是核心的依賴,可以根據個人習慣取捨:
自定義註解
核心代碼
通過切面攔截加上了 @Check
註解的接口方法,在方法執行前,執行參數校驗,如果存在錯誤信息,則直接返回:
核心的校驗方法在 doCheck
方法中,主要原理是獲取註解上指定的字段名稱和校驗規則,通過反射獲取參數實體中對應的字段的值,再進行校驗:
可以看到主要的邏輯是:
解析字段 -> 獲取字段的值 -> 執行校驗規則
內部維護一個枚舉類,相關的校驗操作都在裏面指定:
由於篇幅原因,這裏就不一一展開所有的代碼,有興趣的朋友可以到以下地址獲取所有的源碼:
https://github.com/ciphermagic/java-learn/tree/master/sandbox/src/main/java/com/cipher/checker
TODO
以Spring Boot Starter的方式封裝成獨立組件
支持正則表達式驗證
作者:cipher
juejin.im/post/5af3c25b5188253064651c76
近期技術熱文
1、 SpringBoot整合Activiti工作流(附源碼)
2、 搞定 SpringBoot 整合 Spring Kafka深入探祕
4、 動圖+源碼+總結:演示 JDK8 中的數據結構(珍藏版)
5、 優雅停止SpringBoot服務,拒絕kill -9暴力停止!