Android第三方框架EventBus使用详解

来源：互联网发布：查看是否安装mysql 编辑：程序博客网时间：2024/05/29 07:30

EventBus使用详解(一)——EventBus核心内容

EventBus是一款针对Android优化的发布/订阅事件总线。主要功能是替代Intent,Handler,BroadCast在Fragment，Activity，Service，线程之间传递消息.优点是开销小，代码更优雅，它简化了组件之间的通信，使我们的应用程序更加简单、通信更加快捷。我们来看EventBus的消息传递图：

EventBus事件主线由四大部分组成：

Publisher发布者：用于分发我们的Event事件，在EventBus中通过post方法进行分发传送。

Subscriber订阅者：用于接受我们的事件，我们在订阅事件中处理我们接收的数据。

Event事件：任何一个对象都可以作为事件，比如任何字符串，事件是发布者和订阅者之间的通信载体。

EventBus：类似于中转站，将我们的事件进行对应的分发处理。

举个通俗点的例子，EventBus消息机制就是我们生活中的寄快递，你去快递站点寄快递，你就是事件发送者，你的包裹就是事件，快递站点就是EventBus，接收快递的人就是事件订阅者。快递公司经过装车分类最后把你的快递寄到收件人手里，就类似EventBus最后将事件成功传达。

1、下载EventBus的类库

源码：https://github.com/greenrobot/EventBus.git

2、基本使用

(1)首先需要定义一个消息类，该类可以不继承任何基类也不需要实现任何接口

public class MessageEvent {     ...... }

(2)在需要订阅事件的地方注册事件

EventBus.getDefault().register(this);

(3)产生事件，即发送消息

EventBus.getDefault().post(messageEvent);

(4)处理消息

在3.0之前，EventBus还没有使用注解方式。消息处理的方法也只能限定于onEvent、onEventMainThread、onEventBackgroundThread和onEventAsync，分别代表四种线程模型。而在3.0之后，消息处理的方法可以随便取名，但是需要添加一个注解@Subscribe，并且要指定线程模型（默认为POSTING），四种线程模型，下面会讲到。

注意，事件处理函数的访问权限必须为public，否则会报异常。

@Subscribe(threadMode = ThreadMode.POSTING)public void XXX(MessageEvent messageEvent){    ... }

(5)取消消息订阅

EventBus.getDefault().unregister(this);

二.实战

先给大家看个例子：

当击btn_try按钮的时候，跳到第二个Activity，当点击第二个activity上面的First Event按钮的时候向第一个Activity发送消息，当第一个Activity收到消息后，一方面将消息Toast显示，一方面放入textView中显示。

1、基本框架搭建

想必大家从一个Activity跳转到第二个Activity的程序应该都会写，这里先稍稍把两个Activity跳转的代码建起来。后面再添加EventBus相关的玩意。

MainActivity布局（activity_main.xml）

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"      xmlns:tools="http://schemas.android.com/tools"      android:layout_width="match_parent"      android:layout_height="match_parent"      android:orientation="vertical">  <Button       android:id="@+id/btn_try"      android:layout_width="match_parent"      android:layout_height="wrap_content"      android:text="btn_bty"/>  <TextView       android:id="@+id/tv"      android:layout_width="wrap_content"      android:layout_height="match_parent"/>  </LinearLayout>

新建一个Activity，SecondActivity布局（activity_second.xml）

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"      xmlns:tools="http://schemas.android.com/tools"      android:layout_width="match_parent"      android:layout_height="match_parent"      android:orientation="vertical"      tools:context="com.harvic.try_eventbus_1.SecondActivity" >  <Button       android:id="@+id/btn_first_event"      android:layout_width="match_parent"      android:layout_height="wrap_content"      android:text="First Event"/>  </LinearLayout>

MainActivity.java （点击btn跳转到第二个Activity）

public class MainActivity extends Activity {      Button btn;      @Override      protected void onCreate(Bundle savedInstanceState) {          super.onCreate(savedInstanceState);          setContentView(R.layout.activity_main);          btn = (Button) findViewById(R.id.btn_try);          btn.setOnClickListener(new View.OnClickListener() {          @Override          public void onClick(View v) {              // TODO Auto-generated method stub              Intent intent = new Intent(getApplicationContext(),              SecondActivity.class);              startActivity(intent);          }          });      }  }

到这，基本框架就搭完了，下面开始按步骤使用EventBus了。

2、新建一个消息事件类MessageEvent

public class MessageEvent {    private String message;    public MessageEvent(String message) {        this.message = message;    }    public String getMessage() {        return message;    }}

这个类很简单，构造时传进去一个字符串，然后可以通过getMessage()获取出来。

3、在要接收消息的页面注册EventBus：

在上面的GIF图片的演示中，大家也可以看到，我们是要在MainActivity中接收发过来的消息的，所以我们在MainActivity中注册消息。

通过我们会在OnCreate()函数中注册EventBus，在OnDestroy（）函数中反注册。所以整体的注册与反注册的代码如下：

public class MainActivity extends Activity {      Button btn;      TextView tv;      @Override      protected void onCreate(Bundle savedInstanceState) {          super.onCreate(savedInstanceState);          setContentView(R.layout.activity_main);          //注册EventBus          EventBus.getDefault().register(this);          btn = (Button) findViewById(R.id.btn_try);          tv = (TextView)findViewById(R.id.tv);          btn.setOnClickListener(new View.OnClickListener() {          @Override          public void onClick(View v) {              // TODO Auto-generated method stub              Intent intent = new Intent(getApplicationContext(),              SecondActivity.class);              startActivity(intent);              }              });          }      @Override      protected void onDestroy(){          super.onDestroy();          EventBus.getDefault().unregister(this);//反注册EventBus      }  }

4、发送消息

发送消息是使用EventBus中的Post方法来实现发送的，发送过去的是我们新建的类的实例！

EventBus.getDefault().post(new MessageEvent("Btn clicked"));

完整的SecondActivity.java的代码如下：

package com.example.tryeventbus_simple;  import com.harvic.other.FirstEvent;  import de.greenrobot.event.EventBus;  import android.app.Activity;  import android.os.Bundle;  import android.view.View;  import android.widget.Button;  public class SecondActivity extends Activity {      private Button btn_FirstEvent;      @Override      protected void onCreate(Bundle savedInstanceState) {          super.onCreate(savedInstanceState);          setContentView(R.layout.activity_second);          btn_FirstEvent = (Button) findViewById(R.id.btn_first_event);          btn_FirstEvent.setOnClickListener(new View.OnClickListener() {          @Override          public void onClick(View v) {          // TODO Auto-generated method stub          EventBus.getDefault().post(          new FirstEvent("FirstEvent btn clicked"));          }          });      }  }

5、接收消息

接收消息时，我们使用EventBus中最常用的ThreadMode.MAIN线程模式来接收消息，具体为什么用这个，我们下篇再讲，这里先给大家一个初步认识，要先能把EventBus用起来先。在MainActivity中声明一个公共的加注释的方法，参数就是我们自己定义的类：

在收到Event实例后，我们将其中携带的消息取出，一方面Toast出去，一方面传到TextView中；

@Subscribe(threadMode = ThreadMode.MAIN)public void onEventMainThread(MessageEvent event) {  String msg = "onEventMainThread收到了消息：" + event.getMessage();  Log.d("EventBus", msg);  tv.setText(msg);  Toast.makeText(this, msg, Toast.LENGTH_LONG).show();  }

完整的MainActiviy代码如下：

public class MainActivity extends AppCompatActivity {    Button mBtn;    TextView mTv;    @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.activity_main);        EventBus.getDefault().register(this);//注册EventBus        mBtn = (Button) findViewById(R.id.main_btn);        mTv = (TextView) findViewById(R.id.main_tv);        mBtn.setOnClickListener(new View.OnClickListener() {            @Override            public void onClick(View v) {                Intent intent = new Intent();                intent.setClass(getApplicationContext(),SecondActivity.class);                startActivity(intent);            }        });    }    @Subscribe(threadMode = ThreadMode.MAIN)    public void onEventMainThread(MessageEvent event) {        String msg = "onEventMainThread收到了消息：" + event.getMessage();        Log.d("EventBus", msg);        mTv.setText(msg);        Toast.makeText(this, msg, Toast.LENGTH_LONG).show();    }    @Override    protected void onDestroy() {        super.onDestroy();        EventBus.getDefault().unregister(this);    }}

EventBus使用详解(二)——EventBus拓展内容

线程模型

在EventBus的事件处理函数中需要指定线程模型，即指定事件处理函数运行所在的想线程。在上面我们已经接触到了EventBus的四种线程模型。那他们有什么区别呢？在EventBus中的观察者通常有四种线程模型，分别是PostThread（默认）、MainThread、BackgroundThread与Async。

POSTING：如果使用事件处理函数指定了线程模型为PostThread，那么该事件在哪个线程发布出来的，事件处理函数就会在这个线程中运行，也就是说发布事件和接收事件在同一个线程。在线程模型为PostThread的事件处理函数中尽量避免执行耗时操作，因为它会阻塞事件的传递，甚至有可能会引起ANR。
MAIN：如果使用事件处理函数指定了线程模型为MainThread，那么不论事件是在哪个线程中发布出来的，该事件处理函数都会在UI线程中执行。该方法可以用来更新UI，但是不能处理耗时操作。
BACKGROUND：如果使用事件处理函数指定了线程模型为BackgroundThread，那么如果事件是在UI线程中发布出来的，那么该事件处理函数就会在新的线程中运行，如果事件本来就是子线程中发布出来的，那么该事件处理函数直接在发布事件的线程中执行。在此事件处理函数中禁止进行UI更新操作。
ASYNC：如果使用事件处理函数指定了线程模型为Async，那么无论事件在哪个线程发布，该事件处理函数都会在新建的子线程中执行。同样，此事件处理函数中禁止进行UI更新操作。

为了验证以上四个方法，我写了个小例子。

@Subscribe(threadMode = ThreadMode.POSTING)public void onMessageEventPostThread(MessageEvent messageEvent) {    Log.e("POSTING", Thread.currentThread().getName());}@Subscribe(threadMode = ThreadMode.MAIN)public void onMessageEventMainThread(MessageEvent messageEvent) {    Log.e("MAIN", Thread.currentThread().getName());}@Subscribe(threadMode = ThreadMode.BACKGROUND)public void onMessageEventBackgroundThread(MessageEvent messageEvent) {    Log.e("BACKGROUND", Thread.currentThread().getName());}@Subscribe(threadMode = ThreadMode.ASYNC)public void onMessageEventAsync(MessageEvent messageEvent) {    Log.e("ASYNC", Thread.currentThread().getName());}

分别使用上面四个方法订阅同一事件，打印他们运行所在的线程。首先我们在UI线程中发布一条MessageEvent的消息，看下日志打印结果是什么。

findViewById(R.id.send).setOnClickListener(new View.OnClickListener() {        @Override        public void onClick(View v) {            Log.e("POSTING", Thread.currentThread().getName());            EventBus.getDefault().post(new MessageEvent(“test”));        }    });

打印结果如下：

09-26 08:18:31.361 6627-6627/com.example.administrator.explain_eventbus E/POSTING: main09-26 08:18:31.361 6627-6687/com.example.administrator.explain_eventbus E/ASYNC: pool-1-thread-109-26 08:18:31.365 6627-6627/com.example.administrator.explain_eventbus E/MAIN: main09-26 08:18:31.365 6627-6627/com.example.administrator.explain_eventbus E/POSTING: main09-26 08:18:31.365 6627-6688/com.example.administrator.explain_eventbus E/BACKGROUND: pool-1-thread-2

从日志打印结果可以看出，如果在UI线程中发布事件，则线程模型为POSTING的事件处理函数也执行在UI线程，与发布事件的线程一致。线程模型为ASYNC的事件处理函数执行在名字叫做pool-1-thread-1的新的线程中。而MAIN的事件处理函数执行在UI线程，BACKGROUND的事件处理函数执行在名字叫做pool-1-thread-2的新的线程中。

我们再看看在子线程中发布一条MessageEvent的消息时，会有什么样的结果。

findViewById(R.id.send).setOnClickListener(new View.OnClickListener() {        @Override        public void onClick(View v) {            new Thread(new Runnable() {                @Override                public void run() {                    Log.e("POSTING", Thread.currentThread().getName());                    EventBus.getDefault().post(new MessageEvent(“test”));                }            }).start();        }    });

打印结果如下：

09-26 08:27:24.705 12468-14509/com.example.administrator.explain_eventbus E/POSTING: Thread-12009-26 08:27:24.705 12468-14447/com.example.administrator.explain_eventbus E/ASYNC: pool-1-thread-109-26 08:27:24.709 12468-14509/com.example.administrator.explain_eventbus E/BACKGROUND: Thread-12009-26 08:27:24.709 12468-14509/com.example.administrator.explain_eventbus E/POSTING: Thread-12009-26 08:27:24.721 12468-12468/com.example.administrator.explain_eventbus E/MAIN: main

从日志打印结果可以看出，如果在子线程中发布事件，则线程模型为POSTING的事件处理函数也执行在子线程，与发布事件的线程一致（都是Thread-120）。BACKGROUND事件模型也与发布事件在同一线程执行。ASYNC则在一个名叫pool-1-thread-1的新线程中执行。MAIN还是在UI线程中执行。

上面一个例子充分验证了指定不同线程模型的事件处理方法执行所在的线程。