EventBus封裝

EventBus是一款針對Android優(yōu)化的發(fā)布/訂閱事件總線抚恒。可以替代廣播蛤奢、startActivityForResultHandler陶贼、異步回調(diào)等來實現(xiàn)各組件間啤贩、組件與后臺線程間的通信。它的優(yōu)點是開銷小拜秧,代碼更優(yōu)雅痹屹,以及將發(fā)送者和接收者解耦。

通常我們在使用EventBus的時候都是直接需要接收通信的Activity/Fragment中通過EventBus.getDefault().register(this)訂閱事件枉氮,在需要發(fā)起通信的邏輯直接調(diào)用EventBus.getDefault().post(Object event)來發(fā)布事件志衍。但是要是一個項目中有很多地方都使用EventBus來通信暖庄,比如重新登錄后更新各個頁面的登錄狀態(tài),或者是接收到通知更新消息提示等楼肪,都這樣直接使用的話代碼重復(fù)率很高培廓,并且呢,如果以后升級或者更換EventBus時春叫,各個地方都要修改医舆,這就比較麻煩了。因此我一般是將EventBus的發(fā)布和訂閱封裝到BaseActivity/BaseFragment中象缀。

在Gradle中添加EventBus依賴:

compile 'org.greenrobot:eventbus:3.0.0'

封裝一下EventBus的訂閱、取消訂閱爷速、發(fā)布等方法:

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中的onCreateonDestroy方法中訂閱和取消訂閱央星,這里添加了一個isRegisterEventBus()方法,默認返回false惫东,即不訂閱EventBus莉给,子類Activity/Fragment如果需要訂閱的話復(fù)寫這個方法并返回true即可。

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

/**
 * 是否注冊事件分發(fā)
 *
 * @return true綁定EventBus事件分發(fā)廉沮,默認不綁定颓遏,子類需要綁定的話復(fù)寫此方法返回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>指定事件通信過程中的數(shù)據(jù)類型,code為事件碼滞时,使用的時候給不同的事件類型指定不同的code叁幢。

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

/**
 * 是否注冊事件分發(fā)
 *
 * @return true綁定EventBus事件分發(fā),默認不綁定坪稽,子類需要綁定的話復(fù)寫此方法返回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);
    }
}

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

}

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

}

根據(jù)自己項目的需求曼玩,在訂閱了EventBusActivity/Fragment中復(fù)寫receiveEvent(Event event)receiveStickyEvent(Event event)來處理接收到事件后的邏輯。

這里也可以不用在BaseActivty/BaseFragment中添加接受事件的方法(因為添加了過后不能確定的子類的Event泛型)窒百。那么就直接在訂閱的Activity/Fragment中給接收事件的方法添加EventBus對應(yīng)的事件接受注解黍判,并指定參數(shù)Event的泛型。

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

在給定Eventcode的時候最好在常量池中定義一個類專門用來定義不同類型的EventBuscode篙梢,這樣在接收到EventBus的地方可以根據(jù)這些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中復(fù)寫isRegisterEventBus()并返回true注冊EventBus,復(fù)寫receiveEvent(Event event)接收發(fā)布的事件渤滞。

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

@Override
protected void receiveEvent(Event event) {
    // 接受到Event后的相關(guān)邏輯
    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)根據(jù)對應(yīng)的事件的code蔼水,判斷通信的數(shù)據(jù)來源和傳遞的數(shù)據(jù)類型震糖,以完成對應(yīng)的邏輯。

InfoActivity中發(fā)送事件趴腋,InfoActivity只發(fā)送不需要接收Event的話就不注冊吊说,也不用復(fù)寫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中只需要復(fù)寫isRegisterEventBus()receiveEvent(Event event)即可,不用每個地方都去訂閱和取消訂閱雅宾。并且給Event給定code和泛型能夠很好的區(qū)分不同的事件來源和數(shù)據(jù)類型养涮。


源碼:https://github.com/xiaoyanger0825/EventBusExample

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市眉抬,隨后出現(xiàn)的幾起案子贯吓,更是在濱河造成了極大的恐慌,老刑警劉巖蜀变,帶你破解...
    沈念sama閱讀 217,277評論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件悄谐,死亡現(xiàn)場離奇詭異,居然都是意外死亡库北,警方通過查閱死者的電腦和手機爬舰,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,689評論 3 393
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來寒瓦,“玉大人情屹,你說我怎么就攤上這事≡友” “怎么了垃你?”我有些...
    開封第一講書人閱讀 163,624評論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長喂很。 經(jīng)常有香客問我蜡镶,道長,這世上最難降的妖魔是什么恤筛? 我笑而不...
    開封第一講書人閱讀 58,356評論 1 293
  • 正文 為了忘掉前任官还,我火速辦了婚禮,結(jié)果婚禮上毒坛,老公的妹妹穿的比我還像新娘望伦。我一直安慰自己,他們只是感情好煎殷,可當(dāng)我...
    茶點故事閱讀 67,402評論 6 392
  • 文/花漫 我一把揭開白布屯伞。 她就那樣靜靜地躺著,像睡著了一般豪直。 火紅的嫁衣襯著肌膚如雪劣摇。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,292評論 1 301
  • 那天弓乙,我揣著相機與錄音末融,去河邊找鬼钧惧。 笑死,一個胖子當(dāng)著我的面吹牛勾习,可吹牛的內(nèi)容都是我干的浓瞪。 我是一名探鬼主播,決...
    沈念sama閱讀 40,135評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼巧婶,長吁一口氣:“原來是場噩夢啊……” “哼乾颁!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起艺栈,我...
    開封第一講書人閱讀 38,992評論 0 275
  • 序言:老撾萬榮一對情侶失蹤英岭,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后湿右,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體巴席,經(jīng)...
    沈念sama閱讀 45,429評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,636評論 3 334
  • 正文 我和宋清朗相戀三年诅需,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片荧库。...
    茶點故事閱讀 39,785評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡堰塌,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出分衫,到底是詐尸還是另有隱情场刑,我是刑警寧澤,帶...
    沈念sama閱讀 35,492評論 5 345
  • 正文 年R本政府宣布蚪战,位于F島的核電站牵现,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏邀桑。R本人自食惡果不足惜瞎疼,卻給世界環(huán)境...
    茶點故事閱讀 41,092評論 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望壁畸。 院中可真熱鬧贼急,春花似錦、人聲如沸捏萍。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,723評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽令杈。三九已至走敌,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間逗噩,已是汗流浹背掉丽。 一陣腳步聲響...
    開封第一講書人閱讀 32,858評論 1 269
  • 我被黑心中介騙來泰國打工跌榔, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人机打。 一個月前我還...
    沈念sama閱讀 47,891評論 2 370
  • 正文 我出身青樓矫户,卻偏偏與公主長得像,于是被迫代替她去往敵國和親残邀。 傳聞我的和親對象是個殘疾皇子皆辽,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,713評論 2 354

推薦閱讀更多精彩內(nèi)容

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,099評論 25 707
  • 先吐槽一下博客園的MarkDown編輯器,推出的時候還很高興博客園支持MarkDown了芥挣,試用了下發(fā)現(xiàn)支持不完善就...
    Ten_Minutes閱讀 562評論 0 2
  • 面試有一種技巧據(jù)說叫做反客為主驱闷,當(dāng)遇到Activity-Fragment通信,甚至模塊化開發(fā)時的通信問題等等空免,可以...
    TruthKeeper閱讀 541評論 0 6
  • 我們通過一個簡單的權(quán)限控制需求(RABC空另,Role-Based Access Control,基于角色的訪問控制)...
    開心跳蚤閱讀 3,097評論 0 13
  • 2004年蹋砚,我第一次來到深圳扼菠。 我是坐長途汽車去的,那時的汽車還是臥鋪坝咐,坐在車上循榆,就是睡覺。車上被子有一股怪味墨坚,但...
    亦農(nóng)閱讀 401評論 10 13