Android教程網 >> Android技術 >> 關於Android編程 >> android開源框架之EventBus

android開源框架之EventBus

編輯：關於Android編程

EventBus是個什麼東西？有什麼用？

EventBus是一個發布 / 訂閱的事件總線。簡單點說，就是兩人約定好怎麼通信，一人發布消息，另外一個約定好的人立馬接收到你發的消息。

用處：相信大家都用過Handle了進行線程通信，回調方法進行通信，是不是覺得特麻煩。EventBus就可以幫減少很多事，不管你在任何地方任何位置發布一個事件，接收者都能立馬接收到你的消息，不用你考慮android子線程操作UI線程的問題！！！！而且還有個好處，就這這個框架很容易上手！！！

項目地址：

關系：

data-cke-saved-src=https://www.android5.online/Android/UploadFiles_5356/201702/2017022316034054.png

訂閱者可以訂閱多個事件，發送者可以發布任何事件，發布者同時也可以是訂閱者。

具體使用：

訂閱者相關：

注冊訂閱者： EventBus.getDefault().register(this);

這個方法通常在onCreate方法中進行注冊。

解綁訂閱者： EventBus.getDefault().unregister(this);

這個方法通常在onDestroy方法中進行解綁。

約定的收到事件要執行的方法：EventBus已經規定好了使用如下四個方法：

onEvent:如果使用onEvent作為訂閱函數，那麼該事件在哪個線程發布出來的，onEvent就會在這個線程中運行，也就是說發布事件和接收事件線程在同一個線程。使用這個方法時，在onEvent方法中不能執行耗時操作，如果執行耗時操作容易導致事件分發延遲。
onEventMainThread:如果使用onEventMainThread作為訂閱函數，那麼不論事件是在哪個線程中發布出來的，onEventMainThread都會在UI線程中執行，接收事件就會在UI線程中運行，這個在Android中是非常有用的，因為在Android中只能在UI線程中跟新UI，所以在onEvnetMainThread方法中是不能執行耗時操作的。
onEventBackground:如果使用onEventBackgrond作為訂閱函數，那麼如果事件是在UI線程中發布出來的，那麼onEventBackground就會在子線程中運行，如果事件本來就是子線程中發布出來的，那麼onEventBackground函數直接在該子線程中執行。
onEventAsync：使用這個函數作為訂閱函數，那麼無論事件在哪個線程發布，都會創建新的子線程在執行onEventAsync.

例子： public void onEvent(Object object){
Log.e(hongliang,onEvent);
}

當訂閱者收到事件後，就會自動執行上面這四個方法，根據需求寫某個方法就可以了，如果寫了多個，則都會執行。

或許，你會問，要是多個類都是訂閱者，那到底是誰收到事件呢？

EventBus是根據這四個方法的參數來決定哪個類接收事件的，發布者的參數和某個訂閱者這四個方法的參數一樣，則執行這個訂閱者的這個方法。

發布者相關：

發布事件： EventBus.getDefault().post( new 一個你自己的事件 );

可以在任意位置發布。

注意post方法的參數：EventBus會根據這個參數去找訂閱者那四個方法參數和它一致的執行。

例如：

發布者：EventBus.getDefault().post( new String(發布者) );

訂閱者：public void onEvent(String str){
Log.e(hongliang,str);
}

因為post的參數是String ，四個方法中onEvent參數String，所以會這個方法會被執行。

還不明白的可以參考：

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

[java] view plaincopy

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);
}
}
[html] view plaincopy
1. xmlns:tools=http://schemas.android.com/tools
2. android:layout_width=match_parent
3. android:layout_height=match_parent
4. android:baselineAligned=false
5. android:divider=?android:attr/dividerHorizontal
6. android:orientation=horizontal
7. android:showDividers=middle >
9. android:id=@+id/item_list
10. android:name=com.angeldevil.eventbusdemo.ItemListFragment
11. android:layout_width=0dip
12. android:layout_height=match_parent
13. android:layout_weight=1 />
15. android:id=@+id/item_detail_container
16. android:name=com.angeldevil.eventbusdemo.ItemDetailFragment
17. android:layout_width=0dip
18. android:layout_height=match_parent
19. android:layout_weight=2 />
21. 可以看到，我們MainActvity可以說沒有一行代碼，布局文件即兩個Fragment組成；
  
  2、ItemListFragment
  
  首先看個實體類：
  
  [java] view plaincopy
  1. package com.angeldevil.eventbusdemo;
  3. import java.util.ArrayList;
  4. import java.util.List;
  6. public class Item
  7. {
  8. public String id;
  9. public String content;
  11. public static List ITEMS = new ArrayList();
  12. static
  13. {
  14. // Add 6 sample items.
  15. addItem(new Item(1, Item 1));
  16. addItem(new Item(2, Item 2));
  17. addItem(new Item(3, Item 3));
  18. addItem(new Item(4, Item 4));
  19. addItem(new Item(5, Item 5));
  20. addItem(new Item(6, Item 6));
  21. }
  23. private static void addItem(Item item)
  24. {
  25. ITEMS.add(item);
  26. }
  28. public Item(String id, String content)
  29. {
  30. this.id = id;
  31. this.content = content;
  32. }
  34. @Override
  35. public String toString()
  36. {
  37. return content;
  38. }
  39. }
    
    [java] view plaincopy
    1. package com.angeldevil.eventbusdemo;
    3. import android.os.Bundle;
    4. import android.support.v4.app.ListFragment;
    5. import android.view.View;
    6. import android.widget.ArrayAdapter;
    7. import android.widget.ListView;
    9. import com.angeldevil.eventbusdemo.Event.ItemListEvent;
    11. import de.greenrobot.event.EventBus;
    13. public class ItemListFragment extends ListFragment
    14. {
    16. @Override
    17. public void onCreate(Bundle savedInstanceState)
    18. {
    19. super.onCreate(savedInstanceState);
    20. // Register
    21. EventBus.getDefault().register(this);
    22. }
    24. @Override
    25. public void onDestroy()
    26. {
    27. super.onDestroy();
    28. // Unregister
    29. EventBus.getDefault().unregister(this);
    30. }
    32. @Override
    33. public void onViewCreated(View view, Bundle savedInstanceState)
    34. {
    35. super.onViewCreated(view, savedInstanceState);
    36. // 開啟線程加載列表
    37. new Thread()
    38. {
    39. public void run()
    40. {
    41. try
    42. {
    43. Thread.sleep(2000); // 模擬延時
    44. // 發布事件，在後台線程發的事件
    45. EventBus.getDefault().post(new ItemListEvent(Item.ITEMS));
    46. } catch (InterruptedException e)
    47. {
    48. e.printStackTrace();
    49. }
    50. };
    51. }.start();
    52. }
    54. public void onEventMainThread(ItemListEvent event)
    55. {
    56. setListAdapter(new ArrayAdapter(getActivity(),
    57. android.R.layout.simple_list_item_activated_1,
    58. android.R.id.text1, event.getItems()));
    59. }
    61. @Override
    62. public void onListItemClick(ListView listView, View view, int position,
    63. long id)
    64. {
    65. super.onListItemClick(listView, view, position, id);
    66. EventBus.getDefault().post(getListView().getItemAtPosition(position));
    67. }
    69. }
      
      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(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
      
      [java] view plaincopy
      1. package com.angeldevil.eventbusdemo;
      3. import android.os.Bundle;
      4. import android.support.v4.app.Fragment;
      5. import android.view.LayoutInflater;
      6. import android.view.View;
      7. import android.view.ViewGroup;
      8. import android.widget.TextView;
      9. import de.greenrobot.event.EventBus;
      11. public class ItemDetailFragment extends Fragment
      12. {
      14. private TextView tvDetail;
      16. @Override
      17. public void onCreate(Bundle savedInstanceState)
      18. {
      19. super.onCreate(savedInstanceState);
      20. // register
      21. EventBus.getDefault().register(this);
      22. }
      24. @Override
      25. public void onDestroy()
      26. {
      27. super.onDestroy();
      28. // Unregister
      29. EventBus.getDefault().unregister(this);
      30. }
      32. /** List點擊時會發送些事件，接收到事件後更新詳情 */
      33. public void onEventMainThread(Item item)
      34. {
      35. if (item != null)
      36. tvDetail.setText(item.content);
      37. }
      39. @Override
      40. public View onCreateView(LayoutInflater inflater, ViewGroup container,
      41. Bundle savedInstanceState)
      42. {
      43. View rootView = inflater.inflate(R.layout.fragment_item_detail,
      44. container, false);
      45. tvDetail = (TextView) rootView.findViewById(R.id.item_detail);
      46. return rootView;
      47. }
      48. }
        果然不出我們的所料，真的存在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
        
        這裡還有個事件類：
        
        [java] view plaincopy
        
        package com.angeldevil.eventbusdemo;
        
        import java.util.List;
        
        public class Event
        
        {
        
        /** 列表加載事件 */
        
        public static class ItemListEvent
        
        {
        
        private List items;
        
        public ItemListEvent(List items)
        
        {
        
        this.items = items;
        
        }
        
        public List 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，相信可以為你解除很多困惑，了解該框架的設計之美。

上一頁:Android Studio導入GitHub上的項目常見問題(以圖片輪播開源項目為實例)
下一頁:Android WebView簡單應用

關於Android編程

Android編程入門 Android技術基礎 Android資訊關於Android編程 Android開發 Android開發環境 Android開發實例

相關文章

android開源框架之EventBus

1、概述

2、代碼是最好的老師

1、MainActivity及其布局

2、ItemListFragment

3、ItemDetailFragment

4、Event

3、EventBus的ThreadMode

4、題外話