EventBus的使用和原理剖析

时间 2014-07-27 17:59:57 CSDN博客
原文 http://blog.csdn.net/yuanzeyao/article/details/38174537
主题 EventBus
尊重原创： http://blog.csdn.net/yuanzeyao/article/details/38174537
代码下载： http://download.csdn.net/detail/yuanzeyao2008/7684041
在编程过程中，当我们想通知其他组件某些事情发生时，我们通常使用观察者模式，正式因为观察者模式非常常见，所以在jdk1.5中已经帮助我们实现了观察者模式，我们只需要简单的继承一些类就可以快速使用观察者模式，在Android中也有一个类似功能的开源库EventBus，可以很方便的帮助我们实现观察者模式，那么我们就开始学习如何使用EventBus.
在接下来的内容中，我首先会介绍如何使用EventBus,然后再简单的学习一下EventBus的底层实现原理，因为仅仅学习如何使用总是感觉内心不够踏实，万一哪天出了Bug也无从下手，了解了它的基本实现后，就会用得游刃有余。好了 废话不多说，下面开始学习吧
1、下载EventBus库：
EvnetBus的下载地址：https://github.com/greenrobot/EventBus.git
2、将EventBus.jar放入自己工程的libs目录即可
3、定义一个事件，这个事件一旦被EventBus分发出去就是代表某一件事情发生了，这个事件就是某个观察者关心的事情(不需要继承任何类)
4、定义观察者，然后将该观察者注册到EventBus
5、由EventBus分发事件，告知观察者某一件事情发生了
6、使用完成后从EventBus中反注册观察者。
熟悉观察者模式的朋友肯定对于上面的流程非常熟悉，其实和观察模式基本是一样的。但是也是有区别的。在观察者模式中，所有的观察者都需要实现一个接口，这个接口有一个统一的方法如:
public void onUpdate()；
然后当某一个事件发生时，某个对象会调用观察者的onUpdate方法通知观察者某件事情发生了，但是在EventBus中不需要这样，EventBus中是这样实现的：
在EventBus中的观察者通常有四种订阅函数（就是某件事情发生被调用的方法）
1、onEvent
2、onEventMainThread
3、onEventBackground
4、onEventAsync
这四种订阅函数都是使用onEvent开头的，它们的功能稍有不同,在介绍不同之前先介绍两个概念：
告知观察者事件发生时通过EventBus.post函数实现，这个过程叫做事件的发布，观察者被告知事件发生叫做事件的接收，是通过下面的订阅函数实现的。
onEvent:如果使用onEvent作为订阅函数，那么该事件在哪个线程发布出来的，onEvent就会在这个线程中运行，也就是说发布事件和接收事件线程在同一个线程。使用这个方法时，在onEvent方法中不能执行耗时操作，如果执行耗时操作容易导致事件分发延迟。
onEventMainThread:如果使用onEventMainThread作为订阅函数，那么不论事件是在哪个线程中发布出来的，onEventMainThread都会在UI线程中执行，接收事件就会在UI线程中运行，这个在Android中是非常有用的，因为在Android中只能在UI线程中跟新UI，所以在onEvnetMainThread方法中是不能执行耗时操作的。
onEvnetBackground:如果使用onEventBackgrond作为订阅函数，那么如果事件是在UI线程中发布出来的，那么onEventBackground就会在子线程中运行，如果事件本来就是子线程中发布出来的，那么onEventBackground函数直接在该子线程中执行。
onEventAsync：使用这个函数作为订阅函数，那么无论事件在哪个线程发布，都会创建新的子线程在执行onEventAsync.
下面就通过一个实例来看看这几个订阅函数的使用吧
1、定义事件：
public class AsyncEvent
{
private static final String TAG = “AsyncEvent”;
public String msg;
public AsyncEvent(String msg)
{
this.msg=msg;
}
}
其他的事件我就不都贴出来了，我会提供代码的下载的。
2、创建观察者（也可以叫订阅者），并实现订阅方法
public class MainActivity extends Activity
{

@Override
protected void onCreate(Bundle savedInstanceState)
{
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
//注册EventBus
EventBus.getDefault().register(this);
}

// click————————————–start———————-

public void methodPost(View view)
{
Log.d(“yzy”, “PostThread–>”+Thread.currentThread().getId());
EventBus.getDefault().post(new PostEvent(“PostEvent”));
}

public void methodMain(View view)
{
Log.d(“yzy”, “PostThread–>”+Thread.currentThread().getId());
EventBus.getDefault().post(new MainEvent(“MainEvent”));
}

public void methodBack(View view)
{
Log.d(“yzy”, “PostThread–>”+Thread.currentThread().getId());
EventBus.getDefault().post(new BackEvent(“BackEvent”));
}

public void methodAsync(View view)
{
Log.d(“yzy”, “PostThread–>”+Thread.currentThread().getId());
EventBus.getDefault().post(new AsyncEvent(“AsyncEvent”));
}

public void methodSubPost(View view)
{
new Thread()
{
public void run() {
Log.d(“yzy”, “PostThread–>”+Thread.currentThread().getId());
EventBus.getDefault().post(new PostEvent(“PostEvent”));
};
}.start();

}

public void methodSubMain(View view)
{
new Thread()
{
public void run() {
Log.d(“yzy”, “PostThread–>”+Thread.currentThread().getId());
EventBus.getDefault().post(new MainEvent(“MainEvent”));
};
}.start();

}

public void methodSubBack(View view)
{
new Thread()
{
public void run() {
Log.d(“yzy”, “PostThread–>”+Thread.currentThread().getId());
EventBus.getDefault().post(new BackEvent(“BackEvent”));
};
}.start();

}

public void methodSubAsync(View view)
{
new Thread()
{
public void run() {
Log.d(“yzy”, “PostThread–>”+Thread.currentThread().getId());
EventBus.getDefault().post(new AsyncEvent(“AsyncEvent”));
};
}.start();

}

//click——————–end——————————

//Event————————-start——————————-
/**
* 使用onEvent来接收事件，那么接收事件和分发事件在一个线程中执行
* @param event
*/
public void onEvent(PostEvent event)
{
Log.d(“yzy”, “OnEvent–>”+Thread.currentThread().getId());
}

/**
* 使用onEventMainThread来接收事件，那么不论分发事件在哪个线程运行，接收事件永远在UI线程执行，
* 这对于android应用是非常有意义的
* @param event
*/
public void onEventMainThread(MainEvent event)
{
Log.d(“yzy”, “onEventMainThread–>”+Thread.currentThread().getId());
}

/**
* 使用onEventBackgroundThread来接收事件，如果分发事件在子线程运行，那么接收事件直接在同样线程
* 运行，如果分发事件在UI线程，那么会启动一个子线程运行接收事件
* @param event
*/
public void onEventBackgroundThread(BackEvent event)
{
Log.d(“yzy”, “onEventBackgroundThread–>”+Thread.currentThread().getId());
}
/**
* 使用onEventAsync接收事件，无论分发事件在（UI或者子线程）哪个线程执行，接收都会在另外一个子线程执行
* @param event
*/
public void onEventAsync(AsyncEvent event)
{
Log.d(“yzy”, “onEventAsync–>”+Thread.currentThread().getId());
}
//Event——————————end————————————-

@Override
protected void onDestroy()
{
//取消注册EventBus
EventBus.getDefault().unregister(this);
super.onDestroy();
}
}
说明:向EvnetBus中注册订阅者使用EventBus.register方法，取消订阅者使用EvnetBus.unregister方法，通知订阅者某件事情发生，调用EventBus.post方法，具体使用可以看上面的例子。在上面的例子中我创建了4中事件，并且分别中UI线程中post四个事件和在子线程中post四个事件，然后分别打印四种订阅函数所在线程的线程id.
EventBus的使用都在这里了，实在是很简单，但是如果我们在此基础上理解EvnetBus的原理，那么我们就能非常轻松的使用EventBus了。
就从EvnetBus的入口开始看吧：EventBus.register
public void register(Object subscriber) {
register(subscriber, DEFAULT_METHOD_NAME, false, 0);
}
其实调用的就是同名函数register，它的四个参数意义分别是：
subscriber：就是要注册的一个订阅者，
methodName:就是订阅者默认的订阅函数名，其实就是“onEvent”
sticky:表示是否是粘性的，一般默认都是false，除非你调用registerSticky方法了
priority：表示事件的优先级，默认就行，
接下来我们就看看这个函数具体干了什么
private synchronized void register(Object subscriber, String methodName, boolean sticky, int priority) {
List subscriberMethods = subscriberMethodFinder.findSubscriberMethods(subscriber.getClass(),
methodName);
for (SubscriberMethod subscriberMethod : subscriberMethods) {
subscribe(subscriber, subscriberMethod, sticky, priority);
}
}
通过一个findSubscriberMethods方法找到了一个订阅者中的所有订阅方法，返回一个 List，进入到findSubscriberMethods看看如何实现的
List findSubscriberMethods(Class