aop+注解 实现对实体类的字段校验_SpringBoot实现通用的接口参数校验

来自:掘金,作者:cipher

链接:https://juejin.im/post/5af3c25b5188253064651c76

原文链接:http://www.ciphermagic.cn/spring-boot-aop-param-check.html

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

ec27ce4dc3e2b703fcf5d50c13788299.png

缘由

目前参数校验常用的方法是在实体类上添加注解,但对于不同的方法,所应用的校验规则也是不一样的,例如有一个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基础全套视频教程。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/340122.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

java基础分享_一、java基础教程

1、java是一门比较纯粹的面向对象编程语言&#xff0c;所以java的所有代码都必须写在类的内部。1.1 java的可执行文件后缀名是".java"&#xff0c;例如HelloWorld.java&#xff0c;并且每个可执行文件内部&#xff0c;必须有且仅有一个public公共类/公共接口/公共抽象…

Spring Boot自定义横幅生成

每当我们启动Spring Boot应用程序时&#xff0c;都会显示如下所示的文本消息。 这称为横幅。 现在&#xff0c;如果我们可以创建一个特定于我们的Spring Boot应用程序的自定义横幅并使用它代替默认的Spring Boot横幅&#xff0c;那将不是一件很棒的事。 有很多方法可以生成和使…

java等待_Java学习:等待唤醒机制

等待唤醒机制线程的状态NEW 至今尚未启动的线程处于这种状态RUNNABLE 正在Java虚拟机中执行的线程处于这种状态BLOCKED 受阻塞并等待某个监视器锁的线程处于这种状态WAITING 无限期的等待另一个线程来执行某一待定操作的线程处于这种状态TIMED_WAITNG 等待另一个线程来执行取…

游戏ai 行为树_游戏AI –行为树简介

游戏ai 行为树游戏AI是一个非常广泛的主题&#xff0c;尽管有很多资料&#xff0c;但我找不到能以较慢且更易理解的速度缓慢介绍这些概念的东西。 本文将尝试解释如何基于行为树的概念来设计一个非常简单但可扩展的AI系统。 什么是AI&#xff1f; 人工智能是参与游戏的实体表现…

java构造器_Java构造器就是这么简单!

前言理解构造器之前&#xff0c;首先我们需要了解Java中为什么要引入构造器&#xff0c;以及构造器的作用。在很久之前&#xff0c;程序员们编写C程序总会忘记初始化变量&#xff08;这真的是一件琐碎但必须的事&#xff09;&#xff0c;C引入了 构造器(constructor) 的概念&am…

JavaFX技巧32:需要图标吗? 使用Ikonli!

动机 自2013年以来&#xff0c;我一直在编写JavaFX应用程序和库的代码&#xff0c;它们的共同点是&#xff0c;我需要找到可以用于它们的良好图标/图形。 作为前Swing开发人员&#xff0c;我首先使用图像文件&#xff0c;GIF或PNG。 通常&#xff0c;我会从IconExperience&…

java应用部署docker_Docker部署JavaWeb项目实战

摘要&#xff1a;本文主要讲了怎样在Ubuntu14.04 64位系统下来创建一个执行Java web应用程序的Docker容器。一、下载镜像、启动容器1、下载镜像先查看镜像docker images记住这个Image ID&#xff0c;下面我们启动容器须要用到它。假设看到以上输出&#xff0c;说明您能够使用“…

如何用Java创建不可变的Map

你好朋友&#xff0c; 在本教程中&#xff0c;我们将看到如何用Java创建不可变的Map。 –不可变的类或对象是什么意思&#xff1f; –什么是不可变地图&#xff1f; –如何在Java中创建不可变的Map&#xff1f; 不变的类或对象是什么意思&#xff1f; 不可变的类或对象是创…

quartz java 线程 不释放_java Quartz 内存泄漏

我用定时器启动应用的时候发现内存泄漏&#xff0c;具体报错如下&#xff1a;十月 30, 2015 2:30:12 下午 org.apache.catalina.startup.HostConfig undeploy信息: Undeploying context [/ChinaMoney Maven Webapp]十月 30, 2015 2:30:15 下午 org.apache.catalina.loader.Weba…

在ultraedit查找每行第二个单词_新手收藏!亚马逊关键字查找

亚马逊销售中最重要的是“排名”。而“关键字”对提高排名很重要。搜索结果对亚马逊的销售产生重大影响。要想让你的产品被显示在搜索结果的顶部&#xff0c;那你必须选择有效的关键字。搜索关键词排名一直上不去&#xff0c;你可能会这么想&#xff1a;“关键字不好吧......。…

java opencv磨皮算法_使用OPENCV简单实现具有肤质保留功能的磨皮增白算法

在一个美颜高手那里发现一个美颜算法&#xff0c;他写出了数学表达式&#xff0c;没有给出代码&#xff0c;正好在研究OPENCV&#xff0c;顺手实现之。具体过程就是一系列矩阵运算&#xff0c;据说是从一个PS高手那里研究 出来的&#xff0c;一并表示感谢。这是数学表达式&…

junit单元测试断言_简而言之,JUnit:单元测试断言

junit单元测试断言简而言之&#xff0c;本章涵盖了各种单元测试声明技术。 它详细说明了内置机制&#xff0c; Hamcrest匹配器和AssertJ断言的优缺点 。 正在进行的示例扩大了主题&#xff0c;并说明了如何创建和使用自定义匹配器/断言。 单元测试断言 信任但要验证 罗纳德里…

keyshot环境素材文件_KeyShot渲染,打光这么打,效果倍儿棒

有过渲染经验的小伙伴们应该知道&#xff0c;除了需要对渲染软件的操作熟悉外&#xff0c;最重要的莫过于“材质”和“灯光”。而这里&#xff0c;就不得不提到KeyShot&#xff0c;作为工业设计行业必须要掌握的技能之一&#xff0c;它在行业当中的地位可谓独树一帜。除了其操作…

redis种类型对应java类型_Redis的五种基本数据类型介绍

Redis作为缓存具有极其丰富的功能&#xff0c;比如计数器、好友关系以及排行榜等等。而Redis之所能够实现如此强大的功能&#xff0c;完全是依赖着它的基本数据结构。今天我们来看看Redis的五种基本的数据结构&#xff0c;分别是字符串(strings)&#xff0c; 散列(hashes)&…

REST /使用提要发布事件

处理事件 当使用多个解耦的服务时&#xff08;例如&#xff0c;在微服务体系结构中 &#xff09;&#xff0c;很有可能需要一种将某种域事件从一个服务发布到一个或多个其他服务的方法。 许多广泛采用的解决方案依赖于单独的基础结构来解决此问题&#xff08;例如事件总线或消…

hibernate自动配置_Hibernate自动冲洗的黑暗面

hibernate自动配置介绍 既然我已经描述了JPA和Hibernate刷新策略的基础知识 &#xff0c;我就可以继续阐明Hibernate的AUTO刷新模式的令人惊讶的行为。 并非所有查询都会触发会话刷新 许多人会认为Hibernate 总是在执行任何查询之前先刷新Session。 虽然这可能是一种更直观的方…

slf4j注解log报错_SpringBoot自定义日志注解,用于数据库记录操作日志,你用过吗?...

大家好&#xff0c;我是程序员7歌&#xff01;今天我将为大家讲解如何通过自定义注解记录接口访问日志。一般的开发中&#xff0c;有两种方式可以记录日志信息&#xff0c;第一种&#xff1a;把接口日志信息保存到日志文件中&#xff0c;第二种&#xff1a;把接口操作日志保存到…

java applet audion_java applet audion

①希罗尤尔和他的飞翼敢达也有着不少拥趸&#xff0c;让我们期待这位美少年在《敢达决战》中的表现吧。②颜值时代&#xff0c;浏览器皮肤也不能输360浏览器耳目一新的设计&#xff0c;高清精美的壁纸&#xff0c;让你上网时更添一份好心情。软件使用1、支持游戏小号2、优化小程…

markdown 流程图_Markdown 进阶技能:用代码画流程图(编程零基础也适用)

这篇文章主要介绍流程图基础以写代码的方式画流程图相比于使用画图工具拖拽画图&#xff0c;用代码画图有什么好处&#xff1f;首先&#xff0c;这种方式非常轻便&#xff0c;无需安装复杂的画图应用。Typora 等多种 Markdown 编辑器自带有画图扩展&#xff08;这也是 Markdown…

java jtree_Java JTree

Java JTree1 Java JTree的介绍JTree类用于显示树结构数据或层次结构数据。JTree是一个复杂的组件。它的最顶部有一个“根节点”&#xff0c;它是树中所有节点的父节点。它继承了JComponent类。2 Java JTree的声明我们来看一下javax.swing.JTree类的声明。public class JTree ex…