SpringBoot利用切面注解及反射实现事件监听功能

 更新时间:2022年07月18日 14:18:22   作者:mabo_9704@163.com  
这篇文章主要介绍了springboot事件监听,通过利用切面、注解、反射实现,接下来将对这几种方式逐一说明,具有很好的参考价值,希望对大家有所帮助

前言

当某个事件需要被监听的时候,我们需要去做其他的事前,最简单的方式就是将自己的业务 方法追加到该事件之后。

但是当有N多个这样的需求的时候我们都这样一个个去添加修改事件的源码吗?

这篇文章将告诉你如何用一个注解,就可以将你的业务代码通过切面的方式添加到事件的前后,而不需要修改事件的代码

效果图

如下图所示,add方法内并没有调用其他的方法,但是其他方法仍然被执行了。

只要给监听方法加@AddEventListener()注解就可以让它在事件前后执行了

监听原理

该方法是利用切面、注解、反射来实现SpringBoot的事件监听的

1.通过Aspect的切面,切入事件方法

首先使用Aspec的Around(也可以用before或者after,但是比较麻烦)注解,切入AddEvent的方法中,around注解的方法中,可以在事件方法的执行前后添加业务代码。但是我们不直接加入需要添加的业务,进入第二步骤。

2.利用反射获取被AddEventAop注解的类和方法

利用反射Class.forName(class),获取被AddEventAop注解的类(当然你也可以修改一下,获取所有的类),该类哪个方法被AddEventListener注解了,就执行该方法,则监听执行成功。

method.invoke(o, args);

注意(非常重要)

  • AddEventListener使用的类上,必须被AddEventAop注解了,否则反射的时候方法不会被执行。
  • 事件的类必须是bean,否则切面失败。
  • 监听方法和(被监听方法)事件方法的参数数量,类型,顺序必须一致,否则可能导致反射执行方法失败

核心源码

@Around("@annotation(event)")
    public Object addEventListener(ProceedingJoinPoint joinPoint, AddEventAop event) throws Throwable {
        Object[] args = joinPoint.getArgs();
        //存储需要在方法执行之后再执行的类
        List<Method> afterEventMethod = new ArrayList<>();
        //反射获取AddEventListener修饰的方法并执行
        //获取自定义注解的配置
        final Map<String, Object> beans = applicationContext.getBeansWithAnnotation(AddEventAop.class);
        for (String key : beans.keySet()) {
            //Spring 代理类导致Method无法获取,这里使用AopUtils.getTargetClass()方法
            Object o  = beans.get(key);
            Class<?> aClass = beans.get(key).getClass();
            String name = aClass.getName();
            //aop切面会导致方法注解丢失,在这里处理获取原类名
            if (name.contains("$$")){
                String[] names = name.split("\\$\\$");
                name=names[0];
                aClass = Class.forName(name);
            }
            Method[] methods = aClass.getMethods();
            for (Method method : methods) {
                //获取指定方法上的注解的属性
                AddEventListener annotation = method.getAnnotation(AddEventListener.class);
                if (annotation!=null){
                    //执行所有的注解了该类的方法
                    EventType value = annotation.value();
                    if (value.equals(EventType.BEFOREEVENT)){
                        method.invoke(o, args);
                    }else{
                       afterEventMethod.add(method);
                    }
                }
            }
        }
        //执行被切面的方法
        Object proceed = joinPoint.proceed(args);
        //执行需要在方法执行之后再执行的方法
        for (Method method : afterEventMethod) {
            Class<?> aClass = method.getDeclaringClass();
            Object o = aClass.newInstance();
            method.invoke(o, args);
        }
        return proceed;
    }

源码地址

Github项目地址

到此这篇关于SpringBoot利用切面注解及反射实现事件监听功能的文章就介绍到这了,更多相关SpringBoot事件监听内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java中的BufferedInputStream与BufferedOutputStream使用示例

    Java中的BufferedInputStream与BufferedOutputStream使用示例

    BufferedInputStream和BufferedOutputStream分别继承于FilterInputStream和FilterOutputStream,代表着缓冲区的输入输出,这里我们就来看一下Java中的BufferedInputStream与BufferedOutputStream使用示例:
    2016-06-06
  • Java实现解析ini文件对应到JavaBean中

    Java实现解析ini文件对应到JavaBean中

    ini 文件是Initialization File的缩写,即初始化文件,是windows的系统配置文件所采用的存储格式。这篇文章主要介绍了通过Java实现解析ini文件对应到JavaBean中,需要的可以参考一下
    2022-01-01
  • SpringCloud Feign远程调用与自定义配置详解

    SpringCloud Feign远程调用与自定义配置详解

    Feign是Netflix公司开发的一个声明式的REST调用客户端; Ribbon负载均衡、 Hystrⅸ服务熔断是我们Spring Cloud中进行微服务开发非常基础的组件,在使用的过程中我们也发现它们一般都是同时出现的,而且配置也都非常相似
    2022-11-11
  • 详解Java8新特性如何防止空指针异常

    详解Java8新特性如何防止空指针异常

    要说 Java 编程中哪个异常是你印象最深刻的,那 NullPointerException 空指针可以说是臭名昭著的,不要说初级程序员会碰到, 即使是中级,专家级程序员稍不留神,就会掉入这个坑里,本文就和大家聊聊Java8新特性如何防止空指针异常
    2023-08-08
  • Java流操作之数据流实例代码

    Java流操作之数据流实例代码

    这篇文章主要介绍了Java流操作之数据流实例代码,具有一定借鉴价值,需要的朋友可以参考下
    2018-01-01
  • springboot yml配置文件值注入方式

    springboot yml配置文件值注入方式

    这篇文章主要介绍了springboot yml配置文件值注入方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-01-01
  • Java 使用多线程调用类的静态方法的示例

    Java 使用多线程调用类的静态方法的示例

    这篇文章主要介绍了Java 使用多线程调用类的静态方法的示例,帮助大家更好的理解和使用Java,感兴趣的朋友可以了解下
    2020-10-10
  • java webApp异步上传图片实现代码

    java webApp异步上传图片实现代码

    这篇文章主要为大家详细介绍了java webApp异步上传图片实现代码,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-11-11
  • SpringBoot全局处理统一返回类型方式

    SpringBoot全局处理统一返回类型方式

    这篇文章主要介绍了SpringBoot全局处理统一返回类型方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-07-07
  • Java利用序列化实现对象深度clone的方法

    Java利用序列化实现对象深度clone的方法

    这篇文章主要介绍了Java利用序列化实现对象深度clone的方法,实例分析了java序列化及对象克隆的相关技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-07-07

最新评论