【转】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       
 3     import android.os.Bundle;  
 4     import android.support.v4.app.FragmentActivity;  
 5       
 6     public class MainActivity extends FragmentActivity  
 7     {  
 8         @Override  
 9         protected void onCreate(Bundle savedInstanceState)  
10         {  
11             super.onCreate(savedInstanceState);  
12             setContentView(R.layout.activity_main);  
13         }  
14       
15     }  
 1 <LinearLayout xmlns: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   
10     <fragment  
11         android:id="@+id/item_list"  
12         android:name="com.angeldevil.eventbusdemo.ItemListFragment"  
13         android:layout_width="0dip"  
14         android:layout_height="match_parent"  
15         android:layout_weight="1" />  
16   
17     <fragment  
18         android:id="@+id/item_detail_container"  
19         android:name="com.angeldevil.eventbusdemo.ItemDetailFragment"  
20         android:layout_width="0dip"  
21         android:layout_height="match_parent"  
22         android:layout_weight="2" />  
23   
24 </LinearLayout>

可以看到,我们MainActvity可以说没有一行代码,布局文件即两个Fragment组成;

2、ItemListFragment

首先看个实体类:

  

 1     package com.angeldevil.eventbusdemo;  
 2       
 3     import java.util.ArrayList;  
 4     import java.util.List;  
 5       
 6     public class Item  
 7     {  
 8         public String id;  
 9         public String content;  
10       
11         public static List<Item> ITEMS = new ArrayList<Item>();  
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         }  
22       
23         private static void addItem(Item item)  
24         {  
25             ITEMS.add(item);  
26         }  
27       
28         public Item(String id, String content)  
29         {  
30             this.id = id;  
31             this.content = content;  
32         }  
33       
34         @Override  
35         public String toString()  
36         {  
37             return content;  
38         }  
39     }  
 1     package com.angeldevil.eventbusdemo;  
 2       
 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;  
 8       
 9     import com.angeldevil.eventbusdemo.Event.ItemListEvent;  
10       
11     import de.greenrobot.event.EventBus;  
12       
13     public class ItemListFragment extends ListFragment  
14     {  
15       
16         @Override  
17         public void onCreate(Bundle savedInstanceState)  
18         {  
19             super.onCreate(savedInstanceState);  
20             // Register  
21             EventBus.getDefault().register(this);  
22         }  
23       
24         @Override  
25         public void onDestroy()  
26         {  
27             super.onDestroy();  
28             // Unregister  
29             EventBus.getDefault().unregister(this);  
30         }  
31       
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         }  
53       
54         public void onEventMainThread(ItemListEvent event)  
55         {  
56             setListAdapter(new ArrayAdapter<Item>(getActivity(),  
57                     android.R.layout.simple_list_item_activated_1,  
58                     android.R.id.text1, event.getItems()));  
59         }  
60       
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         }  
68       
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是何时绑定的数据?

仔细看下代码,发现这个方法:

1 public void onEventMainThread(ItemListEvent event)
2     {        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       
 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;  
10       
11     public class ItemDetailFragment extends Fragment  
12     {  
13       
14         private TextView tvDetail;  
15       
16         @Override  
17         public void onCreate(Bundle savedInstanceState)  
18         {  
19             super.onCreate(savedInstanceState);  
20             // register  
21             EventBus.getDefault().register(this);  
22         }  
23       
24         @Override  
25         public void onDestroy()  
26         {  
27             super.onDestroy();  
28             // Unregister  
29             EventBus.getDefault().unregister(this);  
30         }  
31       
32         /** List点击时会发送些事件,接收到事件后更新详情 */  
33         public void onEventMainThread(Item item)  
34         {  
35             if (item != null)  
36                 tvDetail.setText(item.content);  
37         }  
38       
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

这里还有个事件类:

 1     package com.angeldevil.eventbusdemo;  
 2       
 3     import java.util.List;  
 4       
 5     public class Event  
 6     {  
 7         /** 列表加载事件 */  
 8         public static class ItemListEvent  
 9         {  
10             private List<Item> items;  
11       
12             public ItemListEvent(List<Item> items)  
13             {  
14                 this.items = items;  
15             }  
16       
17             public List<Item> getItems()  
18             {  
19                 return items;  
20             }  
21         }  
22       
23     }  

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,相信可以为你解除很多困惑,了解该框架的设计之美。

 

源码点击下载

posted @ 2015-04-14 16:42  perfect亮  阅读(283)  评论(0编辑  收藏  举报