SpringBoot实现通用的接口参数校验

点击上方“方志朋”，选择“设为星标”

回复”666“获取新整理的面试资料

作者：cipher

juejin.im/post/5af3c25b5188253064651c76

本文介绍基于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中的核心代码。Java：由浅入深揭开 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;
/*** 参数校验 注解*/
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RUNTIME)
public @interface Check {// 字段校验规则，格式：字段名+校验规则+冒号+错误信息，例如：id<10:ID必须少于10String[] 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;}
}

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

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

TODO

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

以上实践只做参考，可能会有一定的局限性，欢迎留言说出更好的见解！

热门内容：

大批 IDEA 激活码到期之后的乱象...

全面了解 Nginx 主要应用场景

为什么微服务一定要有网关？
那些在一个公司死磕了5-10年的人，最后都怎么样了？
只有程序员才能读懂的西游记
2020，搞个 Mac 玩玩！
分布式与集群的区别究竟是什么？
碰到Maven依赖冲突，想砸电脑？这个IDEA插件必须了解一下...
2020年Java框架排行榜，谁居榜首？
SpringBoot+RabbitMQ ，保证消息100%投递成功并被消费（附源码）

最近面试BAT，整理一份面试资料《Java面试BAT通关手册》，覆盖了Java核心技术、JVM、Java并发、SSM、微服务、数据库、数据结构等等。

获取方式：点“在看”，关注公众号并回复 666 领取，更多内容陆续奉上。

明天见(｡･ω･｡)ﾉ♡