1. 程式人生 > >Android EventBus使用詳解

Android EventBus使用詳解

目錄(?)[+]

轉載請表明出處:http://blog.csdn.net/lmj623565791/article/details/40794879,本文出自:【張鴻洋的部落格】

1、概述

最近大家面試說經常被問到EventBus,github上果斷down了一份,地址:https://github.com/greenrobot/EventBus,的確是個不錯的框架,主要用於事件的釋出和訂閱。

EventBus定義:是一個釋出 / 訂閱的事件匯流排。

這麼說應該包含4個成分:釋出者,訂閱者,事件,匯流排。

那麼這四者的關係是什麼呢?

很明顯:訂閱者訂閱事件到匯流排,傳送者釋出事件。

大體應該是這樣的關係:


訂閱者可以訂閱多個事件,傳送者可以釋出任何事件,釋出者同時也可以是訂閱者。

好了,大體瞭解基本的關係以後,我們通過案例驅動來教大家如何使用;

2、程式碼是最好的老師

相信大家對Fragment都有所瞭解,現在我們的需求是這樣的,兩個Fragment組成主介面,左邊的Fragment是個目錄、即列表,右邊的Fragment是詳細資訊面板;

a、目錄的列表是從網路獲取的。

b、當點選目錄上的條目時,動態更新詳細資訊面板;

效果圖:


看了這個需求,我們傳統的做法是:

a、目錄Fragment在onCreate中去開啟執行緒去訪問網路獲取資料,獲取完成以後,通過handler去更新介面。

b、在目錄的Fragment中提供一個介面,然後詳細資訊面板去註冊這個介面,當發生點選時,去回撥這個介面,讓詳細資訊面板發生改變。

其實這種做法也還是不錯的,但是有了EventBus之後,我們互動會發生什麼樣的變化呢?拭目以待吧。

首先提一下:

EventBus.getDefault().register(this);//訂閱事件

EventBus.getDefault().post(object);//釋出事件

EventBus.getDefault().unregister(this);//取消訂閱

1、MainActivity及其佈局

  1. package com.angeldevil.eventbusdemo;  
  2. import android.os.Bundle;  
  3. import android.support.v4.app.FragmentActivity;  
  4. publicclass MainActivity extends FragmentActivity  
  5. {  
  6.     @Override
  7.     protectedvoid onCreate(Bundle savedInstanceState)  
  8.     {  
  9.         super.onCreate(savedInstanceState);  
  10.         setContentView(R.layout.activity_main);  
  11.     }  
  12. }  

  1. <LinearLayoutxmlns:android="http://schemas.android.com/apk/res/android"
  2.     xmlns:tools="http://schemas.android.com/tools"
  3.     android:layout_width="match_parent"
  4.     android:layout_height="match_parent"
  5.     android:baselineAligned="false"
  6.     android:divider="?android:attr/dividerHorizontal"
  7.     android:orientation="horizontal"
  8.     android:showDividers="middle">
  9.     <fragment
  10.         android:id="@+id/item_list"
  11.         android:name="com.angeldevil.eventbusdemo.ItemListFragment"
  12.         android:layout_width="0dip"
  13.         android:layout_height="match_parent"
  14.         android:layout_weight="1"/>
  15.     <fragment
  16.         android:id="@+id/item_detail_container"
  17.         android:name="com.angeldevil.eventbusdemo.ItemDetailFragment"
  18.         android:layout_width="0dip"
  19.         android:layout_height="match_parent"
  20.         android:layout_weight="2"/>
  21. </LinearLayout>

可以看到,我們MainActvity可以說沒有一行程式碼,佈局檔案即兩個Fragment組成;

2、ItemListFragment

首先看個實體類:

  1. package com.angeldevil.eventbusdemo;  
  2. import java.util.ArrayList;  
  3. import java.util.List;  
  4. publicclass Item  
  5. {  
  6.     public String id;  
  7.     public String content;  
  8.     publicstatic List<Item> ITEMS = new ArrayList<Item>();  
  9.     static
  10.     {  
  11.         // Add 6 sample items.
  12.         addItem(new Item("1""Item 1"));  
  13.         addItem(new Item("2""Item 2"));  
  14.         addItem(new Item("3""Item 3"));  
  15.         addItem(new Item("4""Item 4"));  
  16.         addItem(new Item("5""Item 5"));  
  17.         addItem(new Item("6""Item 6"));  
  18.     }  
  19.     privatestaticvoid addItem(Item item)  
  20.     {  
  21.         ITEMS.add(item);  
  22.     }  
  23.     public Item(String id, String content)  
  24.     {  
  25.         this.id = id;  
  26.         this.content = content;  
  27.     }  
  28.     @Override
  29.     public String toString()  
  30.     {  
  31.         return content;  
  32.     }  
  33. }  
  1. package com.angeldevil.eventbusdemo;  
  2. import android.os.Bundle;  
  3. import android.support.v4.app.ListFragment;  
  4. import android.view.View;  
  5. import android.widget.ArrayAdapter;  
  6. import android.widget.ListView;  
  7. import com.angeldevil.eventbusdemo.Event.ItemListEvent;  
  8. import de.greenrobot.event.EventBus;  
  9. publicclass ItemListFragment extends ListFragment  
  10. {  
  11.     @Override
  12.     publicvoid onCreate(Bundle savedInstanceState)  
  13.     {  
  14.         super.onCreate(savedInstanceState);  
  15.         // Register
  16.         EventBus.getDefault().register(this);  
  17.     }  
  18.     @Override
  19.     publicvoid onDestroy()  
  20.     {  
  21.         super.onDestroy();  
  22.         // Unregister
  23.         EventBus.getDefault().unregister(this);  
  24.     }  
  25.     @Override
  26.     publicvoid onViewCreated(View view, Bundle savedInstanceState)  
  27.     {  
  28.         super.onViewCreated(view, savedInstanceState);  
  29.         // 開啟執行緒載入列表
  30.         new Thread()  
  31.         {  
  32.             publicvoid run()  
  33.             {  
  34.                 try
  35.                 {  
  36.                     Thread.sleep(2000); // 模擬延時
  37.                     // 釋出事件,在後臺執行緒發的事件
  38.                     EventBus.getDefault().post(new ItemListEvent(Item.ITEMS));  
  39.                 } catch (InterruptedException e)  
  40.                 {  
  41.                     e.printStackTrace();  
  42.                 }  
  43.             };  
  44.         }.start();  
  45.     }  
  46.     publicvoid onEventMainThread(ItemListEvent event)  
  47.     {  
  48.         setListAdapter(new ArrayAdapter<Item>(getActivity(),  
  49.                 android.R.layout.simple_list_item_activated_1,  
  50.                 android.R.id.text1, event.getItems()));  
  51.     }  
  52.     @Override
  53.     publicvoid onListItemClick(ListView listView, View view, int position,  
  54.             long id)  
  55.     {  
  56.         super.onListItemClick(listView, view, position, id);  
  57.         EventBus.getDefault().post(getListView().getItemAtPosition(position));  
  58.     }  
  59. }  

ItemListFragment裡面在onCreate裡面進行了事件的訂閱,onDestroy裡面進行了事件的取消;onViewCreated中我們模擬了一個子執行緒去網路載入資料,獲取成功後我們呼叫

了EventBus.getDefault().post(new ItemListEvent(Item.ITEMS));釋出了一個事件;

onListItemClick則是ListView的點選事件,我們呼叫了EventBus.getDefault().post(getListView().getItemAtPosition(position));去釋出一個事件,

getListView().getItemAtPosition(position)的型別為Item型別;

細心的你一定發現了一些詭異的事,直接new Thread()獲取到資料以後,竟然沒有使用handler;我們介面竟然發生了變化,那麼List是何時繫結的資料?

仔細看下程式碼,發現這個方法:

public void onEventMainThread(ItemListEvent event)
{
setListAdapter(new ArrayAdapter<Item>(getActivity(),
Android.R.layout.simple_list_item_activated_1,
android.R.id.text1, event.getItems()));
}

應該是這個方法為List繫結的資料。那麼這個方法是怎麼被呼叫的呢?

現在就可以細談訂閱事件與釋出事件了:

如果方法名以onEvent開頭,則代表要訂閱一個事件,MainThread意思,這個方法最終要在UI執行緒執行;當事件釋出的時候,這個方法就會被執行。

那麼這個事件什麼時候釋出呢?

我們的onEventMainThread觸發時機應該在new Thread()執行完成之後,可以看到子執行緒執行完成之後,執行了EventBus.getDefault().post(new ItemListEvent(Item.ITEMS));

意味著釋出了一個事件,當這個事件釋出,我們的onEventMainThread就執行了,那麼二者的關聯關係是什麼呢?

其實和引數的型別,我們onEventMainThread需要接收一個ItemListEvent ,我們也釋出了一個ItemListEvent的例項。

現在我們完整的理一下:

在onCreate裡面執行EventBus.getDefault().register(this);意思是讓EventBus掃描當前類,把所有onEvent開頭的方法記錄下來,如何記錄呢?使用Map,Key為方法的引數型別,Value中包含我們的方法。

這樣在onCreate執行完成以後,我們的onEventMainThread就已經以鍵值對的方式被儲存到EventBus中了。

然後當子執行緒執行完畢,呼叫EventBus.getDefault().post(new ItemListEvent(Item.ITEMS))時,EventBus會根據post中實參的型別,去Map中查詢對於的方法,於是找到了我們的onEventMainThread,最終呼叫反射去執行我們的方法。

現在應該明白了,整個執行的流程了;那麼沒有介面卻能發生回撥應該也能解釋了。

現在我們在看看程式碼,當Item點選的時候EventBus.getDefault().post(getListView().getItemAtPosition(position));我們同樣釋出了一個事件,引數為Item;這個事件是為了讓詳細資訊的Fragment去更新資料,不用說,按照上面的推測,詳細資訊的Fragment裡面一個有個這樣的方法:public void onEventMainThread(Item item) ; 是不是呢?我們去看看。

3、ItemDetailFragment

  1. package com.angeldevil.eventbusdemo;  
  2. import android.os.Bundle;  
  3. import android.support.v4.app.Fragment;  
  4. import android.view.LayoutInflater;  
  5. import android.view.View;  
  6. import android.view.ViewGroup;  
  7. import android.widget.TextView;  
  8. import de.greenrobot.event.EventBus;  
  9. publicclass ItemDetailFragment extends Fragment  
  10. {  
  11.     private TextView tvDetail;  
  12.     @Override
  13.     publicvoid onCreate(Bundle savedInstanceState)  
  14.     {  
  15.         super.onCreate(savedInstanceState);  
  16.         // register
  17.         EventBus.getDefault().register(this);  
  18.     }  
  19.     @Override
  20.     publicvoid onDestroy()  
  21.     {  
  22.         super.onDestroy();  
  23.         // Unregister
  24.         EventBus.getDefault().unregister(this);  
  25.     }  
  26.     /** List點選時會發送些事件,接收到事件後更新詳情 */
  27.     publicvoid onEventMainThread(Item item)  
  28.     {  
  29.         if (item != null)  
  30.             tvDetail.setText(item.content);  
  31.     }  
  32.     @Override
  33.     public View onCreateView(LayoutInflater inflater, ViewGroup container,  
  34.             Bundle savedInstanceState)  
  35.     {  
  36.         View rootView = inflater.inflate(R.layout.fragment_item_detail,  
  37.                 container, false);  
  38.         tvDetail = (TextView) rootView.findViewById(R.id.item_detail);  
  39.         return rootView;  
  40.     }  
  41. }  

果然不出我們的所料,真的存在onEventMainThread(Item item)的方法。當然了,必須在onCreate裡面首先書寫EventBus.getDefault().register(this);讓EventBus掃描再說。

那麼這個Fragment的流程就是:onCreate時,EventBus掃描當前類,將onEventMainThread以鍵值對的形式進行儲存,鍵為Item.class ,值為包含該方法的物件。

然後當ItemListFragment中Item被點選時,釋出了一個事件:EventBus.getDefault().post(getListView().getItemAtPosition(position));實參的型別恰好是Item,於是觸發我們的

onEventMainThread方法,並把Item實參傳遞進來,我們更新控制元件。

4、Event

這裡還有個事件類:

  1. package com.angeldevil.eventbusdemo;  
  2. import java.util.List;  
  3. publicclass Event  
  4. {  
  5.     /** 列表載入事件 */
  6.     publicstaticclass ItemListEvent  
  7.     {  
  8.         private List<Item> items;  
  9.         public ItemListEvent(List<Item> items)  
  10.         {  
  11.             this.items = items;  
  12.         }  
  13.         public List<Item> getItems()  
  14.         {  
  15.             return items;  
  16.         }  
  17.     }  
  18. }  
ItemListEvent我們在ItemListFragment中使用的,作為的是onEventMainThread中的引數。為什麼封裝這麼個類呢?會在之後的EventBus原始碼解析中說明。

到此我們的EventBus的初步用法就介紹完畢了。縱觀整個程式碼,木有handler、木有AsynTask,木有介面回撥;but,我們像魔術般的實現了我們的需求;來告訴我,什麼是耦合,沒見到~~~

3、EventBus的ThreadMode

EventBus包含4個ThreadMode:PostThread,MainThread,BackgroundThread,Async

MainThread我們已經不陌生了;我們已經使用過。

具體的用法,極其簡單,方法名為:onEventPostThread, onEventMainThread,onEventBackgroundThread,onEventAsync即可

具體什麼區別呢?

onEventMainThread代表這個方法會在UI執行緒執行

onEventPostThread代表這個方法會在當前釋出事件的執行緒執行

BackgroundThread這個方法,如果在非UI執行緒釋出的事件,則直接執行,和釋出在同一個執行緒中。如果在UI執行緒釋出的事件,則加入後臺任務佇列,使用執行緒池一個接一個呼叫。

Async 加入後臺任務佇列,使用執行緒池呼叫,注意沒有BackgroundThread中的一個接一個。

4、題外話

大家可以利用EventBus嘗試做以下操作:

當接收到某個廣播,例如簡訊,在介面上顯示。

開啟一個Service,在伺服器裡面啟動一個定時執行緒,不斷更新ActivityUI。

等等...之後,你會發現EventBus的魅力!

宣告一下:上面兩個Fragment的例子是我在網上down到的,做了簡單的修改,雖然很簡單,但是很能說明問題。看包名應該是angeldevil寫的,在此表示感謝。

順便吐槽一個官方給的例子,什麼效能對比,然後一堆TestCase,不直觀。