Android消息传递之EventBus 3.0使用与案例

前言:
greenrobot的EventBus的大名不必多说，在实际项目开发中，使用起来既简单又方便，所以决定写下这篇文章，一方面是总结，一方面是给需要的人看看。目前EventBus最新版本是3.0，所以以下所讲内容都是基于EventBus3.0。相似的产品还有square的otto，何红辉的AndroidEventBus（模仿EventBus开发的），还有google的Guava（一个庞大的工具类库），而EventBus只是其中的一个功能。有兴趣的朋友可以去谷歌百度再了解一下。

GitHub : https://github.com/greenrobot/EventBus
官方文档：http://greenrobot.org/eventbus/documentation

一 . EventBus概述
EventBus是一个Android端优化的publish/subscribe消息总线，简化了应用程序内各组件间、组件与后台线程间的通信。比如请求网络，等网络返回时通过Handler或Broadcast通知UI，两个Fragment之间需要通过Listener通信，这些需求都可以通过EventBus实现，作为一个消息总线主要有三个组成部分：

• 事件（Event）
• 事件订阅者（Subscriber）
• 事件发布者（Publisher）

官方一张图可以很好地说明这三者关系
注：发布者(Publisher)使用post()方法将Event发送到Event Bus，而后Event Bus自动将Event发送到多个订阅者(Subcriber)

二 . EventBus基本用法
1 . build.gradle添加引用

compile 'org.greenrobot:eventbus:3.0.0'

2 . 构造发送消息类，这个类就是我们要发送的对象

public class MainMessage{

    private String message;

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}

3 . 注册/解除注册

EventBus.getDefault().register(this);//注册
EventBus.getDefault().unregister(this);//解除注册

4 . 发送消息

EventBus.getDefault().post(new MainMessage("Hello Donkor");

5 . 事件处理

//ui主线程中执行  
@Subscribe(threadMode = ThreadMode.Main)  
public void onMainEventBus(MainMessage msg) {  
} 

这里需要注意的是ThreadMode总共四个：

• MAIN UI主线程
• POSTING 默认调用方式，在调用post方法的线程执行，避免了线程切换，性能开销最少
• BACKGROUND 如果调用post方法的线程不是主线程，则直接在该线程执行。 如果是主线程，则切换到后台单例线程，多个方法公用同个后台线程，按顺序执行，避免耗时操作
• ASYNC 开辟新独立线程，用来执行耗时操作，例如网络访问。EventBus内部使用了线程池，但是要尽量避免大量长时间运行的异步线程，限制并发线程数量。可以通过EventBusBuilder修改，默认使用Executors.newCachedThreadPool()

6 . priority事件优先级

//priority越大，级别越高
@Subscribe(threadMode = ThreadMode.MAIN,priority = 100) 
public void onEvent(MainMessage event) {
}

7 . 终止事件传递

// 中止事件传递，后续事件不在调用,注意，
//只能在传递事件的时候调用,优先级高的订阅者可以终止事件往下传递
@Subscribe
public void onEvent(MessageEvent event){
    EventBus.getDefault().cancelEventDelivery(event) ;
}

三 . EventBus使用与案例
下面看下效果图：

MainActivity完整代码

package dom.donkor.demo.eventbus;

import android.app.Activity;
import android.os.Bundle;
import android.view.View;
import android.widget.Button;
import android.widget.TextView;

import org.greenrobot.eventbus.EventBus;
import org.greenrobot.eventbus.Subscribe;
import org.greenrobot.eventbus.ThreadMode;

public class MainActivity extends Activity implements View.OnClickListener {

    private Button mBtn1,mBtn2,mBtn3,mBtn4;
    private TextView mTextview;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        EventBus.getDefault().register(this);

        mBtn1= (Button) findViewById(R.id.btn1);
        mBtn2= (Button) findViewById(R.id.btn2);
        mBtn3= (Button) findViewById(R.id.btn3);
        mBtn4= (Button) findViewById(R.id.btn4);
        mTextview= (TextView) findViewById(R.id.tv);

        mBtn1.setOnClickListener(this);
        mBtn2.setOnClickListener(this);
        mBtn3.setOnClickListener(this);
        mBtn4.setOnClickListener(this);
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        EventBus.getDefault().unregister(this);
    }

    @Override
    public void onClick(View v) {
        switch (v.getId()) {
            case R.id.btn1:
                EventBus.getDefault().post(new MainMessage("Hello Donkor"));
                break;
            case R.id.btn2:
                EventBus.getDefault().post(new BackgroundMessage("Hello Donkor"));
                break;
            case R.id.btn3:
                EventBus.getDefault().post(new AsyncMessage("Hello Donkor"));
                break;
            case R.id.btn4:
                EventBus.getDefault().post(new PostingMessage("Hello Donkor"));
                break;
        }
    }

    //主线程中执行
    @Subscribe(threadMode = ThreadMode.MAIN)
    public void onMainEventBus(MainMessage msg) {
        mTextview.setText("MAIN主线程中发出："+msg.getMessage());
    }

    //后台线程
    @Subscribe(threadMode = ThreadMode.BACKGROUND)
    public void onBackgroundEventBus(BackgroundMessage msg) {
        mTextview.setText("BACKGROUND后台线程中发出：" + msg.getMessage());
    }

    //异步线程
    @Subscribe(threadMode = ThreadMode.ASYNC)
    public void onAsyncEventBus(AsyncMessage msg) {
        mTextview.setText("ASYNC异步线程中发出：" + msg.getMessage());
    }

    //默认情况，和发送事件在同一个线程
    @Subscribe(threadMode = ThreadMode.POSTING)
    public void onPostEventBus(PostingMessage msg) {
        mTextview.setText("POSTING发送事件在同一个线程中发出：" + msg.getMessage());
    }
}

布局activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical"
>

        <Button
            android:id="@+id/btn1"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="发送消息到主线程执行"/>

        <Button
            android:id="@+id/btn2"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="发送消息到后台线程执行"/>

        <Button
            android:id="@+id/btn3"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="发送消息到后台线程强制执行"/>

        <Button
            android:id="@+id/btn4"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="发送消息--和发送方同一线程执行"/>


    <TextView
        android:id="@+id/tv"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_marginTop="20dp"
        android:layout_marginLeft="30dp"
        android:textColor="@android:color/holo_red_dark"
        android:textSize="20dp"
        android:text="Hello World!"/>
</LinearLayout>

下载地址：http://download.csdn.net/download/donkor_/9706204

关于我：

• Android开发交流QQ群：537891203
• 邮箱：donkor@yeah.net