Android EventBus實戰 沒聽過你就out了

轉載請表明出處：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及其佈局

package com.angeldevil.eventbusdemo;

import android.os.Bundle;
import android.support.v4.app.FragmentActivity;

public class MainActivity extends FragmentActivity
{
    @Override
    protected void onCreate(Bundle savedInstanceState)
    {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
    }

}

<LinearLayout xmlns: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;

public class Item
{
    public String id;
    public String content;

    public static 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"));
    }

    private static void 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;

public class ItemListFragment extends ListFragment
{

    @Override
    public void onCreate(Bundle savedInstanceState)
    {
        super.onCreate(savedInstanceState);
        // Register
        EventBus.getDefault().register(this);
    }

    @Override
    public void onDestroy()
    {
        super.onDestroy();
        // Unregister
        EventBus.getDefault().unregister(this);
    }

    @Override
    public void onViewCreated(View view, Bundle savedInstanceState)
    {
        super.onViewCreated(view, savedInstanceState);
        // 開啓線程加載列表
        new Thread()
        {
            public void run()
            {
                try
                {
                    Thread.sleep(2000); // 模擬延時
                    // 發佈事件，在後臺線程發的事件
                    EventBus.getDefault().post(new ItemListEvent(Item.ITEMS));
                } catch (InterruptedException e)
                {
                    e.printStackTrace();
                }
            };
        }.start();
    }

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

    @Override
    public void 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;

public class ItemDetailFragment extends Fragment
{

    private TextView tvDetail;

    @Override
    public void onCreate(Bundle savedInstanceState)
    {
        super.onCreate(savedInstanceState);
        // register
        EventBus.getDefault().register(this);
    }

    @Override
    public void onDestroy()
    {
        super.onDestroy();
        // Unregister
        EventBus.getDefault().unregister(this);
    }

    /** List點擊時會發送些事件，接收到事件後更新詳情 */
    public void 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;

public class Event
{
    /** 列表加載事件 */
    public static class ItemListEvent
    {
        private List<Item> items;

        public ItemListEvent(List<Item> items)
        {
            this.items = items;
        }

        public List<Item> getItems()
        {
            return items;
        }
    }

}

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，不直觀。

如果你希望深入理解Eventbus，請看：Android EventBus源碼解析 帶你深入理解EventBus，相信可以爲你解除很多困惑，瞭解該框架的設計之美。

源碼點擊下載