Spring Boot实现通用的接口参数校验
Spring Boot实现通用的接口参数校验
原文链接: www.c
ip
hermagic.cn/
spring
-boot…
本文介绍基于
Spring Boot
和
JDK8
编写一个
AOP
,结合自定义注解实现通用的接口
参数
校验。
缘由
目前参数校验常用的方法是在实体类上添加注解,但对于不同的方法,所应用的校验规则也是不一样的,例如有一个
AccountVO
实体:
public class AccountVO {
private String name; // 姓名
private Integer age; // 年龄
}
假设存在这样一个业务:用户注册时需要填写姓名和年龄,用户登陆时只需要填写姓名就可以了。那么把校验规则加在实体类上显然就不合适了。
所以一直想实现一种方法级别的参数校验,对于同一个实体参数,不同的方法可以应用不同的校验规则,由此便诞生了这个工具,而且在日常工作中使用了很久。
介绍
先来看看使用的方式:
@Service
public class TestImpl implements ITestService {
</span><span class="lit"><span class="hljs-variable">@Override</span></span><span class="pln">
</span><span class="lit"><span class="hljs-variable">@Check</span></span><span class="pun">({</span><span class="str"><span class="hljs-string">"name"</span></span><span class="pun">,</span><span class="pln"> </span><span class="str"><span class="hljs-string">"age"</span></span><span class="pun">})</span><span class="pln">
</span><span class="kwd">public</span><span class="pln"> </span><span class="kwd">void</span><span class="pln"> testValid</span><span class="pun">(</span><span class="typ">AccountVO</span><span class="pln"> vo</span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
</span><span class="com"><span class="hljs-comment">// ...</span></span><span class="pln">
</span><span class="pun">}</span><span class="pln">
}
其中方法上的
@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);
</span><span class="kwd">private</span><span class="pln"> </span><span class="typ"><span class="hljs-built_in">String</span></span><span class="pln"> value</span><span class="pun">;</span><span class="pln">
</span><span class="kwd">private</span><span class="pln"> </span><span class="typ">BiFunction</span><span class="pun"><</span><span class="typ"><span class="hljs-built_in">Object</span></span><span class="pun">,</span><span class="pln"> </span><span class="typ"><span class="hljs-built_in">String</span></span><span class="pun">,</span><span class="pln"> </span><span class="typ"><span class="hljs-built_in">Boolean</span></span><span class="pun">></span><span class="pln"> fun</span><span class="pun">;</span><span class="pln">
</span><span class="typ">Operator</span><span class="pun">(</span><span class="typ"><span class="hljs-built_in">String</span></span><span class="pln"> value</span><span class="pun">,</span><span class="pln"> </span><span class="typ">BiFunction</span><span class="pun"><</span><span class="typ"><span class="hljs-built_in">Object</span></span><span class="pun">,</span><span class="pln"> </span><span class="typ"><span class="hljs-built_in">String</span></span><span class="pun">,</span><span class="pln"> </span><span class="typ"><span class="hljs-built_in">Boolean</span></span><span class="pun">></span><span class="pln"> fun</span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
</span><span class="kwd"><span class="hljs-keyword">this</span></span><span class="pun">.</span><span class="pln">value </span><span class="pun">=</span><span class="pln"> value</span><span class="pun">;</span><span class="pln">
</span><span class="kwd"><span class="hljs-keyword">this</span></span><span class="pun">.</span><span class="pln">fun </span><span class="pun">=</span><span class="pln"> fun</span><span class="pun">;</span><span class="pln">
</span><span class="pun">}</span><span class="pln">
}
由于篇幅原因,这里就不一一展开所有的代码,有兴趣的朋友可以到以下地址获取所有的
源码
: ciphermagic/java-learn/san
db
ox/checker
原文
https
://juejin.im/post/5af3c25b5188253064651c76
Spring Boot实现通用的接口参数校验的更多相关文章
- SpringBoot实现通用的接口参数校验
本文介绍基于Spring Boot和JDK8编写一个AOP,结合自定义注解实现通用的接口参数校验. 缘由 目前参数校验常用的方法是在实体类上添加注解,但对于不同的方法,所应用的校验规则也是不一样的,例 ...
- Spring Boot 之:接口参数校验
Spring Boot 之:接口参数校验,学习资料 网址 SpringBoot(八) JSR-303 数据验证(写的比较好) https://qq343509740.gitee.io/2018/07/ ...
- Spring Boot Hello World (restful接口)例子
Spring Boot 集成教程 Spring Boot 介绍 Spring Boot 开发环境搭建(Eclipse) Spring Boot Hello World (restful接口)例子 sp ...
- Spring Boot程序接收命令行参数
Spring Boot程序接收命令行参数 输入一行,回车,触发一次.如果想要调用service层,也是可以,能调用service层,就可以做很多事,触发一次就好比调用了一次http接口一样 packa ...
- spring boot:用swagger3生成接口文档,支持全局通用参数(swagger 3.0.0 / spring boot 2.3.2)
一,什么是swagger? 1, Swagger 是一个规范和完整的文档框架, 用于生成.描述.调用和可视化 RESTful 风格的 Web 服务文档 官方网站: https://swagger.i ...
- spring boot:使用validator做接口的参数、表单、类中多字段的参数验证(spring boot 2.3.1)
一,为什么要做参数验证? 永远不要相信我们在后端接收到的数据, 1,防止别人通过接口乱刷服务:有些不怀好意的人或机构会乱刷我们的服务,例如:短信接口, 相信大家可能很多人在工作中遇到过这种情况 2,防 ...
- Spring Boot MyBatis 通用Mapper插件集成 good
看本文之前,请确保你已经在SpringBoot中集成MyBatis,并能正常使用.如果没有,那么请先移步 http://blog.csdn.net/catoop/article/details/505 ...
- spring boot中通用应用程序属性
可以在application.properties文件内部application.yml,文件内部或命令行开关中指定各种属性.本附录提供了常见的Spring Boot属性列表以及对使用它们的基础类的引 ...
- spring boot(3)-Rest风格接口
Rest接口 虽然现在还有很多人在用jsp,但是其实这种动态页面早已过时,现在前端流行的是静态HTML+ rest接口(json格式).当然,如果是单台服务器,用动态还是静态页面可能没什么很大区别,但 ...
随机推荐
- boby标签中相关标签
有关字体相关的标签 h1~h6 字体大小 标题使用<h1>至<h6>标签进行定义,<h1>定义最大的标题,<h6>定义最小的标题.具有 align属 ...
- NOIP后一波总结
我的山寨较为可靠分数为305(洛谷是真的水~显然不能用啊,果断换了一组合适的数据) 据大神们估计,得奖的分数在280, 我肯定是没有啥希望了.(我旁边的lxy同学从初二开始,每次以超分数线至少60分的 ...
- etcd扩展使用
etcd我已经提到很多次了,前面的可以自己查看.v3版本改用grpc接口,很简单,非常简单,易上手易学习. etcd有集群部署方式,那么就涉及部署的地址,可以动态添加部署节点,这样再应用中不可能都去关 ...
- redux和react-redux
redux和react-redux的关系: redux是react的状态管理工具,却不仅仅只是为了react而生的,所以在使用中会存在痛点.而react-redux是专门为了react定制,目的是为了 ...
- capserjs-prototype(上)
Casper prototyp back() 具体样式: back() Moves back a step in browser's history: 在浏览器历史中回退一步: casper.star ...
- myBatis配置提示xml和内部DTD
–配置环境:macOS high Sierra 10.13.6/window10–生产环境:eclipse2018.a,myeclipse2018 首先了解xml文件的参数——<!DOCT ...
- Linux 下安装sql server 时 2G内存限制的最新(2019-08-15) 解决方案
关于 sqlserver 在linux下安装时有最小内存限制的问题,网上有很多类似的说明,那些操作都是正确的,如果不成功可能 “姿势”不对. 需要注意的是:不能使用最新版本!!! 不能在线下载!!! ...
- 转载:java面试题(一)
1.面向对象的特征有哪些方面? 答:面向对象的特征主要有以下几个方面: - 抽象:抽象是将一类对象的共同特征总结出来构造类的过程,包括数据抽象和行为抽象两方面.抽象只关注对象有哪些属性和行为,并不关注 ...
- ThreadLocal简单使用示例
ThreadLocal为每个线程提供单独的数据副本,线程间的数据为自身线程所独有(不存在共享变量问题),直接看代码 public class ThreadLocalTest { private sta ...
- Elasticsearch index
POST/{index}/{type} Elasticsearch自动生成ID,自动生成的 ID 是 URL-safe. 基于 Base64 编码且长度为20个字符的 GUID 字符串. 这些 GUI ...