Android EventBus使用詳解
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及其佈局
- package com.angeldevil.eventbusdemo;
- import android.os.Bundle;
- import android.support.v4.app.FragmentActivity;
- publicclass MainActivity extends FragmentActivity
- {
- @Override
- protectedvoid onCreate(Bundle savedInstanceState)
- {
- super.onCreate(savedInstanceState);
- setContentView(R.layout.activity_main);
- }
- }
- <LinearLayoutxmlns:android="http://schemas.android.com/apk/res/android"
- xmlns:tools="http://schemas.android.com/tools"
- android:layout_width="match_parent"
- android:layout_height="match_parent"
- android:baselineAligned="false"
- android:divider="?android:attr/dividerHorizontal"
- android:orientation="horizontal"
- android:showDividers="middle">
- <fragment
- android:id="@+id/item_list"
- android:name="com.angeldevil.eventbusdemo.ItemListFragment"
- android:layout_width="0dip"
- android:layout_height="match_parent"
- android:layout_weight="1"/>
- <fragment
- android:id="@+id/item_detail_container"
- android:name="com.angeldevil.eventbusdemo.ItemDetailFragment"
- android:layout_width="0dip"
- android:layout_height="match_parent"
- android:layout_weight="2"/>
- </LinearLayout>
可以看到,我們MainActvity可以說沒有一行程式碼,佈局檔案即兩個Fragment組成;
2、ItemListFragment
首先看個實體類:
- package com.angeldevil.eventbusdemo;
- import java.util.ArrayList;
- import java.util.List;
- publicclass Item
- {
- public String id;
- public String content;
- publicstatic List<Item> ITEMS = new ArrayList<Item>();
- static
- {
- // Add 6 sample items.
- addItem(new Item("1", "Item 1"));
- addItem(new Item("2", "Item 2"));
- addItem(new Item("3", "Item 3"));
- addItem(new Item("4", "Item 4"));
- addItem(new Item("5", "Item 5"));
- addItem(new Item("6", "Item 6"));
- }
- privatestaticvoid addItem(Item item)
- {
- ITEMS.add(item);
- }
- public Item(String id, String content)
- {
- this.id = id;
- this.content = content;
- }
- @Override
- public String toString()
- {
- return content;
- }
- }
- package com.angeldevil.eventbusdemo;
- import android.os.Bundle;
- import android.support.v4.app.ListFragment;
- import android.view.View;
- import android.widget.ArrayAdapter;
- import android.widget.ListView;
- import com.angeldevil.eventbusdemo.Event.ItemListEvent;
- import de.greenrobot.event.EventBus;
- publicclass ItemListFragment extends ListFragment
- {
- @Override
- publicvoid onCreate(Bundle savedInstanceState)
- {
- super.onCreate(savedInstanceState);
- // Register
- EventBus.getDefault().register(this);
- }
- @Override
- publicvoid onDestroy()
- {
- super.onDestroy();
- // Unregister
- EventBus.getDefault().unregister(this);
- }
- @Override
- publicvoid onViewCreated(View view, Bundle savedInstanceState)
- {
- super.onViewCreated(view, savedInstanceState);
- // 開啟執行緒載入列表
- new Thread()
- {
- publicvoid run()
- {
- try
- {
- Thread.sleep(2000); // 模擬延時
- // 釋出事件,在後臺執行緒發的事件
- EventBus.getDefault().post(new ItemListEvent(Item.ITEMS));
- } catch (InterruptedException e)
- {
- e.printStackTrace();
- }
- };
- }.start();
- }
- publicvoid onEventMainThread(ItemListEvent event)
- {
- setListAdapter(new ArrayAdapter<Item>(getActivity(),
- android.R.layout.simple_list_item_activated_1,
- android.R.id.text1, event.getItems()));
- }
- @Override
- publicvoid onListItemClick(ListView listView, View view, int position,
- long id)
- {
- super.onListItemClick(listView, view, position, id);
- EventBus.getDefault().post(getListView().getItemAtPosition(position));
- }
- }
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
- package com.angeldevil.eventbusdemo;
- import android.os.Bundle;
- import android.support.v4.app.Fragment;
- import android.view.LayoutInflater;
- import android.view.View;
- import android.view.ViewGroup;
- import android.widget.TextView;
- import de.greenrobot.event.EventBus;
- publicclass ItemDetailFragment extends Fragment
- {
- private TextView tvDetail;
- @Override
- publicvoid onCreate(Bundle savedInstanceState)
- {
- super.onCreate(savedInstanceState);
- // register
- EventBus.getDefault().register(this);
- }
- @Override
- publicvoid onDestroy()
- {
- super.onDestroy();
- // Unregister
- EventBus.getDefault().unregister(this);
- }
- /** List點選時會發送些事件,接收到事件後更新詳情 */
- publicvoid onEventMainThread(Item item)
- {
- if (item != null)
- tvDetail.setText(item.content);
- }
- @Override
- public View onCreateView(LayoutInflater inflater, ViewGroup container,
- Bundle savedInstanceState)
- {
- View rootView = inflater.inflate(R.layout.fragment_item_detail,
- container, false);
- tvDetail = (TextView) rootView.findViewById(R.id.item_detail);
- return rootView;
- }
- }
果然不出我們的所料,真的存在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
這裡還有個事件類:
- package com.angeldevil.eventbusdemo;
- import java.util.List;
- publicclass Event
- {
- /** 列表載入事件 */
- publicstaticclass ItemListEvent
- {
- private List<Item> items;
- public ItemListEvent(List<Item> items)
- {
- this.items = items;
- }
- public List<Item> getItems()
- {
- return items;
- }
- }
- }
到此我們的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,不直觀。