來(lái)自：掘金，作者：cipher

鏈接：https://juejin.im/post/5af3c25b5188253064651c76

原文鏈接：http://www.ciphermagic.cn/spring-boot-aop-param-check.html

本文介紹基于Spring Boot和JDK8編寫(xiě)一個(gè)AOP，結(jié)合自定義注解實(shí)現(xiàn)通用的接口參數(shù)校驗(yàn)。

緣由

目前參數(shù)校驗(yàn)常用的方法是在實(shí)體類上添加注解，但對(duì)于不同的方法，所應(yīng)用的校驗(yàn)規(guī)則也是不一樣的，例如有一個(gè)AccountVO實(shí)體：

public class AccountVO { private String name; // 姓名 private Integer age; // 年齡}

假設(shè)存在這樣一個(gè)業(yè)務(wù)：用戶注冊(cè)時(shí)需要填寫(xiě)姓名和年齡，用戶登陸時(shí)只需要填寫(xiě)姓名就可以了。那么把校驗(yàn)規(guī)則加在實(shí)體類上顯然就不合適了。

所以一直想實(shí)現(xiàn)一種方法級(jí)別的參數(shù)校驗(yàn)，對(duì)于同一個(gè)實(shí)體參數(shù)，不同的方法可以應(yīng)用不同的校驗(yàn)規(guī)則，由此便誕生了這個(gè)工具，而且在日常工作中使用了很久。

介紹

先來(lái)看看使用的方式：

@Servicepublic class TestImpl implements ITestService { @Override @Check({"name", "age"}) public void testValid(AccountVO vo) { // ... }}

其中方法上的@Check注解指明了參數(shù)AccountVO中的name、age屬性不能為空。除了非空校驗(yàn)外，還支持大小判斷、是否等于等校驗(yàn)：

@Check({"id>=8", "name!=aaa", "title<10"})

默認(rèn)的錯(cuò)誤信息會(huì)返回字段，錯(cuò)誤原因和調(diào)用的方法，例如：

updateUserId must not null while calling testValidid must >= 8 while calling testValidname must != aaa while calling testValid

也支持自定義錯(cuò)誤返回信息：

@Check({"title<=8:標(biāo)題字?jǐn)?shù)不超過(guò)8個(gè)字，含標(biāo)點(diǎn)符號(hào)"})public void testValid(TestPO po) { // ...}

只需要在校驗(yàn)規(guī)則后加上:，后面寫(xiě)上自定義信息，就會(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í)慣取舍：

org.apache.commons commons-lang3 3.3.2org.slf4j slf4j-api 1.7.25

自定義注解

import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.Target;import static java.lang.annotation.RetentionPolicy.RUNTIME;/** * 參數(shù)校驗(yàn) 注解 */@Target({ElementType.TYPE, ElementType.METHOD})@Retention(RUNTIME)public @interface Check { // 字段校驗(yàn)規(guī)則，格式：字段名+校驗(yàn)規(guī)則+冒號(hào)+錯(cuò)誤信息，例如：id<10:ID必須少于10 String[] value();}

核心代碼

通過(guò)切面攔截加上了@Check注解的接口方法，在方法執(zhí)行前，執(zhí)行參數(shù)校驗(yàn)，如果存在錯(cuò)誤信息，則直接返回：

@Around(value = "@com.cipher.checker.Check") // 這里要換成自定義注解的路徑public Object check(ProceedingJoinPoint point) throws Throwable { Object obj; // 參數(shù)校驗(yàn) String msg = doCheck(point); if (!StringUtils.isEmpty(msg)) { // 這里可以返回自己封裝的返回類 throw new IllegalArgumentException(msg); } obj = point.proceed(); return obj;}

核心的校驗(yàn)方法在doCheck方法中，主要原理是獲取注解上指定的字段名稱和校驗(yàn)規(guī)則，通過(guò)反射獲取參數(shù)實(shí)體中對(duì)應(yīng)的字段的值，再進(jìn)行校驗(yàn)：

/** * 參數(shù)校驗(yàn) * * @param point ProceedingJoinPoint * @return 錯(cuò)誤信息 */private String doCheck(ProceedingJoinPoint point) { // 獲取方法參數(shù)值 Object[] arguments = point.getArgs(); // 獲取方法 Method method = getMethod(point); String methodInfo = StringUtils.isEmpty(method.getName()) ? "" : " while calling " + method.getName(); String msg = ""; if (isCheck(method, arguments)) { Check annotation = method.getAnnotation(Check.class); String[] fields = annotation.value(); Object vo = arguments[0]; if (vo == null) { msg = "param can not be null"; } else { for (String field : fields) { // 解析字段 FieldInfo info = resolveField(field, methodInfo); // 獲取字段的值 Object value = ReflectionUtil.invokeGetter(vo, info.field); // 執(zhí)行校驗(yàn)規(guī)則 Boolean isValid = info.optEnum.fun.apply(value, info.operatorNum); msg = isValid ? msg : info.innerMsg; } } } return msg;}

可以看到主要的邏輯是：

解析字段 -> 獲取字段的值 -> 執(zhí)行校驗(yàn)規(guī)則

內(nèi)部維護(hù)一個(gè)枚舉類，相關(guān)的校驗(yàn)操作都在里面指定：

/** * 操作枚舉 */enum Operator { /** * 大于 */ GREATER_THAN(">", CheckParamAspect::isGreaterThan), /** * 大于等于 */ GREATER_THAN_EQUAL(">=", CheckParamAspect::isGreaterThanEqual), /** * 小于 */ LESS_THAN(" fun; Operator(String value, BiFunction fun) { this.value = value; this.fun = fun; }}

由于篇幅原因，這里就不一一展開(kāi)所有的代碼，有興趣的朋友可以到以下地址獲取所有的源碼：

https://github.com/ciphermagic/java-learn/tree/master/sandbox/src/main/java/com/cipher/checker

TODO

• 以Spring Boot Starter的方式封裝成獨(dú)立組件
• 支持正則表達(dá)式驗(yàn)證

以上實(shí)踐只做參考，可能會(huì)有一定的局限性，歡迎留言說(shuō)出更好的見(jiàn)解！

---

對(duì)了，在這里說(shuō)一下，我目前是在職Java開(kāi)發(fā)，如果你現(xiàn)在正在學(xué)習(xí)Java，了解Java，渴望成為一名合格的Java開(kāi)發(fā)工程師，在入門學(xué)習(xí)Java的過(guò)程當(dāng)中缺乏基礎(chǔ)入門的視頻教程，可以關(guān)注并私信我：01。獲取。我這里有最新的Java基礎(chǔ)全套視頻教程。

創(chuàng)作挑戰(zhàn)賽新人創(chuàng)作獎(jiǎng)勵(lì)來(lái)咯，堅(jiān)持創(chuàng)作打卡瓜分現(xiàn)金大獎(jiǎng)

總結(jié)

以上是生活随笔為你收集整理的aop+注解 实现对实体类的字段校验_SpringBoot实现通用的接口参数校验的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。