Android中 EventBus的简单使用

一、EventBus简介

EventBus是一个Android端优化的publish/subscribe消息总线，简化了应用程序内各组件间、组件与后台线程间的通信。

作为一个消息总线主要有三个组成部分：

事件（Event）：可以是任意类型的对象。通过事件的发布者将事件进行传递。

事件订阅者（Subscriber）：接收特定的事件。

事件发布者（Publisher）：用于通知 Subscriber 有事件发生。可以在任意线程任意位置发送事件。

上图解释了整个EventBus的大概工作流程：事件的发布者（Publisher）将事件（Event）通过post()方法发送。EventBus内部进行处理，找到订阅了该事件（Event）的事件订阅者（Subscriber）。然后该事件的订阅者（Subscriber）通过onEvent()方法接收事件进行相关处理（关于onEvent()在EventBus 3.0中有改动，下面详细说明）。

 

二、EventBus的简单使用

1、把EventBus依赖到项目

build.gradle添加引用

compile 'org.greenrobot:eventbus:3.1.1'

2.下面是EditText输入框的传值,跳到第二个页面,点击按钮得到数据.

-------------------------MainActivity-------------------------

import android.content.Intent;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.view.View;
import android.widget.Button;
import android.widget.EditText;
import org.greenrobot.eventbus.EventBus;

public class MainActivity extends AppCompatActivity implements View.OnClickListener {

    private EditText zhanghao;
    private EditText pass;

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

        //初始化控件
        initView();

    }

    private void initView() {
        zhanghao = findViewById(R.id.zhanghao_ed);
        pass= findViewById(R.id.password_ed);
        Button login_btn=findViewById(R.id.login_btn);
        login_btn.setOnClickListener(this);


    }

    public void receiveActivity2(String msg) {
        //main不能执行耗时操作，否则会出现anr现象
        System.out.println("mainThreadName:" + Thread.currentThread().getName());
    }

    @Override
    public void onClick(View view) {
        String zh = zhanghao.getText().toString();
        String ps = pass.getText().toString();

        MesageEventBus mesageEventBus = new MesageEventBus();
        mesageEventBus.setMobile(zh);
        mesageEventBus.setPassword(ps);
        //发送消息
        //一般用post发送,@Subscribe接受就可以了
        //此处发送消息时Main2Activity还没有启动,所以必须使用粘性事件postSticky发送
        //所以接收的时候必须使用@Subscribe(threadMode = ThreadMode.MAIN,stickt = true) 
        EventBus.getDefault().postSticky(mesageEventBus);
        startActivity(new Intent(MainActivity.this,Main2Activity.class));
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        //避免內存泄漏和内存溢出,回收内存资源
        EventBus.getDefault().unregister(this);

    }
}

---------------------Main2Activity-------------------------------

import android.support.v7.app.AppCompatActivity;
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 Main2Activity extends AppCompatActivity{

    private TextView pass;
    private TextView zhanghao;
    private Button jieshou_btn;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main2);
        //初始化控件
        initView();
        //先注册,才能接收数据
        EventBus.getDefault().register(this);

    }

    private void initView() {
        pass = findViewById(R.id.password_tv);
        zhanghao = findViewById(R.id.zhanghao_tv);
        jieshou_btn = findViewById(R.id.jieshou_btn);

    }



    @Subscribe(threadMode= ThreadMode.MAIN,sticky =true)
    public void onMessage(final MesageEventBus eventBus) {

        jieshou_btn.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                pass.setText(eventBus.getPassword());
                zhanghao.setText(eventBus.getMobile());
            }
        });
    }

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


}

-------------------MesageEventBus---------------------------

package com.example.earl.baipenggui1511j20180131;

/**
 * Created by Earl on 2018/1/31.
 */

public class MesageEventBus {
    private String mobile;
    private String password;


    public String getMobile() {
        return mobile;
    }

    public void setMobile(String mobile) {
        this.mobile = mobile;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

---------------------activity_main.xml---------------------------

----------------------activity_main2.xml-----------------------

三、EventBus的进阶使用

1.线程模式ThreadMode

当你接收的的事件后，如果处于非UI线程，你要更新UI怎么办？如果处于UI线程，你要进行耗时操作，怎么办?等等其他情况，通过ThreadMode统统帮你解决。

用法展示：

@Subscribe(threadMode = ThreadMode.MainThread) public void onNewsEvent(NewsEvent event){ String message = event.getMessage(); mTv_message.setText(message); }

使用起来很简单，通过@Subscribe(threadMode = ThreadMode.MainThread)即可指定。

下面具体介绍下ThreadMode。

关于ThreadMode，一共有四种模式PostThread，MainThread，BackgroundThread以及Async。

PostThread：事件的处理在和事件的发送在相同的进程，所以事件处理时间不应太长，不然影响事件的发送线程。

**MainThread: **事件的处理会在UI线程中执行。事件处理时间不能太长，这个不用说的，长了会ANR的。

BackgroundThread：如果事件是在UI线程中发布出来的，那么事件处理就会在子线程中运行，如果事件本来就是子线程中发布出来的，那么事件处理直接在该子线程中执行。所有待处理事件会被加到一个队列中，由对应线程依次处理这些事件，如果某个事件处理时间太长，会阻塞后面的事件的派发或处理。

Async：事件处理会在单独的线程中执行，主要用于在后台线程中执行耗时操作，每个事件会开启一个线程。

2.priority事件优先级

事件的优先级类似广播的优先级，优先级越高优先获得消息。

用法展示：

@Subscribe(priority = 100) public void onToastEvent(ToastEvent event){ Toast.makeText(MainActivity.this,event.getContent(),Toast.LENGTH_SHORT).show(); }

当多个订阅者（Subscriber）对同一种事件类型进行订阅时，即对应的事件处理方法中接收的事件类型一致，则优先级高（priority 设置的值越大），则会先接收事件进行处理；优先级低（priority 设置的值越小），则会后接收事件进行处理。

除此之外，EventBus也可以终止对事件继续传递的功能。

用法展示：

@Subscribe(priority = 100) public void onToastEvent(ToastEvent event){ Toast.makeText(MainActivity.this,event.getContent(),Toast.LENGTH_SHORT).show(); EventBus.getDefault().cancelEventDelivery(event); }

这样其他优先级比100低，并且订阅了该事件的订阅者就会接收不到该事件。

3.EventBus黏性事件

EventBus除了普通事件也支持粘性事件。可以理解成：订阅在发布事件之后，但同样可以收到事件。订阅/解除订阅和普通事件一样，但是处理订阅的方法有所不同，需要注解中添加sticky = true。

用法展示：

@Subscribe(priority = 100,sticky = true) public void onToastEvent(ToastEvent event){ Toast.makeText(MainActivity.this,event.getContent(),Toast.LENGTH_SHORT).show(); EventBus.getDefault().cancelEventDelivery(event); }

这样，假设一个ToastEvent 的事件已经发布，此时还没有注册订阅。当设置了sticky = true，在ToastEvent 的事件发布后，进行注册。依然能够接收到之前发布的事件。

不过这个时候，发布事件的方式就改变了。

EventBus.getDefault().postSticky(new ToastEvent("Toast,发个提示，祝大家新年快乐！"));

我们如果不再需要该粘性事件我们可以移除

EventBus.getDefault().removeStickyEvent(ToastEvent.class);

或者调用移除所有粘性事件

EventBus.getDefault().removeAllStickyEvents();

4.EventBus配置

EventBus在2.3版本中添加了EventBuilder去配置EventBus的各方各面。

比如：如何去构建一个在发布事件时没有订阅者时保持沉默的EventBus。

EventBus eventBus = EventBus.builder().logNoSubscriberMessages(false).sendNoSubscriberEvent(false).build();

通过上述设置，当一个事件没有订阅者时，不会输出log信息，也不会发布一条默认信息。

配置默认的EventBus实例，使用EventBus.getDefault()是一个简单的方法。获取一个单例的EventBus实例。EventBusBuilder也允许使用installDefaultEventBus方法去配置默认的EventBus实例。

注意：不同的EventBus 的对象的数据是不共享的。通过一个EventBus 对象去发布事件，只有通过同一个EventBus 对象订阅事件，才能接收该事件。所以以上使用EventBus.getDefault()获得的都是同一个实例。