EventBus3.0使用及源码解析

EventBus3.0使用

EventBus3.0官方使用文档
EventBus3.0GitHub地址
在EventBus3.0的官方文档中，我们可以从下面几个步骤去使用EventBus来实现事件响应机制。

上图是官方的角色协作图，可以看出EventBus有一下几个角色

• Event ：传递的事件对象
• Subscriber ： 事件的订阅者
• Publisher ： 事件的发布者
• ThreadMode ： 定义函数在哪种类型的线程中执行

1.事件（Event）定义

在gradle中配置EventBus

compile 'org.greenrobot:eventbus:3.0.0'

之后我们定义一个简单的Event

public class MessageEvent {

    public final String message;

    public MessageEvent(String message) {
        this.message = message;
    }
}

2.定义订阅者的响应事件

订阅者事件就是事件触发时响应的方法，这些方法用@Subscribe 注解声明。

// This method will be called when a MessageEvent is posted (in the UI thread for Toast)
@Subscribe(threadMode = ThreadMode.MAIN)
public void onMessageEvent(MessageEvent event) {
    Toast.makeText(getActivity(), event.message, Toast.LENGTH_SHORT).show();
}

// This method will be called when a SomeOtherEvent is posted
@Subscribe
public void handleSomethingElse(SomeOtherEvent event) {
    doSomethingWith(event);
}

当然，订阅者是需要在EventBus中注册和解除注册，才能完成一个正常的流程，一般推荐在Activity和Fragment的onStart和onStop生命周期方法中进行Subscribe的注册和解除注册。

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

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

3.发送事件

在代码中发送一个Event事件，当前所有订阅了该事件的订阅者都能响应这个事件。

EventBus.getDefault().post(new MessageEvent("Hello everyone!"));

ThreadMode选择

ThreadMode是用来控制Subscribe方法被调用时的线程，它有以下几种选择方式

1.ThreadMode.POSTING

即onMessage方法在跟发送方法（post）同一个线程被调用，这种模式意味着最少的开销,因为它完全避免了线程切换。所以在一些耗时较短的任务可以选择这种模式。这也是默认的ThreadMode。

// Called in the same thread (default)
// ThreadMode is optional here
@Subscribe(threadMode = ThreadMode.POSTING)
public void onMessage(MessageEvent event) {
    log(event.message);
}

2.ThreadMode: MAIN

显而易见，这种模式下响应方法会在Android主线程（UI）被调用。故不赘述。

// Called in Android UI's main thread
@Subscribe(threadMode = ThreadMode.MAIN)
public void onMessage(MessageEvent event) {
textField.setText(event.message);
}

3.ThreadMode: BACKGROUND

Subscribers方法 会在一个后台线程被调用。这种模式下分两种情况，
一、当post方法不在主线程时，Subscribers方法 会直接在跟post同一个线程被调用。
二、当post方法在主线程时，

// Called in the background thread
@Subscribe(threadMode = ThreadMode.BACKGROUND)
public void onMessage(MessageEvent event){
    saveToDisk(event.message);
}

4.ThreadMode: ASYNC

这种模式下，事件处理方法在一个单独的线程中被调用。不会阻塞posting的线程，为了避免触发大量的长时间运行的异步Handler方法同时限制并发线程的数量，EventBus使用线程池来重用线程处理异步事件响应。

// Called in a separate thread
@Subscribe(threadMode = ThreadMode.ASYNC)
public void onMessage(MessageEvent event){
    backend.send(event.message);
}

订阅事件的优先级

按照订阅事件的优先级高低，来决定同类型响应事件方法的调用顺序。

  @Subscribe(threadMode = ThreadMode.MAIN,priority = 100) //在ui线程执行 优先级100
    public void onDataSynEvent(DataSynEvent event) {
        Log.e(TAG, "event---->" + event.getCount());
    }

跟广播的传递规则类似，高优先级的响应方法可以终止事件的传递

 EventBus.getDefault().cancelEventDelivery(event) ;//优先级高的订阅者可以终止事件往下传递

stickyEvent

发送StickyEvent：

EventBus.getDefault().postSticky(new MessageEvent("Hello everyone!"));

接受StickyEvent：

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

// UI updates must run on MainThread
@Subscribe(sticky = true, threadMode = ThreadMode.MAIN)
public void onEvent(MessageEvent event) {   
    textField.setText(event.message);
}

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

解除注册：

MessageEvent stickyEvent = EventBus.getDefault().getStickyEvent(MessageEvent.class);
// Better check that an event was actually posted before
if(stickyEvent != null) {
    // "Consume" the sticky event
    EventBus.getDefault().removeStickyEvent(stickyEvent);
    // Now do something with it
}

使用annotationProcessor

EventBus提供了一个EventBusAnnotationProcessor注解处理器来在编译期通过读取@Subscribe()注解并解析,
处理其中所包含的信息,然后生成java类来保存所有订阅者关于订阅的信息,这样就比在运行时使用反射来获得这些订阅者的
信息速度要快.

android {
    defaultConfig {
        javaCompileOptions {
            annotationProcessorOptions {
                arguments = [ eventBusIndex : 'com.example.myapp.MyEventBusIndex' ]
            }
        }
    }
}

dependencies {
    compile 'org.greenrobot:eventbus:3.0.0'
    annotationProcessor 'org.greenrobot:eventbus-annotation-processor:3.0.1'
}

如果上面的配置不起作用，可以使用apt配置

buildscript {
    dependencies {
        classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
    }
}

apply plugin: 'com.neenbedankt.android-apt'

dependencies {
    compile 'org.greenrobot:eventbus:3.0.0'
    apt 'org.greenrobot:eventbus-annotation-processor:3.0.1'
}

apt {
    arguments {
        eventBusIndex "com.example.myapp.MyEventBusIndex"
    }
}

配置完成后 rebuild工程后，就会在\build\generated\source\apt\PakageName\目录生成MyEventBusIndex 索引，
添加索引：

EventBus.builder().addIndex(new MyEventBusIndex()).installDefaultEventBus();
// Now the default instance uses the given index. Use it like this:
EventBus eventBus = EventBus.getDefault();

EventBus eventBus = EventBus.builder()
    .addIndex(new MyEventBusAppIndex())
    .addIndex(new MyEventBusLibIndex()).build();

EvenEvent3.0 post事件分发流程分析

首先是调用post方法发送事件

 /** Posts the given event to the event bus. */
     public void post(Object event) {
        //得到当前线程的Posting状态.
        PostingThreadState postingState = currentPostingThreadState.get();
        //获取当前线程的事件队列
        List