Spring Boot实现通用的接口参数校验

此处输入图片的描述

本文介绍基于Spring Boot和JDK8编写一个AOP，结合自定义注解实现通用的接口参数校验。

缘由

目前参数校验常用的方法是在实体类上添加注解，但对于不同的方法，所应用的校验规则也是不一样的，例如有一个AccountVO实体：

1public class AccountVO {
2    private String name; // 姓名
3    private Integer age; // 年龄
4}

假设存在这样一个业务：用户注册时需要填写姓名和年龄，用户登陆时只需要填写姓名就可以了。那么把校验规则加在实体类上显然就不合适了。

所以一直想实现一种方法级别的参数校验，对于同一个实体参数，不同的方法可以应用不同的校验规则，由此便诞生了这个工具，而且在日常工作中使用了很久。

介绍

先来看看使用的方式：

 1@Service
 2public class TestImpl implements ITestService {
 3
 4    @Override
 5    @Check({"name", "age"})
 6    public void testValid(AccountVO vo) {
 7        // ...
 8    }
 9
10}

其中方法上的@Check注解指明了参数AccountVO中的name、age属性不能为空。除了非空校验外，还支持大小判断、是否等于等校验：

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

默认的错误信息会返回字段，错误原因和调用的方法，例如：

1updateUserId must not null while calling testValid
2
3id must >= 8 while calling testValid
4
5name must != aaa while calling testValid

也支持自定义错误返回信息：

@Check({"title<=8:标题字数不超过8个字，含标点符号"})
public void testValid(TestPO po) {
    // ...
}

只需要在校验规则后加上:，后面写上自定义信息，就会替换默认的错误信息。

PS：核心原理是通过反射获取参数实体中的字段的值，然后根据规则进行校验，所以目前只支持含有一个参数的方法，并且参数不能是基础类型。

使用

spring-boot中如何使用AOP这里不再赘述，主要介绍AOP中的核心代码。

Maven 依赖

除了spring-boot依赖之外，需要的第三方依赖，不是核心的依赖，可以根据个人习惯取舍：

 1<!-- 用于字符串校验 -->
 2<dependency>
 3    <groupId>org.apache.commons</groupId>
 4    <artifactId>commons-lang3</artifactId>
 5    <version>3.3.2</version>
 6</dependency>
 7
 8<!-- 用于日志打印 -->
 9<dependency>
10    <groupId>org.slf4j</groupId>
11    <artifactId>slf4j-api</artifactId>
12    <version>1.7.25</version>
13</dependency>

自定义注解

 1import java.lang.annotation.ElementType;
 2import java.lang.annotation.Retention;
 3import java.lang.annotation.Target;
 4
 5import static java.lang.annotation.RetentionPolicy.RUNTIME;
 6
 7/**
 8 * 参数校验 注解
 9 * Created by cipher on 2017/9/20.
10 */
11@Target({ElementType.TYPE, ElementType.METHOD})
12@Retention(RUNTIME)
13public @interface Check {
14
15    // 字段校验规则，格式：字段名+校验规则+冒号+错误信息，例如：id<10:ID必须少于10
16    String[] value();
17
18}

核心代码

通过切面拦截加上了@Check注解的接口方法，在方法执行前，执行参数校验，如果存在错误信息，则直接返回：

 1@Around(value = "@com.cipher.checker.Check") // 这里要换成自定义注解的路径
 2public Object check(ProceedingJoinPoint point) throws Throwable {
 3    Object obj;
 4    // 参数校验
 5    String msg = doCheck(point);
 6    if (!StringUtils.isEmpty(msg)) {
 7        // 这里可以返回自己封装的返回类
 8        throw new IllegalArgumentException(msg);
 9    }
10    obj = point.proceed();
11    return obj;
12}

核心的校验方法在doCheck方法中，主要原理是获取注解上指定的字段名称和校验规则，通过反射获取参数实体中对应的字段的值，再进行校验：

 1/**
 2 * 参数校验
 3 *
 4 * @param point ProceedingJoinPoint
 5 * @return 错误信息
 6 */
 7private String doCheck(ProceedingJoinPoint point) {
 8    // 获取方法参数值
 9    Object[] arguments = point.getArgs();
10    // 获取方法
11    Method method = getMethod(point);
12    String methodInfo = StringUtils.isEmpty(method.getName()) ? "" : " while calling " + method.getName();
13    String msg = "";
14    if (isCheck(method, arguments)) {
15        Check annotation = method.getAnnotation(Check.class);
16        String[] fields = annotation.value();
17        Object vo = arguments[0];
18        if (vo == null) {
19            msg = "param can not be null";
20        } else {
21            for (String field : fields) {
22                // 解析字段
23                FieldInfo info = resolveField(field, methodInfo);
24                // 获取字段的值
25                Object value = ReflectionUtil.invokeGetter(vo, info.field);
26                // 执行校验规则
27                Boolean isValid = info.optEnum.fun.apply(value, info.operatorNum);
28                msg = isValid ? msg : info.innerMsg;
29            }
30        }
31    }
32    return msg;
33}

可以看到主要的逻辑是：

解析字段 -> 获取字段的值 -> 执行校验规则

内部维护一个枚举类，相关的校验操作都在里面指定：

 1/**
 2 * 操作枚举
 3 */
 4enum Operator {
 5    /**
 6     * 大于
 7     */
 8    GREATER_THAN(">", CheckParamAspect::isGreaterThan),
 9    /**
10     * 大于等于
11     */
12    GREATER_THAN_EQUAL(">=", CheckParamAspect::isGreaterThanEqual),
13    /**
14     * 小于
15     */
16    LESS_THAN("<", CheckParamAspect::isLessThan),
17    /**
18     * 小于等于
19     */
20    LESS_THAN_EQUAL("<=", CheckParamAspect::isLessThanEqual),
21    /**
22     * 不等于
23     */
24    NOT_EQUAL("!=", CheckParamAspect::isNotEqual),
25    /**
26     * 不为空
27     */
28    NOT_NULL("not null", CheckParamAspect::isNotNull);
29
30    private String value;
31    private BiFunction<Object, String, Boolean> fun;
32
33    Operator(String value, BiFunction<Object, String, Boolean> fun) {
34        this.value = value;
35        this.fun = fun;
36    }
37}

由于篇幅原因，这里就不一一展开所有的代码，有兴趣的朋友可以到以下地址获取所有的源码： ciphermagic/java-learn/sandbox/checker

TODO

以Spring Boot Starter的方式封装成独立组件
支持正则表达式验证

最后

感谢大家的阅读，喜欢的朋友可以在github上点个赞，有任何问题或者建议请在下方留言，期待你的回复。

缘由#

介绍#

使用#

Maven 依赖#

自定义注解#

核心代码#

TODO#

最后#

缘由

介绍

使用

Maven 依赖

自定义注解

核心代码

TODO

最后