EventBus簡單封裝

前言

以前每個頁面與每個頁面業務邏輯傳遞讓你不知所措,一個又一個接口回調,讓你暈頭轉向,一個又一個參數讓你混亂不堪。EventBus一個耦合度低的讓你害怕的框架。

什么是EventBus

EventBus是一個消息總線,以觀察者模式實現,用於簡化程序的組件,可以輕易切換線程,實現各組件之間的刷新通知,以及參數的傳遞。EventBus3.0跟之前版本的區別

是介入了annotation @Subscribe，取代了以前約定命名的方式。

EventBus的優點

它代替了廣播,startActivityforResult,Handle,異步回調等,來實現各個組件間,線程間的通訊,優點是開銷小,代碼更優雅,以及將發送者與接受者解耦。

EventBus封裝

我們今天直接看EventBus封裝過程。

EventBus的訂閱,接收,發送,我們都放在基類BaseActivity/BaseFragment中完成(EventBus.getDefault().register(this)訂閱事件,發起通信的邏輯直接調用EventBus.getDefault().post(Object event)來發布事件)。

EventBus封裝實戰

在Gradle中添加EventBus依賴：

compile 'org.greenrobot:eventbus:3.0.0'

封裝一下EventBus的訂閱、取消訂閱、發布等方法：

public class EventBusUtil {

    public static void register(Object subscriber) {
        EventBus.getDefault().register(subscriber);
    }

    public static void unregister(Object subscriber) {
        EventBus.getDefault().unregister(subscriber);
    }

    public static void sendEvent(Event event) {
        EventBus.getDefault().post(event);
    }

    public static void sendStickyEvent(Event event) {
        EventBus.getDefault().postSticky(event);
    }

    // 其他
}

在BaseActivity/BaseFragment中的onCreate和onDestroy方法中訂閱和取消訂閱，這里添加了一個isRegisterEventBus()方法，默認返回false，即不訂閱EventBus，子類Activity/Fragment如果需要訂閱的話復寫這個方法並返回true即可。

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    if (isRegisterEventBus()) {
        EventBusUtil.register(this);
    }
}

/**
 * 是否注冊事件分發
 *
 * @return true綁定EventBus事件分發，默認不綁定，子類需要綁定的話復寫此方法返回true.
 */
protected boolean isRegisterEventBus() {
    return false;
}

@Override
public void onDestroy() {
    super.onDestroy();
    if (isRegisterEventBus()) {
        EventBusUtil.unregister(this);
    }
}

定義事件Event：

public class Event<T> {
    private int code;
    private T data;

    public Event(int code) {
        this.code = code;
    }

    public Event(int code, T data) {
        this.code = code;
        this.data = data;
    }

    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }
}

通過泛型<T>指定事件通信過程中的數據類型，code為事件碼，使用的時候給不同的事件類型指定不同的code。

在BaseActivity\BaseFragment中添加接收到EventBus的方法：

/**
 * 是否注冊事件分發
 *
 * @return true綁定EventBus事件分發，默認不綁定，子類需要綁定的話復寫此方法返回true.
 */
protected boolean isRegisterEventBus() {
    return false;
}

@Subscribe(threadMode = ThreadMode.MAIN)
public void onEventBusCome(Event event) {
    if (event != null) {
        receiveEvent(event);
    }
}

@Subscribe(threadMode = ThreadMode.MAIN, sticky = true)
public void onStickyEventBusCome(Event event) {
    if (event != null) {
        receiveStickyEvent(event);
    }
}

/**
 * 接收到分發到事件
 *
 * @param event 事件
 */
protected void receiveEvent(Event event) {

}

/**
 * 接受到分發的粘性事件
 *
 * @param event 粘性事件
 */
protected void receiveStickyEvent(Event event) {

}

根據自己項目的需求，在訂閱了EventBus的Activity/Fragment中復寫receiveEvent(Event event)或receiveStickyEvent(Event event)來處理接收到事件后的邏輯。

這里也可以不用在BaseActivty/BaseFragment中添加接受事件的方法（因為添加了過后不能確定的子類的Event泛型）。那么就直接在訂閱的Activity/Fragment中給接收事件的方法添加EventBus對應的事件接受注解，並指定參數Event的泛型。

@Subscribe(threadMode = ThreadMode.MAIN)
public void onEventReceived(Event<User> event) {
    if (event != null && event.getCode() == C.EventCode.C) {
        User user = event.getData();
    }
}

在給定Event的code的時候最好在常量池中定義一個類專門用來定義不同類型的EventBus的code，這樣在接收到EventBus的地方可以根據這些code值來判斷Event的來源。

public final class C {
    // EventBus Code
    public static final class EventCode {
        public static final int A = 0x111111;
        public static final int B = 0x222222;
        public static final int C = 0x333333;
        public static final int D = 0x444444;
        // other more
    }
}

使用示例：
在MainActivity中復寫isRegisterEventBus()並返回true注冊EventBus，復寫receiveEvent(Event event)接收發布的事件。

@Override
protected boolean isRegisterEventBus() {
    return true;
}

@Override
protected void receiveEvent(Event event) {
    // 接受到Event后的相關邏輯
    switch (event.getCode()) {
        case C.EventCode.A:
            Log.d("EventBus", "接收到A類型的Event");
            break;
        case C.EventCode.B:
            Log.d("EventBus", "接收到B類型的Event");
            break;
        case C.EventCode.C:
            Log.d("EventBus", "接收到B類型的Event，攜帶User");
            User user = (User) event.getData();
            break;
        case C.EventCode.D:
            Log.d("EventBus", "接收到D類型的Event，攜帶News");
            News news = (News) event.getData();
            break;
    }
}

在receiveEvent(Event event)根據對應的事件的code，判斷通信的數據來源和傳遞的數據類型，以完成對應的邏輯。

在InfoActivity中發送事件，InfoActivity只發送不需要接收Event的話就不注冊，也不用復寫isRegisterEventBus()和receiveEvent(Event event)方法了。

public void sendEventA(View view) {
    EventBusUtil.sendEvent(new Event(C.EventCode.A));
}

public void sendEventB(View view) {
    EventBusUtil.sendEvent(new Event(C.EventCode.B));
}

public void sendEventC(View view) {
    Event<User> event = new Event<>(C.EventCode.C, new User());
    EventBusUtil.sendEvent(event);
}

public void sendEventD(View view) {
    Event<News> event = new Event<>(C.EventCode.D, new News());
    EventBusUtil.sendEvent(event);
}

通過上面的方式，將EventBus封裝到BaseActivity/BaseFragment中，使得EventBus和項目解耦更加徹底，同時在需要使用的子Activity/Fragment中只需要復寫isRegisterEventBus()和receiveEvent(Event event)即可，不用每個地方都去訂閱和取消訂閱。並且給Event給定code和泛型能夠很好的區分不同的事件來源和數據類型。