手寫Android事件匯流排框架Eventbus(簡易版)

karspb發表於2021-09-09

開篇廢話

近期利用業餘時間,跟著大神把Eventbus的框架學習了一下,在這裡,記錄一下這次學習的心得。
EventBus是針一款對Android的釋出/訂閱事件匯流排。它可以讓我們很輕鬆的實現在Android各個元件之間傳遞訊息,並且程式碼的可讀性更好,耦合度更低。
這次學習 ,大概有以下這些知識點:

  1.註解和反射的使用
  2.學習Eventbus的實現原理

需要注意的是,本次記錄是從實現的角度來進行記錄的,可能跟我們呼叫的邏輯順序不一樣。


技術詳情

1. 事件接收者訂閱想要的事件

這一步實現的是,告訴事件生產者,我有這些事件需要處理,透過註解進行標記,方便我們的框架進行收集此類需要處理的事件,例如以下這些操作:

@Subscribe(threadMode = ThreadMode.MainThread)
public void showTextView(SenduoEvent senduoEvent){    tvSenduobusInfo.setText(senduoEvent.toString());
}

@Subscribe(threadMode = ThreadMode.Async)
public void showLog(SenduoEvent senduoEvent){    Log.e(TAG,senduoEvent.toString());
}

透過以上步驟,就相當於告訴我們的框架,這裡需要處理這兩個事件

2. 往事件生產者註冊 和 反註冊想要訂閱的事件

透過第一步,事件接收者已經把想要接收的事件告知了我們這個框架,我們這個框架,就需要透過不同的類來收集這些事件,呼叫者,透過呼叫以下這行程式碼,框架就會進行收集記錄各自訂閱的事件:

  Senduobus.getDefault().register(this);

這一步,框架其實做了蠻多工作的。
首先,透過方法的註解,記錄當前類訂閱的所有事件

public void register(Object activity){

    List list = cacheMap.get(activity);    if(list == null){        list = getSubscribleMethods(activity);
        cacheMap.put(activity,list);
    }

}

這裡的getSubscribleMethods(Object)方法就是透過類的註解,來獲取處理事件的方法:

   private List getSubscribleMethods(Object activity) {

    List list = new ArrayList();

    Class clazz = activity.getClass();    while(clazz != null){
        String name = clazz.getName();        if(name.startsWith("java.")
                || name.startsWith("javax.")
                || name.startsWith("android.")){//如果類全名以這些字元開頭,則認為是jdk的,不是我們自定義的,自然沒必要去拿註解
            break;
        }

        Method[] methods = clazz.getDeclaredMethods();//獲得當前class所有生命的public方法
        for(Method method : methods){
            Subscribe subscribe = method.getAnnotation(Subscribe.class);            if(subscribe == null){                continue;
            }

            Class[] paratems = method.getParameterTypes();            if(paratems.length != 1){                throw new RuntimeException("senduobus 只能接收到一個引數");
            }

            ThreadMode threadMode = subscribe.threadMode();

            SubscribleMethod subscribleMethod = new SubscribleMethod(method,threadMode,paratems[0]);            list.add(subscribleMethod);
        }

        clazz = clazz.getSuperclass();

    }    return list;
}

然後,透過一個記憶體快取Map記錄類與對應類的訂閱事件,減少框架反射的次數

3. 事件生產者分發事件

透過以上兩步,事件接收者,以及其訂閱的事件都已經收集並且繫結好了,就差事件生產者進行分發訊息了。
這裡需要注意的是,如何確認當前這個事件需要由哪個接收者來處理,框架中,是透過方法的引數型別進行分發確認的,以下這種形式:

    Senduobus.getDefault().post(new SenduoEvent("1","測試傳送訊息"));

其中SenduoEvent類,透過這個類來確認該由哪些事件接收者來處理事件:

  public void post(final Object senduoEvent){

    Set set = cacheMap.keySet();

    Iterator iterator = set.iterator();    while(iterator.hasNext()){        final Object activity = iterator.next();
        List list = cacheMap.get(activity);        for(final SubscribleMethod subscribleMethod : list){            if(subscribleMethod.getEventType().isAssignableFrom(senduoEvent.getClass())){                switch(subscribleMethod.getThreadMode()){                    case Async:                        if(Looper.myLooper() == Looper.getMainLooper()){
                            executorService.execute(new Runnable() {                                @Override
                                public void run() {
                                    invoke(subscribleMethod,activity,senduoEvent);
                                }
                            });
                        }else{
                            invoke(subscribleMethod,activity,senduoEvent);
                        }                        break;                    case PostThread:                        break;                    case MainThread:                        if(Looper.myLooper() == Looper.getMainLooper()){
                            invoke(subscribleMethod,activity,senduoEvent);
                        }else{
                            handler.post(new Runnable() {                                @Override
                                public void run() {
                                    invoke(subscribleMethod,activity,senduoEvent);
                                }
                            });
                        }                        break;                    case BackgroundThread:                        break;                    default:                        break;
                }
            }
        }
    }
}

裡面有一些執行緒切換的邏輯,具體可檢視ThreadMode中的註釋,方便理解。

以下是此專案的原始碼:



作者:進擊的歐陽
連結:


來自 “ ITPUB部落格 ” ,連結:http://blog.itpub.net/2001/viewspace-2810358/,如需轉載,請註明出處,否則將追究法律責任。

相關文章