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

Harries Blog™
2018-05-10
2418 阅读

原文链接: 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">&lt;</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">&gt;</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">&lt;</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">&gt;</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

原文地址:http://ju.outofmemory.cn/entry/354203

Spring Boot实现通用的接口参数校验的更多相关文章

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

    本文介绍基于Spring Boot和JDK8编写一个AOP,结合自定义注解实现通用的接口参数校验. 缘由 目前参数校验常用的方法是在实体类上添加注解,但对于不同的方法,所应用的校验规则也是不一样的,例 ...

  2. Spring Boot 之:接口参数校验

    Spring Boot 之:接口参数校验,学习资料 网址 SpringBoot(八) JSR-303 数据验证(写的比较好) https://qq343509740.gitee.io/2018/07/ ...

  3. Spring Boot Hello World (restful接口)例子

    Spring Boot 集成教程 Spring Boot 介绍 Spring Boot 开发环境搭建(Eclipse) Spring Boot Hello World (restful接口)例子 sp ...

  4. Spring Boot程序接收命令行参数

    Spring Boot程序接收命令行参数 输入一行,回车,触发一次.如果想要调用service层,也是可以,能调用service层,就可以做很多事,触发一次就好比调用了一次http接口一样 packa ...

  5. spring boot:用swagger3生成接口文档,支持全局通用参数(swagger 3.0.0 / spring boot 2.3.2)

    一,什么是swagger? 1,  Swagger 是一个规范和完整的文档框架, 用于生成.描述.调用和可视化 RESTful 风格的 Web 服务文档 官方网站: https://swagger.i ...

  6. spring boot:使用validator做接口的参数、表单、类中多字段的参数验证(spring boot 2.3.1)

    一,为什么要做参数验证? 永远不要相信我们在后端接收到的数据, 1,防止别人通过接口乱刷服务:有些不怀好意的人或机构会乱刷我们的服务,例如:短信接口, 相信大家可能很多人在工作中遇到过这种情况 2,防 ...

  7. Spring Boot MyBatis 通用Mapper插件集成 good

    看本文之前,请确保你已经在SpringBoot中集成MyBatis,并能正常使用.如果没有,那么请先移步 http://blog.csdn.net/catoop/article/details/505 ...

  8. spring boot中通用应用程序属性

    可以在application.properties文件内部application.yml,文件内部或命令行开关中指定各种属性.本附录提供了常见的Spring Boot属性列表以及对使用它们的基础类的引 ...

  9. spring boot(3)-Rest风格接口

    Rest接口 虽然现在还有很多人在用jsp,但是其实这种动态页面早已过时,现在前端流行的是静态HTML+ rest接口(json格式).当然,如果是单台服务器,用动态还是静态页面可能没什么很大区别,但 ...

随机推荐

  1. golang的数据类型之字符串类型

    基本案例: [root@node3 shangxuetang]# cat string.go package main import "fmt" func main() { //s ...

  2. Rikka with Nickname (简单题)

    Rikka with Nickname  链接:https://www.nowcoder.com/acm/contest/148/J来源:牛客网 时间限制:C/C++ 2秒,其他语言4秒空间限制:C/ ...

  3. Linux 环境下安装rlwrap工具

    rlwrap项目是一个“readline包装器”,它使用GNU readline库来编辑任何其他命令的键 盘输入.通过rlwrap可以进行命令的上下切换,类似历史命令. 1.下载rlwrap rpm ...

  4. db2中将表中的某一字段设置为自增长

    DB2可以使用generated always as identity 将某一个字段指定为自增长的字段: 这表示id自动是一个自增长的字段,它从1开始增加每次增加1.也可以通过generated 将字 ...

  5. C# 编程—字符串(方法应用)、数学Math函数、DateTime、异常捕获、其他

    其他:        #--任意位数字,有几位显示几位        0--至少以为数字,不足则补0        例如:#.00--必须保留两位小数 字符串(string): Length  长度 ...

  6. 2018-2-22-在-windows-安装-Jekyll

    title author date CreateTime categories 在 windows 安装 Jekyll lindexi 2018-02-22 17:47:39 +0800 2018-2 ...

  7. Linux操作练习

    打印显示当前时间,格式是:20181209211008 [root@Centos7 ~]#date "+%Y%m%d%H%M%S" 实现晚上20:30自动关机 [root@Cent ...

  8. HDU-4126 Genghis Khan the Conqueror 树形DP+MST (好题)

    题意:给出一个n个点m条边的无向边,q次询问每次询问把一条边权值增大后问新的MST是多少,输出Sum(MST)/q. 解法:一开始想的是破圈法,后来想了想应该不行,破圈法应该只能用于加边的情况而不是修 ...

  9. Codeforces 1197E Culture Code DP

    题意:你有n个俄罗斯套娃,已知每个套娃的容积和体积,问有多少个子集满足以下条件: 1:这个子集是一个极大子集,即不能再添加其它的套娃到这个子集里. 2:子集的套娃之间的间隙和最小. 思路1:线段树优化 ...

  10. 绘图matplotlib

    前言 matplotlib是python的一个绘图库,如果你没有绘制过图,可以先试试js的绘图库http://www.runoob.com/highcharts/highcharts-line-lab ...