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