緣由
目前參數(shù)校驗常用的方法是在實體類上添加注解,但對于不同的方法,所應(yīng)用的校驗規(guī)則也是不一樣的,例如有一個AccountVO實體:
假設(shè)存在這樣一個業(yè)務(wù):用戶注冊時需要填寫姓名和年齡,用戶登陸時只需要填寫姓名就可以了。那么把校驗規(guī)則加在實體類上顯然就不合適了。
所以一直想實現(xiàn)一種方法級別的參數(shù)校驗,對于同一個實體參數(shù),不同的方法可以應(yīng)用不同的校驗規(guī)則,由此便誕生了這個工具,而且在日常工作中使用了很久。
介紹
先來看看使用的方式:
其中方法上的@Check注解指明了參數(shù)AccountVO中的name、age屬性不能為空。除了非空校驗外,還支持大小判斷、是否等于等校驗:
默認的錯誤信息會返回字段,錯誤原因和調(diào)用的方法,例如:
也支持自定義錯誤返回信息:
只需要在校驗規(guī)則后加上:,后面寫上自定義信息,就會替換默認的錯誤信息。
PS:
核心原理是通過反射獲取參數(shù)實體中的字段的值,然后根據(jù)規(guī)則進行校驗,
所以目前只支持含有一個參數(shù)的方法,并且參數(shù)不能是基礎(chǔ)類型。
使用
spring-boot中如何使用AOP這里不再贅述,主要介紹AOP中的核心代碼。
Maven 依賴
除了spring-boot依賴之外,需要的第三方依賴,不是核心的依賴,可以根據(jù)個人習(xí)慣取舍:
自定義注解
核心代碼
通過切面攔截加上了@Check注解的接口方法,在方法執(zhí)行前,執(zhí)行參數(shù)校驗,如果存在錯誤信息,則直接返回:
核心的校驗方法在doCheck方法中,主要原理是獲取注解上指定的字段名稱和校驗規(guī)則,通過反射獲取參數(shù)實體中對應(yīng)的字段的值,再進行校驗:
可以看到主要的邏輯是:
解析字段 -> 獲取字段的值 -> 執(zhí)行校驗規(guī)則
內(nèi)部維護一個枚舉類,相關(guān)的校驗操作都在里面指定:
TODO
-
以Spring Boot Starter的方式封裝成獨立組件
-
支持正則表達式驗證