Android實現消息總線的幾種方式詳解

前言

消息總線又叫事件總線,為什麼我們需要一個消息總線呢?是因為隨著項目變大,頁面變多,我們可能出現跨頁面、跨組件、跨線程、跨進程傳遞消息與數據,為瞭更方便的直接通知到指定的頁面實現具體的邏輯,我們需要消息總線來實現。

從最基本的 BroadcastReceiver 到 EventBus 再到RxBus ,後來官方出瞭AndroidX jetpack 我們開始使用LiveDataBus,最後到Kotlin的流行出來瞭FlowBus。我們看看他們是怎麼一步一步演變的。

一、BroadcastReceiver 廣播

我們再初入 Android 的時候都應該學過廣播接收者,分為靜態廣播和動態註冊廣播,在高版本的 Android 中限制瞭我們一些靜態廣播的使用,不過我們還是能通過動態註冊的方式獲取一些系統的狀態改變。像常用的電量變化、網絡狀態變化、短信發送接收的狀態等等。

比如網絡變化的監聽:

    IntentFilter intentFilter = new IntentFilter(ConnectivityManager.CONNECTIVITY_ACTION);
    application.getApplicationContext().registerReceiver(InstanceHolder.INSTANCE, intentFilter);

在消息中線中,我們可以使用本地廣播來實現 LocalBroadcastManager 消息的通知。

    LocalBroadcastManager mLocalBroadcastManager = LocalBroadcastManager.getInstance(mContext);
    
    BroadcastReceiver  mLoginReceiver = new LoginSuccessReceiver();
    mLocalBroadcastManager.registerReceiver(mLoginReceiver, new IntentFilter(Constants.ACTION_LOGIN_SUCCESS));

    private class LoginSuccessReceiver extends BroadcastReceiver {
        @Override
        public void onReceive(Context context, Intent intent) {
            //刷新Home界面
            refreshHomePage();
        
            //刷新未讀信息
            requestUnreadNum();
        }
    }

    //記得要解綁對應的接收器
    mLocalBroadcastManager.unregisterReceiver(mLoginReceiver);

這樣就可以實現一個消息通知瞭。相比 EventBus 它的性能和空間的消耗都是較大的,並且隻能固定在主線程運行。

二、EventBus

EventBus最大的特點就是簡潔、解耦,可以直接傳遞我們自定義的消息Message。EventBus簡化瞭應用程序內各組件間、組件與後臺線程間的通信。記得2015年左右是非常火爆的。

EventBus的調度靈活,不依賴於 Context,使用時無需像廣播一樣關註 Context 的註入與傳遞。可繼承、優先級、粘滯,是 EventBus 比之於廣播的優勢。幾乎可以滿足我們全部的需求。

最初的EventBus其實就是一個方法的集合與查找,核心是通過register方法把帶有@Subscrib註解的方法和參數之類的東西全部放入一個List集合,然後通過post方法去這個list循環查找到符合條件的方法去執行。

如何使用EventBus,一共分5步:

  @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_event_bus);
        EventBus.getDefault().register(MainActivity.this);  //1.註冊廣播
    }
  @Override
    protected void onDestroy() {
        super.onDestroy();
        EventBus.getDefault().unregister(MainActivity.this); //2.解註冊廣播
    }
/**
 * 3.傳遞什麼類型的。定義一個消息類
 */
public class MessageEvent {
    public String name;

    public MessageEvent(String name) {
        this.name = name;
    }
}
    @OnClick({R.id.bt_eventbus_send_main, R.id.bt_eventbus_send_sticky})
    public void onClick(View view) {
        switch (view.getId()) {
            case R.id.bt_eventbus_send_main:
                //4.發送消息
                EventBus.getDefault().post(new MessageEvent("我是主頁面發送過來的消息"));
                finish();
                break;
        }
    }
   /**
     * 5.接受到消息。需要註解
     *
     * @param event
     */
    @Subscribe(threadMode = ThreadMode.MAIN)   //主線程執行
    public void MessageEventBus(MessageEvent event) {
        //5。顯示接受到的消息
        mTvEventbusResult.setText(event.name);
    }

EventBus的性能開銷其實不大,EventBus2.4.0 版是利用反射來實現的,後來改成 APT 實現之後會好很多。主要問題是需要定義很多的消息對象,消息太多之後就感覺管理起來很麻煩。當消息太多之後容器內部的查找會出現性能瓶頸。

就算如此 EventBus 也是值得大傢使用的。

三、RxBus

RxBus是基於RxJava實現的,強大是強大,但是學習成本比較高,需要額外導入RxJava RxAndroid等庫,這些庫體積還是較大的。可以實現異步的消息等。

本身的實現是很簡單的:

public class RxBus {
    private volatile static RxBus mDefaultInstance;
    private final Subject<Object> mBus;

    private RxBus() {
        mBus = PublishSubject.create().toSerialized();
    }

    public static RxBus getInstance() {
        if (mDefaultInstance == null) {
            synchronized (RxBus.class) {
                if (mDefaultInstance == null) {
                    mDefaultInstance = new RxBus();
                }
            }
        }
        return mDefaultInstance;
    }

    /**
     * 發送事件
     */
    public void post(Object event) {
        mBus.onNext(event);
    }

    /**
     * 根據傳遞的 eventType 類型返回特定類型(eventType)的 被觀察者
     */
    public <T> Observable<T> toObservable(final Class<T> eventType) {
        return mBus.ofType(eventType);
    }

    /**
     * 判斷是否有訂閱者
     */
    public boolean hasObservers() {
        return mBus.hasObservers();
    }

    public void reset() {
        mDefaultInstance = null;
    }
}

定義消息對象:

public class MsgEvent {
    private String msg;

    public MsgEvent(String msg) {
        this.msg = msg;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }
}

發送與接收:

RxBus.getInstance().toObservable(MsgEvent.class).subscribe(new Observer<MsgEvent>() {
            @Override
            public void onSubscribe(Disposable d) {
                
            }

            @Override
            public void onNext(MsgEvent msgEvent) {
                //處理事件
            }

            @Override
            public void onError(Throwable e) {
                  
            }

            @Override
            public void onComplete() {

            }
        });
RxBus.getInstance().post(new MsgEvent("Java"));

缺點是容易內存泄露,我們需要使用rxlifecycle 或者使用CompositeDisposable 自己對生命周期進行處理解綁。

四、LiveDataBus

官方出瞭AndroidX jetpack 內部包含LiveData,它可以感知並遵循Activity、Fragment或Service等組件的生命周期。

為什麼要使用LiveDataBus,正是基於LiveData對組件生命周期可感知的特點,因此可以做到僅在組件處於生命周期的激活狀態時才更新UI數據。

一個簡單的LiveDataBus的實現:

public final class LiveDataBus {
    private final Map<String, BusMutableLiveData<Object>> bus;
 
    private LiveDataBus() {
        bus = new HashMap<>();
    }
 
    private static class SingletonHolder {
        private static final LiveDataBus DEFAULT_BUS = new LiveDataBus();
    }
 
    public static LiveDataBus get() {
        return SingletonHolder.DEFAULT_BUS;
    }
 
    public <T> MutableLiveData<T> with(String key, Class<T> type) {
        if (!bus.containsKey(key)) {
            bus.put(key, new BusMutableLiveData<>());
        }
        return (MutableLiveData<T>) bus.get(key);
    }
 
    public MutableLiveData<Object> with(String key) {
        return with(key, Object.class);
    }
 
    private static class ObserverWrapper<T> implements Observer<T> {
 
        private Observer<T> observer;
 
        public ObserverWrapper(Observer<T> observer) {
            this.observer = observer;
        }
 
        @Override
        public void onChanged(@Nullable T t) {
            if (observer != null) {
                if (isCallOnObserve()) {
                    return;
                }
                observer.onChanged(t);
            }
        }
 
        private boolean isCallOnObserve() {
            StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();
            if (stackTrace != null && stackTrace.length > 0) {
                for (StackTraceElement element : stackTrace) {
                    if ("android.arch.lifecycle.LiveData".equals(element.getClassName()) &&
                            "observeForever".equals(element.getMethodName())) {
                        return true;
                    }
                }
            }
            return false;
        }
    }
 
    private static class BusMutableLiveData<T> extends MutableLiveData<T> {
 
        private Map<Observer, Observer> observerMap = new HashMap<>();
 
        @Override
        public void observe(@NonNull LifecycleOwner owner, @NonNull Observer<T> observer) {
            super.observe(owner, observer);
            try {
                hook(observer);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
 
        @Override
        public void observeForever(@NonNull Observer<T> observer) {
            if (!observerMap.containsKey(observer)) {
                observerMap.put(observer, new ObserverWrapper(observer));
            }
            super.observeForever(observerMap.get(observer));
        }
 
        @Override
        public void removeObserver(@NonNull Observer<T> observer) {
            Observer realObserver = null;
            if (observerMap.containsKey(observer)) {
                realObserver = observerMap.remove(observer);
            } else {
                realObserver = observer;
            }
            super.removeObserver(realObserver);
        }
 
        private void hook(@NonNull Observer<T> observer) throws Exception {
            //get wrapper's version
            Class<LiveData> classLiveData = LiveData.class;
            Field fieldObservers = classLiveData.getDeclaredField("mObservers");
            fieldObservers.setAccessible(true);
            Object objectObservers = fieldObservers.get(this);
            Class<?> classObservers = objectObservers.getClass();
            Method methodGet = classObservers.getDeclaredMethod("get", Object.class);
            methodGet.setAccessible(true);
            Object objectWrapperEntry = methodGet.invoke(objectObservers, observer);
            Object objectWrapper = null;
            if (objectWrapperEntry instanceof Map.Entry) {
                objectWrapper = ((Map.Entry) objectWrapperEntry).getValue();
            }
            if (objectWrapper == null) {
                throw new NullPointerException("Wrapper can not be bull!");
            }
            Class<?> classObserverWrapper = objectWrapper.getClass().getSuperclass();
            Field fieldLastVersion = classObserverWrapper.getDeclaredField("mLastVersion");
            fieldLastVersion.setAccessible(true);
            //get livedata's version
            Field fieldVersion = classLiveData.getDeclaredField("mVersion");
            fieldVersion.setAccessible(true);
            Object objectVersion = fieldVersion.get(this);
            //set wrapper's version
            fieldLastVersion.set(objectWrapper, objectVersion);
        }
    }
}

註冊與發送:

LiveDataBus.get()
        .with("key_test", String.class)
        .observe(this, new Observer<String>() {
            @Override
            public void onChanged(@Nullable String s) {
            }
        });

LiveDataBus.get().with("key_test").setValue(s);

LiveDataBus已經算是很好用的,自動註冊解綁,根據Key傳遞泛型T對象,容易查找對應的接收者,也可以實現可見的觸發和直接觸發,可以實現跨進程,

LiveData有幾點不足,隻能在主線程更新數據,操作符無法轉換數據,基於 Android Api 實現的,換一個平臺無法適應,基於這幾點又開發出瞭FlowBus。

五、FlowBus

很多人都說Flow 的出現導致 LiveData 沒那麼重要瞭,就是因為 LiveData 的場景 都可以使用 Flow 平替瞭,還能更為的強大和靈活。

StateFlow 可以 替代ViewModel中傳遞數據,SharedFlow 可以實現事件總線。(這兩者的異同如果大傢有興趣,我可以單獨開一篇講下)。

SharedFlow 就是一種熱流,可以實現一對多的關系,其構造方法支持天然支持普通的消息發送與粘性的消息發送。一般我們FlowBus都是基於 SharedFlow 來實現:

object FlowBus {
    private val busMap = mutableMapOf<String, EventBus<*>>()
    private val busStickMap = mutableMapOf<String, StickEventBus<*>>()

    @Synchronized
    fun <T> with(key: String): EventBus<T> {
        var eventBus = busMap[key]
        if (eventBus == null) {
            eventBus = EventBus<T>(key)
            busMap[key] = eventBus
        }
        return eventBus as EventBus<T>
    }

    @Synchronized
    fun <T> withStick(key: String): StickEventBus<T> {
        var eventBus = busStickMap[key]
        if (eventBus == null) {
            eventBus = StickEventBus<T>(key)
            busStickMap[key] = eventBus
        }
        return eventBus as StickEventBus<T>
    }

    //真正實現類
    open class EventBus<T>(private val key: String) : LifecycleObserver {

        //私有對象用於發送消息
        private val _events: MutableSharedFlow<T> by lazy {
            obtainEvent()
        }

        //暴露的公有對象用於接收消息
        val events = _events.asSharedFlow()

        open fun obtainEvent(): MutableSharedFlow<T> = MutableSharedFlow(0, 1, BufferOverflow.DROP_OLDEST)

        //主線程接收數據
        fun register(lifecycleOwner: LifecycleOwner, action: (t: T) -> Unit) {
            lifecycleOwner.lifecycle.addObserver(this)
            lifecycleOwner.lifecycleScope.launch {
                events.collect {
                    try {
                        action(it)
                    } catch (e: Exception) {
                        e.printStackTrace()
                        YYLogUtils.e("FlowBus - Error:$e")
                    }
                }
            }
        }

        //協程中發送數據
        suspend fun post(event: T) {
            _events.emit(event)
        }

        //主線程發送數據
        fun post(scope: CoroutineScope, event: T) {
            scope.launch {
                _events.emit(event)
            }
        }

        //自動銷毀
        @OnLifecycleEvent(Lifecycle.Event.ON_DESTROY)
        fun onDestroy() {
            YYLogUtils.w("FlowBus - 自動onDestroy")
            val subscriptCount = _events.subscriptionCount.value
            if (subscriptCount <= 0)
                busMap.remove(key)
        }
    }

    class StickEventBus<T>(key: String) : EventBus<T>(key) {
        override fun obtainEvent(): MutableSharedFlow<T> = MutableSharedFlow(1, 1, BufferOverflow.DROP_OLDEST)
    }
}

發送與接收消息

    // 主線程-發送消息
    FlowBus.with<String>("test-key-01").post([email protected], "Test Flow Bus Message")
    // 接收消息
    FlowBus.with<String>("test-key-01").register(this) {
            LogUtils.w("收到FlowBus消息 - " + it)
        }

發送粘性消息

 FlowBus.withStick<String>("test-key-02").post(lifecycleScope, "Test Stick Message")
   FlowBus.withStick<String>("test-key-02").register(this){
            LogUtils.w("收到粘性消息:$it")
        }

Log如下:

總結

其實這麼多消息總線框架,我更推薦EventBus LiveDataBus FlowBus這三種。

總的來說,我們盡量不依賴第三方的框架來實現,那麼 FlowBus 是語言層級的,基於Kotlin的特性實現,比較推薦瞭,我本人是喜歡用LiveDataBus,基於 Android 開發場景來看,幾乎能滿足全部要求瞭。

如果大傢有源碼方面的需求可以看看這裡,上面的源碼也都貼出來瞭,不過更推薦大傢根據不同的類型自行去 Github 上面找對應的實現封裝,功能會更多,健壯性更好。

到此這篇關於Android實現消息總線的幾種方式的文章就介紹到這瞭,更多相關Android消息總線實現內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!

推薦閱讀: