快捷導(dǎo)航

Spring Boot實(shí)現(xiàn)通用的接口參數(shù)校驗(yàn)

更新時(shí)間：2018年05月10日 16:17:47 作者：cipher

本文介紹基于 Spring Boot 和 JDK8 編寫(xiě)一個(gè) AOP ，結(jié)合自定義注解實(shí)現(xiàn)通用的接口參數(shù)校驗(yàn)。具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下

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

緣由

目前參數(shù)校驗(yàn)常用的方法是在實(shí)體類(lèi)上添加注解，但對(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í)體類(lèi)上顯然就不合適了。

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

介紹

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

@Service
public 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 testValid
id must >= 8 while calling testValid
name 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ǔ)類(lèi)型。

使用

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

Maven 依賴

除了 spring-boot 依賴之外，需要的第三方依賴，不是核心的依賴，可以根據(jù)個(gè)人習(xí)慣取舍：

<!-- 用于字符串校驗(yàn) -->
<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;

/**
 * 參數(shù)校驗(yàn) 注解
 * Created by cipher on 2017/9/20.
 */
@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)) {
    // 這里可以返回自己封裝的返回類(lèi)
    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è)枚舉類(lèi)，相關(guān)的校驗(yàn)操作都在里面指定：

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

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

TODO