EventBus源码分析（一）：EventBus的使用

前言

之前在聊观察者模式的时候说过之后要来个EventBus的源码分析，今天就开始补上。

首先我们做一点准备工作：

1、下载EventBus的源码，https://github.com/greenrobot/EventBus。

2、下载完毕之后导入到Android Studio，你会看到总共有5个工程，别惊讶，其实有两个是测试工程，这里我们不需要，你可以删掉。

最后只保留了三个工程，EventBus、EventBusAnnotationProcessor、EventBusPerformance。

EventBus这个工程是逻辑层，我们调用的api都是他定义的。

EventBusAnnotationProcessor是编译库，主要用来处理自定义的注解和一些工具类和辅助类的生成。

EventBusPerformance是一个简单的使用Demo。

所以我们的分析就是从EventBusAnnotationProcessor和EventBus入手。今天我们就先从编译库EventBusAnnotationProcessor开始分析。

正文

首先我们回顾一下EventBusd的用法：

public class MainActivity extends AppCompatActivity {

private TextView textView;

/**
* 接收MessageEvent的处理方法
* */
@Subscribe(threadMode = ThreadMode.MAIN)
public void onMessageEvent(Object object) {
// 如果接收到了多个MessageEvent，可以进行区分
if (object instanceof  String){
textView.setText((String) object);
}
}

@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
textView = (TextView) findViewById(R.id.text);
}

@Override
public void onStart() {
super.onStart();
// 注册
EventBus.getDefault().register(this);
// 发送MessageEvent，Object是String类型
EventBus.getDefault().post("test");
}

@Override
public void onStop() {
super.onStop();
// 解绑
EventBus.getDefault().unregister(this);
}
}

使用起来非常的方便，主要是以下几个步骤:

1、自定义MessageEvent的处理方法。

2、注册。

3、解绑。

但是有以下几个问题需要特别注意：

1、EventBus.getDefault().post(111); 这种基本类型是无法响应的，因为EventBus只支持对象类型的参数，并且不会自动转换成Integer类型，如果你需要这种操作，需要自己进行转换：EventBus.getDefault().post(new Integer(1));

2、可以使用多个参数的类型不同onMessageEvent，来绑定多个MessageEvent。

3、注解的方法名可以随意命名。

StickyEvent

除了普通的Event，还有一种StickyEvent，它会保存在内存中，如果先发送了Event，再注册仍然可以接受到，有点类似缓存的机制。

现在新创建一个SecondActivity：

public class SecondActivity extends Activity {

private TextView textView;

/**
* 接收MessageEvent的处理方法
*/
@Subscribe(sticky = true, threadMode = ThreadMode.MAIN)
public void onMessageEvent(String event) {
// 如果接收到了多个MessageEvent，可以进行区分
textView.setText(textView.getText().toString() + event + "");
}

@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
textView = (TextView) findViewById(R.id.text);
}

@Override
public void onStart() {
super.onStart();
// 注册
EventBus.getDefault().register(this);
}

@Override
public void onStop() {
super.onStop();
// 解绑
EventBus.getDefault().unregister(this);
}
}

非常的简单，还是注册，解绑等等，但是在@Subscribe(sticky = true）我们这里使用了StickyEvent，发送StickyEvent在点击跳转的时候：

textView.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View view) {
EventBus.getDefault().postSticky("111");

// 跳转
Intent intent = new Intent(MainActivity.this, SecondActivity.class);
startActivity(intent);
}
});

我们先来预测一下：

如果是普通的Event，在发送了之后，再注册是不会收到这个Event的，那么如果是StickyEvent呢？按照我们刚才的理解，应该是会收到的。

看一下截图：



果然是收到了，这就是StickyEvent的作用。例如我们做了一个显示手机电量的应用，我们在新的界面，就可以直接拿到已经获得电量的StickyEvent，而不用重新再取一遍。

StickyEvent有几个特点：

1、同一个类型的StickyEvent，只会保留一个，例如刚才的例子，如果多次EventBus.getDefault().postSticky(“111”);也只会收到一个。

2、可以手动清除StickyEvent，例如EventBus.getDefault().removeAllStickyEvents();清除掉所有的StickyEvent。

最后要说的是，其实EventBus还可以通过Builder来简单的配置：

boolean logSubscriberExceptions = true;
boolean logNoSubscriberMessages = true;
boolean sendSubscriberExceptionEvent = true;
boolean sendNoSubscriberEvent = true;
boolean throwSubscriberException;
boolean eventInheritance = true;
boolean ignoreGeneratedIndex;
boolean strictMethodVerification;
ExecutorService executorService = DEFAULT_EXECUTOR_SERVICE;
List<Class<?>> skipMethodVerificationForClasses;
List<SubscriberInfoIndex> subscriberInfoIndexes;

我也是没看懂这些配置是什么意思，不过不着急，接下来我们去看源码，这些就全部解决了。

总结

其他的就没什么特别注意的了，我们从使用到现在只发现了一个注解@Subscribe(threadMode = ThreadMode.MAIN)，这个注解用来指定回调的线程，是否使用StickyEvent，还有接收的优先级，那么他是怎么实现这个功能的呢？下一篇我们就来具体看看编译库了。

对于编译框架apt和注解的使用还没有了解的朋友可以先去看看我之前简单介绍过的博客：http://blog.csdn.net/u011315960/article/details/62045920。