來自：掘金，作者：cipher

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

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

本文介紹基于Spring Boot和JDK8編寫一個AOP，結合自定義注解實現通用的接口參數校驗。

緣由

目前參數校驗常用的方法是在實體類上添加注解，但對于不同的方法，所應用的校驗規則也是不一樣的，例如有一個AccountVO實體：

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

假設存在這樣一個業務：用戶注冊時需要填寫姓名和年齡，用戶登陸時只需要填寫姓名就可以了。那么把校驗規則加在實體類上顯然就不合適了。

所以一直想實現一種方法級別的參數校驗，對于同一個實體參數，不同的方法可以應用不同的校驗規則，由此便誕生了這個工具，而且在日常工作中使用了很久。

介紹

先來看看使用的方式：

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

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

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

默認的錯誤信息會返回字段，錯誤原因和調用的方法，例如：

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

也支持自定義錯誤返回信息：

@Check({"title<=8:標題字數不超過8個字，含標點符號"})public void testValid(TestPO po) { // ...}

只需要在校驗規則后加上:，后面寫上自定義信息，就會替換默認的錯誤信息。

PS：核心原理是通過反射獲取參數實體中的字段的值，然后根據規則進行校驗，所以目前只支持含有一個參數的方法，并且參數不能是基礎類型。

使用

spring-boot中如何使用AOP這里不再贅述，主要介紹AOP中的核心代碼。

Maven 依賴

除了spring-boot依賴之外，需要的第三方依賴，不是核心的依賴，可以根據個人習慣取舍：

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;/** * 參數校驗 注解 */@Target({ElementType.TYPE, ElementType.METHOD})@Retention(RUNTIME)public @interface Check { // 字段校驗規則，格式：字段名+校驗規則+冒號+錯誤信息，例如：id<10:ID必須少于10 String[] value();}

核心代碼

通過切面攔截加上了@Check注解的接口方法，在方法執行前，執行參數校驗，如果存在錯誤信息，則直接返回：

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

核心的校驗方法在doCheck方法中，主要原理是獲取注解上指定的字段名稱和校驗規則，通過反射獲取參數實體中對應的字段的值，再進行校驗：

/** * 參數校驗 * * @param point ProceedingJoinPoint * @return 錯誤信息 */private String doCheck(ProceedingJoinPoint point) { // 獲取方法參數值 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); // 執行校驗規則 Boolean isValid = info.optEnum.fun.apply(value, info.operatorNum); msg = isValid ? msg : info.innerMsg; } } } return msg;}

可以看到主要的邏輯是：

解析字段 -> 獲取字段的值 -> 執行校驗規則

內部維護一個枚舉類，相關的校驗操作都在里面指定：

/** * 操作枚舉 */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; }}

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

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

TODO

• 以Spring Boot Starter的方式封裝成獨立組件
• 支持正則表達式驗證

以上實踐只做參考，可能會有一定的局限性，歡迎留言說出更好的見解！

---

對了，在這里說一下，我目前是在職Java開發，如果你現在正在學習Java，了解Java，渴望成為一名合格的Java開發工程師，在入門學習Java的過程當中缺乏基礎入門的視頻教程，可以關注并私信我：01。獲取。我這里有最新的Java基礎全套視頻教程。

創作挑戰賽新人創作獎勵來咯，堅持創作打卡瓜分現金大獎

總結

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

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。