aop+注解 实现对实体类的字段校验_SpringBoot实现通用的接口参数校验
来自:掘金,作者:cipher
链接:https://juejin.im/post/5af3c25b5188253064651c76
原文链接:http://www.ciphermagic.cn/spring-boot-aop-param-check.html
本文介绍基于Spring Boot和JDK8编写一个AOP,结合自定义注解实现通用的接口参数校验。
缘由
目前参数校验常用的方法是在实体类上添加注解,但对于不同的方法,所应用的校验规则也是不一样的,例如有一个AccountVO实体:
public class AccountVO { private String name; // 姓名 private Integer age; // 年龄}
假设存在这样一个业务:用户注册时需要填写姓名和年龄,用户登陆时只需要填写姓名就可以了。那么把校验规则加在实体类上显然就不合适了。
所以一直想实现一种方法级别的参数校验,对于同一个实体参数,不同的方法可以应用不同的校验规则,由此便诞生了这个工具,而且在日常工作中使用了很久。
介绍
先来看看使用的方式:
@Servicepublic 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 testValidid must >= 8 while calling testValidname must != aaa while calling testValid
也支持自定义错误返回信息:
@Check({"title<=8:标题字数不超过8个字,含标点符号"})public void testValid(TestPO po) { // ...}
只需要在校验规则后加上:,后面写上自定义信息,就会替换默认的错误信息。
PS:核心原理是通过反射获取参数实体中的字段的值,然后根据规则进行校验,所以目前只支持含有一个参数的方法,并且参数不能是基础类型。
使用
spring-boot中如何使用AOP这里不再赘述,主要介绍AOP中的核心代码。
Maven 依赖
除了spring-boot依赖之外,需要的第三方依赖,不是核心的依赖,可以根据个人习惯取舍:
org.apache.commons commons-lang3 3.3.2org.slf4j slf4j-api 1.7.25
自定义注解
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必须少于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(" fun; Operator(String value, BiFunction 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的方式封装成独立组件
- 支持正则表达式验证
以上实践只做参考,可能会有一定的局限性,欢迎留言说出更好的见解!
对了,在这里说一下,我目前是在职Java开发,如果你现在正在学习Java,了解Java,渴望成为一名合格的Java开发工程师,在入门学习Java的过程当中缺乏基础入门的视频教程,可以关注并私信我:01。获取。我这里有最新的Java基础全套视频教程。
aop+注解 实现对实体类的字段校验_SpringBoot实现通用的接口参数校验相关推荐
- aop+注解 实现对实体类的字段校验_SpringBoot2.0实战(6)整合hibernate-validator进行参数校验...
spring-boot-starter-web 项目中默认已经集成了 hibernate-validator 相关知识 @AssertTrue // 用于 boolean 字段,该字段只能为 true ...
- springboot项目中一个实体类引用其它实体类的字段并显示到页面上
1.需要在该实体类中添加引用实体类的字段,并添加getter和setter方法,并添加@Transient注解,或者使用@TableField(exist = false)注解.如下图: 2.在map ...
- mybatisplus 实体类的字段名与数据库的字段名不一致的解决办法
我们在查询数据库时经常会碰到数据库的字段名与实体类的字段名不一致的情况,例如报如下的错误 使用mybatisplus可以使用以下几种方式进行字段名的匹配: 把实体类的字段名改成和数据库的字段名一致,当 ...
- 设置实体类中字段为非数据库字段
设置实体类中字段为非数据库字段,加以下注解: @TableField(exist = false) 是不是数据库字段:true是:false不是 源码:不设置则默认是数据库字段
- 解决springdatajpa 在解析实体类的字段时候驼峰自动转为下划线问题
解决springdatajpa 在解析实体类的字段时候驼峰自动转为下划线问题 问题描述 springboot 在配置jpa时,利用idea自带工具逆向工程生成实体类,结果在调用findOne的时候,报 ...
- 使用myeclipse创建带注解的model实体类
使用myeclipse创建带注解的model实体类 1.先新建JPA项目: 如果没有就点击左下角的Show All Wizards. 点两次Next后,点击Finish即可,中间不用任何操作 (点第二 ...
- javabean反射改字段内容_java反射机制给实体类相同字段自动赋值实例
一.封装一个工具类 1.简易版 package net.aexit.construct.acceptance.websky.utils; import java.lang.reflect.Field; ...
- java实体类生成mysql表_springboot+mybatis通过实体类自动生成数据库表的方法
前言 本章介绍使用mybatis结合mysql数据库自动根据实体类生成相关的数据库表. 首先引入相关的pom包我这里使用的是springboot2.1.8.RELEASE的版本 org.mybatis ...
- 使用自定义注解实现接口参数校验
1.前言 在接口的开发中,我们有时会想让某个接口只可以被特定的人(来源)请求,那么就需要在服务端对请求参数做校验. 这种情况我们可以使用interceptor来统一进行参数校验,但是如果很多个接口,有 ...
最新文章
- java中基本字节输出流类是_java中基本输入输出流的解释
- 快速深入一门语言的几个问题
- Python 中的高级斗技,让函数返回结果的技巧
- mvc4中的 webapi 的使用方式
- 干货:RabbitMQ消息队列基本原理介绍
- c# controls.add 控件的使用 ,间接引用还是值引用
- 二、噪音大小对使用的影响
- java取消 验证_使用Spring Security Java配置时禁用基本身份验证
- 计算机组成原理学习-哈工大《计算机组成原理》第一章
- android apk 防止反编译技术第一篇-加壳技术
- 天津大学计算机学院2019夏令营,天津大学环境学院2019年全国优秀大学生夏令营顺利举行...
- Vue3.x的安装和初始化
- 【Pytorch】量化
- CentOS_7配置静态ip地址
- 风格化的图片———融合大师的笔触
- 一整套自助点餐软件,包含微信端,电视机,后台管理程序,个人开发,全套源码
- 2021-05-22 黑板异或游戏
- Winsock编程接口实验:实现ipconfig
- vc6.0中用GDIPlus实现加载动态gif图片(非MFC实现)
- 1 简历该怎么写?注意事项--绝密,程序员大厂面试求职大揭秘!