SpringBoot利用切面注解及反射實現(xiàn)事件監(jiān)聽功能

更新時間：2022年07月18日 14:18:22 作者：mabo_9704@163.com

這篇文章主要介紹了springboot事件監(jiān)聽，通過利用切面、注解、反射實現(xiàn)，接下來將對這幾種方式逐一說明，具有很好的參考價值，希望對大家有所幫助

前言

當(dāng)某個事件需要被監(jiān)聽的時候，我們需要去做其他的事前，最簡單的方式就是將自己的業(yè)務(wù) 方法追加到該事件之后。

但是當(dāng)有N多個這樣的需求的時候我們都這樣一個個去添加修改事件的源碼嗎？

這篇文章將告訴你如何用一個注解，就可以將你的業(yè)務(wù)代碼通過切面的方式添加到事件的前后，而不需要修改事件的代碼

效果圖

如下圖所示，add方法內(nèi)并沒有調(diào)用其他的方法，但是其他方法仍然被執(zhí)行了。

只要給監(jiān)聽方法加@AddEventListener()注解就可以讓它在事件前后執(zhí)行了

監(jiān)聽原理

該方法是利用切面、注解、反射來實現(xiàn)SpringBoot的事件監(jiān)聽的

1.通過Aspect的切面，切入事件方法

首先使用Aspec的Around（也可以用before或者after，但是比較麻煩）注解，切入AddEvent的方法中，around注解的方法中，可以在事件方法的執(zhí)行前后添加業(yè)務(wù)代碼。但是我們不直接加入需要添加的業(yè)務(wù)，進(jìn)入第二步驟。

2.利用反射獲取被AddEventAop注解的類和方法

利用反射Class.forName(class)，獲取被AddEventAop注解的類（當(dāng)然你也可以修改一下，獲取所有的類），該類哪個方法被AddEventListener注解了，就執(zhí)行該方法，則監(jiān)聽執(zhí)行成功。

method.invoke(o, args);

注意（非常重要）

AddEventListener使用的類上，必須被AddEventAop注解了，否則反射的時候方法不會被執(zhí)行。
事件的類必須是bean，否則切面失敗。
監(jiān)聽方法和（被監(jiān)聽方法）事件方法的參數(shù)數(shù)量，類型，順序必須一致，否則可能導(dǎo)致反射執(zhí)行方法失敗

核心源碼

@Around("@annotation(event)")
    public Object addEventListener(ProceedingJoinPoint joinPoint, AddEventAop event) throws Throwable {
        Object[] args = joinPoint.getArgs();
        //存儲需要在方法執(zhí)行之后再執(zhí)行的類
        List<Method> afterEventMethod = new ArrayList<>();
        //反射獲取AddEventListener修飾的方法并執(zhí)行
        //獲取自定義注解的配置
        final Map<String, Object> beans = applicationContext.getBeansWithAnnotation(AddEventAop.class);
        for (String key : beans.keySet()) {
            //Spring 代理類導(dǎo)致Method無法獲取,這里使用AopUtils.getTargetClass()方法
            Object o  = beans.get(key);
            Class<?> aClass = beans.get(key).getClass();
            String name = aClass.getName();
            //aop切面會導(dǎo)致方法注解丟失，在這里處理獲取原類名
            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){
                    //執(zhí)行所有的注解了該類的方法
                    EventType value = annotation.value();
                    if (value.equals(EventType.BEFOREEVENT)){
                        method.invoke(o, args);
                    }else{
                       afterEventMethod.add(method);
                    }
                }
            }
        }
        //執(zhí)行被切面的方法
        Object proceed = joinPoint.proceed(args);
        //執(zhí)行需要在方法執(zhí)行之后再執(zhí)行的方法
        for (Method method : afterEventMethod) {
            Class<?> aClass = method.getDeclaringClass();
            Object o = aClass.newInstance();
            method.invoke(o, args);
        }
        return proceed;
    }