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事件监听内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • SpringBoot如何返回页面的实现方法

    SpringBoot如何返回页面的实现方法

    SpringBoot中使用Controller和页面的结合能够很好地实现用户的功能及页面数据的传递。本文介绍了如何实现页面的返回以及这里面所包含的坑,感兴趣的可以了解一下
    2021-07-07
  • Java static关键字详细解析

    Java static关键字详细解析

    这篇文章主要介绍了Java static关键字详细解析,java中的static关键字主要用于内存管理,可以用在变量、方法、代码块和嵌套类中。更多相关介绍,需要的小伙伴可以参考一下
    2022-08-08
  • Quarkus集成apollo配置中心

    Quarkus集成apollo配置中心

    这篇文章主要介绍了Quarkus集成apollo配置中心,文中详细的讲解了Quarkus的config构成,以及apollo集成实现,有需要的朋友可以借鉴参考下,希望能够有所帮助
    2022-02-02
  • Spring之ShutDown Hook死锁现象解读

    Spring之ShutDown Hook死锁现象解读

    这篇文章主要介绍了Spring之ShutDown Hook死锁现象解读,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-04-04
  • Java之JNDI注入的实现

    Java之JNDI注入的实现

    JNDI是Java EE的重要部分,本文主要介绍了Java之JNDI注入的实现,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-11-11
  • Java中使用BigDecimal进行精确运算

    Java中使用BigDecimal进行精确运算

    这篇文章主要介绍了Java中使用BigDecimal进行精确运算的方法,非常不错,需要的朋友参考下
    2017-02-02
  • SpringBoot项目修改访问端口和访问路径的方法

    SpringBoot项目修改访问端口和访问路径的方法

    这篇文章主要介绍了SpringBoot项目修改访问端口和访问路径的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-12-12
  • Spring中@PathVariable注解的简单使用

    Spring中@PathVariable注解的简单使用

    这篇文章主要介绍了Spring中@PathVariable注解的简单使用,@PathVariable 是 Spring Framework 中的注解之一,用于处理 RESTful Web 服务中的 URL 路径参数,它的作用是将 URL 中的路径变量绑定到方法的参数上,需要的朋友可以参考下
    2024-01-01
  • rabbitmq使用springboot实现direct模式(最新推荐)

    rabbitmq使用springboot实现direct模式(最新推荐)

    这篇文章主要介绍了rabbitmq使用springboot实现direct模式,本文通过示例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-07-07
  • Mybatis自定义拦截器和插件开发详解

    Mybatis自定义拦截器和插件开发详解

    这篇文章主要给大家介绍了关于Mybatis自定义拦截器和插件开发的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-04-04

最新评论