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