EventBus框架总结

/*----------------------------------------
 *-描述--EventBus框架总结.
 *-描述--S1.快速集成
 *  SS1.添加依赖 compile 'org.greenrobot:eventbus:3.0.0'
 *  SS2.MainAct 注册EventBus EventBus.getDefault().register(this);
 *      onEventMainThread(MyEvent event)获取发送过来的消息
 *  SS3.SubAct发送消息对象，EventBus.getDefault().post(new FirstEvent("new msg..."));
 *-描述--S2.EventBus相关知识
 *  SS1.EventBus是一款针对Android优化的发布/订阅事件总线。主要功能是替代Intent,Handler,BroadCast在
 *  Fragment，Activity，Service，线程之间传递消息.优点是开销小，代码更优雅。以及将发送者和接收者解耦。
 *  SS2.EventBus的四个方法：
 *      @onEvent:如果使用onEvent作为订阅函数，那么该事件在哪个线程发布出来的，onEvent就会在这个线程中运行，
 *      也就是说发布事件和接收事件线程在同一个线程。使用这个方法时，在onEvent方法中不能执行耗时操作，
 *      如果执行耗时操作容易导致事件分发延迟。
 *      @onEventMainThread:如果使用onEventMainThread作为订阅函数，那么不论事件是在哪个线程中发布出来的，
 *      onEventMainThread都会在UI线程中执行，接收事件就会在UI线程中运行，这个在Android中是非常有用的，
 *      因为在Android中只能在UI线程中跟新UI，所以在onEvnetMainThread方法中是不能执行耗时操作的。
 *      @onEventBackground:如果使用onEventBackgrond作为订阅函数，那么如果事件是在UI线程中发布出来的，
 *      那么onEventBackground就会在子线程中运行，如果事件本来就是子线程中发布出来的，那么
 *      onEventBackground函数直接在该子线程中执行。
 *      @onEventAsync：使用这个函数作为订阅函数，那么无论事件在哪个线程发布，都会创建新的子线程在执行
 *      onEventAsync.
 *      @简单总结onEvent-在发布的线程执行，onEventMainThread-在主线程执行，onEventBackground-子线程
 *      中执行，onEventAsync新建一个线程执行。
 *-描述--None.
 *-描述--B1.None.
 *  参考：
 *  https://github.com/greenrobot/EventBus
 *  http://blog.csdn.net/harvic880925/article/details/40660137
 *  http://blog.csdn.net/harvic880925/article/details/40787203
 *  https://segmentfault.com/a/1190000004279679
 *  https://segmentfault.com/a/1190000004314315
 *  http://blog.csdn.net/yuanzeyao/article/details/38174537
 *  http://blog.mcxiaoke.com/2015/08/03/how-to-write-an-eventbus-part1/
 *  异常：
 *  https://github.com/greenrobot/EventBus/issues/271
 *---------------------------------------------------------------------------*/

public class ModxExam1Activity extends BaseActivity implements View.OnClickListener{

//    public ModxExam1Activity() {
//    }

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_modx_exam1);

        initViews();
        initEvents();
        initDatas();
    }

    @Override
    public void initViews() {
        LogUtil.infoD(this, "initViews");

        /* 注册EventBus */
        EventBus.getDefault().register(this);
        findViewById(R.id.btn_skip).setOnClickListener(this);
    }

    @Override
    public void initEvents() {
        LogUtil.infoD(this, "initEvents");
    }

    @Override
    public void initDatas() {
        LogUtil.infoD(this, "initDatas");
    }

    @Override
    public void onClick(View view) {
        switch (view.getId()) {
            case R.id.btn_skip:
                Intent intent = new Intent(this,EventBusActivity.class);
                startActivity(intent);
                break;
        }
    }

    /**
     * 在事件发生的线程执行
     * @param event 事件消息对象
     */
    @Subscribe
    public void onEvent(FirstEvent event){
        LogUtil.infoE(this, "onEvent：" + event.getMsg());
    }

    /**
     * 接收消息对象
     * @param event 事件消息对象
     */
    @Subscribe
    public void onEventMainThread(FirstEvent event) {

        String msg = "onEventMainThread:" + event.getMsg();
        LogUtil.infoE(this,msg);
        Toast.makeText(this, msg, Toast.LENGTH_LONG).show();
    }

    /**
     * 在子线程执行
     * @param event 事件消息对象
     */
    @Subscribe
    public void onEventBackgroundThread(FirstEvent event){
        LogUtil.infoE(this, "onEventBackground:" + event.getMsg());
    }

    /**
     * 新建线程执行
     * @param event 事件消息对象
     */
    @Subscribe
    public void onEventAsync(FirstEvent event){
        LogUtil.infoE(this, "onEventAsync:" + event.getMsg());
    }

    @Override
    protected void onDestroy(){
        super.onDestroy();
        /* 取消EventBus注册 */
        EventBus.getDefault().unregister(this);
    }
}

    @Override
    public void onClick(View v) {
        switch (v.getId())
        {
            case R.id.send_btn:
                /* 发送消息对象 */
                EventBus.getDefault().post(new FirstEvent("EventBusActivity btn clicked"));
                break;
        }
    }

总结2

EventBus是为Android优化的发布/订阅事件总线。主要功能是替代Intent,Handler,BroadCast在Fragment，Activity，Service，线程之间传递消息.优点是开销小，代码更优雅。以及将发送者和接收者解耦。

EventBus 是一个 Android 事件发布/订阅框架，通过解耦发布者和订阅者简化 Android 事件传递。传统的事件传递方式包括：Handler、BroadCastReceiver、Interface 回调，相比之下 EventBus 的优点是代码简洁，使用简单，并将事件发布和订阅充分解耦。

事件(Event)：又可称为消息。其实就是一个对象，可以是网络请求返回的字符串，也可以是某个开关状态等等。事件类型(EventType)指事件所属的 Class。事件分为一般事件和 Sticky 事件，相对于一般事件，Sticky 事件不同之处在于，当事件发布后，再有订阅者开始订阅该类型事件，依然能收到该类型事件最近一个 Sticky 事件。

订阅者(Subscriber)：订阅某种事件类型的对象。当有发布者发布这类事件后，EventBus 会执行订阅者的 onEvent 函数，这个函数叫事件响应函数。订阅者通过 register 接口订阅某个事件类型，unregister 接口退订。订阅者存在优先级，优先级高的订阅者可以取消事件继续向优先级低的订阅者分发，默认所有订阅者优先级都为 0。

发布者(Publisher)：发布某事件的对象，通过 post 接口发布事件。link

EventBus订阅事件的四个方法：

@onEvent(PostThread):如果使用onEvent作为订阅函数，那么该事件在哪个线程发布出来的，onEvent就会在这个线程中运行，也就是说发布事件和接收事件线程在同一个线程。使用这个方法时，在onEvent方法中不能执行耗时操作，如果执行耗时操作容易导致事件分发延迟。

@onEventMainThread(MainThread):如果使用onEventMainThread作为订阅函数，那么不论事件是在哪个线程中发布出来的， onEventMainThread都会在UI线程中执行，接收事件就会在UI线程中运行，这个在Android中是非常有用的。因为在Android中只能在UI线程中跟新UI，所以在onEvnetMainThread方法中是不能执行耗时操作的。

@onEventBackground(BackgroundThread):如果使用onEventBackgrond作为订阅函数，那么如果事件是在UI线程中发布出来的，那么onEventBackground就会在子线程中运行，如果事件本来就是子线程中发布出来的，那么onEventBackground函数直接在该子线程中执行。

@onEventAsync(Async)：使用这个函数作为订阅函数，那么无论事件在哪个线程发布，都会创建新的子线程在执行onEventAsync。

@简单总结onEvent-在发布的线程执行，onEventMainThread-在UI主线程执行，onEventBackground-子线程中执行，onEventAsync新建一个线程执行。

sticky事件

一些事件携带的信息只有在其发布之后才会被关注。例如，有些事件会标记一些初始化的完成。或者一些传感器或者位置数据需要获取最新的值，这些情况我们就可以使用sticky事件。EventBus会在内存中保留某种类型最新的sticky事件，在stickyEvent发布后，当有新的Activity启动，并注册了sticky事件，他就会立刻收到该事件。link(历史事件)

// 注册sticky事件

EventBus.getDefault().registerSticky(this);

// 发布sticky事件

EventBus.getDefault().postSticky(new MessageEvent("sticky event"));

项目中使用EventBus：
S1.添加依赖 compile 'org.greenrobot:eventbus:3.0.0'或jar包；
S2.注册解注册：
    EventBus.getDefault().register(this);    // onCreate()注册
    EventBus.getDefault().unregister(this);    // onDestroy()取消注册
S3.发布/订阅事件：
    // 发布事件
    EventBus.getDefault().post(new FirstEvent("Event"));
// 取消事件，当取消事件发送后，后面的订阅者就不再会接收到事件
EventBus.getDefault().cancelEventDelivery(event) ;     
// 订阅事件
@Subscribe
public void onEventMainThread(String event) {
}
EventBus主要方法：
// 事件注册
EventBus.getDefault().register(this);    // onCreate()注册
EventBus.getDefault().registerSticky(this);
EventBus.getDefault().unregister(this);    // onDestroy()取消注册
// 发布事件
EventBus.getDefault().post(new FirstEvent("Event"));
EventBus.getDefault().postSticky(new MessageEvent("sticky event"));
EventBus.getDefault().cancelEventDelivery(event) ;     
// 订阅事件
@Subscribe
public void onEvent(MessageEvent event) {
}
@Subscribe
public void onEventMainThread(MessageEvent event) {
}
@Subscribe
public void onEventBackgroundThread(MessageEvent event){
}
@Subscribe
public void onEventAsync(MessageEvent event){
}
// 订阅事件-NEW
// Called in the same thread (default)
@Subscribe(threadMode = ThreadMode.POSTING) // ThreadMode is optional here
public void onMessage(MessageEvent event) {
}
// Called in Android UI's main thread
@Subscribe(threadMode = ThreadMode.MAIN)
public void onMessage(MessageEvent event) {
}
// Called in the background thread
@Subscribe(threadMode = ThreadMode.BACKGROUND)
public void onMessage(MessageEvent event){
}
// Called in a separate thread
@Subscribe(threadMode = ThreadMode.ASYNC)
public void onMessage(MessageEvent event){
}

参考文档：

greenrobot/EventBus github

官方API ThreadMode

EventBus使用简书

Android -- EventBus解析 cnblogs

posted @ 2016-08-12 01:45 zhen-Android 阅读(395) 评论(0) 编辑收藏举报

会员力量，点亮园子希望

刷新页面返回顶部

zhen

EventBus框架总结

公告