Spring Boot實現通用的接口參數校驗

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

本文介紹基於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上點個贊，有任何問題或者建議請在下方留言，期待你的回覆。