Spring Boot實現通用的介面引數校驗

cipher發表於2018-05-10
Spring Boot

原文連結：www.ciphermagic.cn/spring-boot…

更新了開箱即用的版本：github.com/ciphermagic…

本文介紹基於Spring Boot和JDK8編寫一個AOP，結合自定義註解實現通用的介面引數校驗。

緣由

目前引數校驗常用的方法是在實體類上新增註解，但對於不同的方法，所應用的校驗規則也是不一樣的，例如有一個AccountVO實體：

public class AccountVO {
    private String name; // 姓名
    private Integer age; // 年齡
}
複製程式碼

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

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

介紹

先來看看使用的方式：

@Service
public 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 testValid

id must >= 8 while calling testValid

name must != aaa while calling testValid
複製程式碼

也支援自定義錯誤返回資訊：

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

只需要在校驗規則後加上:，後面寫上自定義資訊，就會替換預設的錯誤資訊。

PS： 核心原理是通過反射獲取引數實體中的欄位的值，然後根據規則進行校驗， 所以目前只支援含有一個引數的方法，並且引數不能是基礎型別。

使用

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

Maven 依賴

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

<!-- 用於字串校驗 -->
<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-lang3</artifactId>
    <version>3.3.2</version>
</dependency>

<!-- 用於日誌列印 -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.25</version>
</dependency>
複製程式碼

自定義註解

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * 引數校驗 註解
 * Created by cipher on 2017/9/20.
 */
@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("<", CheckParamAspect::isLessThan),
    /**
     * 小於等於
     */
    LESS_THAN_EQUAL("<=", CheckParamAspect::isLessThanEqual),
    /**
     * 不等於
     */
    NOT_EQUAL("!=", CheckParamAspect::isNotEqual),
    /**
     * 不為空
     */
    NOT_NULL("not null", CheckParamAspect::isNotNull);

    private String value;
    private BiFunction<Object, String, Boolean> fun;

    Operator(String value, BiFunction<Object, String, Boolean> fun) {
        this.value = value;
        this.fun = fun;
    }
}
複製程式碼

由於篇幅原因，這裡就不一一展開所有的程式碼，有興趣的朋友可以到以下地址獲取所有的原始碼： ciphermagic/java-learn/sandbox/checker

TODO

  • 以Spring Boot Starter的方式封裝成獨立元件
  • 支援正規表示式驗證

最後

感謝大家的閱讀，喜歡的朋友可以在github上點個贊，有任何問題或者建議請在下方留言，期待你的回覆。

相關文章