Android EventBus框架入门

灰太狼 2022-06-10 13:20 230阅读 0赞

在Android开发中可能会遇到过这样一种情况，两个Activity或者Activity与Service、Activity与后台线程、线程与线程之间需要频繁的进行通信，Android官方的解决方案有两种，一种是使用Handle，一种是使用广播，但是这两种方式都不是很好用，这时候就轮到EventBus出场了！EventBus就以非常简便的方式解决了这样的问题~

这里有一个我写的小[Demo][]，算是抛砖引玉吧。

EventBus它的思想其实和广播差不多（什么！不明白广播？这可是四大组件之一！可以百度一下），就是发送消息和接收消息，在EventBus中消息称为事件，同一时间发送事件的可以不止一个，同一时间接收事件的也可以不是一个。关于EventBus的思想，还可以参考计算机硬件中的总线。

好了，我们来看看如何使用EventBus吧~

1、这第一步肯定是配置Gradle了

> compile ‘org.greenrobot:eventbus:3.0.0’

2、事件类

我们使用EventBus传递事件的时候要传递一个对象，我们可以传递自定义类对象，也可以传递java类型对象，不过，由于它传递的是一个对象，所以如果要传递int类型的数据，要传递Integer！当然其他类型也是这样（好多人都会问，我传递一个数字怎么传不过去啊）

这里我自定义一个类吧~看代码：

package com.mql.www.eventbusdemo.events;
    
    /**
     *
     * Created by MQL on 2017/8/20.
     */
    
    public class MessageEvent {
    private String message;
    
    public MessageEvent(String message) {
        this.message = message;
    }
    
    public String getMessage() {
        return message;
    }
    
    public void setMessage(String message) {
        this.message = message;
    }
    }

非常简单的一个类，只有一个属性，geter和seter方法以及构造方法。这样这个自定义类就等着被使用吧~

2、注册，接收事件

这里先看看整体代码，代码下面进行解释：

public class MainActivity extends AppCompatActivity {
    private TextView tv_meaasge;
    private Button btn_message;
    
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
    
        EventBus.getDefault().register(this);//注册
    
        tv_meaasge = (TextView)findViewById(R.id.main_tv);
        tv_meaasge.setText("MainActivity");
    
        btn_message = (Button)findViewById(R.id.main_btn);
        btn_message.setText("跳转到SecondActivity");
    
        btn_message.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                startActivity(new Intent(MainActivity.this,SecondActivity.class));
            }
        });
    }
    
    @Override
    protected void onDestroy() {
        super.onDestroy();
        EventBus.getDefault().unregister(this);//取消注册
    }
    
    //事件处理
    @Subscribe(threadMode = ThreadMode.MAIN)
    public void onMoonEvent(MessageEvent messageEvent){
        tv_meaasge.setText(messageEvent.getMessage());
    }
    }

（1）先看看注册吧，找出相关代码：

EventBus.getDefault().register(this);//注册

就这样一行代码，这个类或者说这个Activity就已经在EventBus上注册成功了，那么注册有什么作用呢，这就相当于告诉EventBus：以后只要有事件发送，你就要通知我，无论在哪个线程，无论在哪个类里面发送的。

（2）再看看取消注册，找出相关代码：

EventBus.getDefault().unregister(this);//取消注册

这样添加一行代码，这个类或者说这个Activity就取消了注册，这就相当于告诉EventBus：以后的事件不需要通知我了。这一行代码无论写在什么地方都可以生效，一般来讲当Activity销毁时必须要取消注册，所以我在onDestroy方法中取消了注册。

看完注册和取消注册，他们俩都有一个共同的特点就是都有一个EventBus.getDefault()，这句代码会返回一个默认的EventBus对象，当然我们也一个自己构造一个EventBus对象，这要使用EventBusBuilder类，很显然这是建造者模式（什么？不知道建造者模式是啥？没关系目前不需要知道），我们使用这个默认的EventBus对象已经能够满足日常需求了。

（3）事件处理，我们找出相关代码：

//事件处理
    @Subscribe(threadMode = ThreadMode.MAIN)
    public void onMoonEvent(MessageEvent messageEvent){
        tv_meaasge.setText(messageEvent.getMessage());
    }

首先我们可以看到这里有一个注解Subscribe（什么！不明白注解是什么？看看[这篇][Link 1]文章吧），这标识了这个方法为一个EventBus事件处理方法，注解里面还有一个参数，这个参数的含义是指定事件处理的线程，参数可取的值有四个：

POSTING（默认） //这是默认的参数，使用该参数时，事件处理的线程与事件发出的线程是同一个线程，也就是说，该方法接收的事件是从哪个线程
    中发出的，该方法的处理线程就是哪个线程。
    
    MAIN //事件处理线程是UI线程
    
    BACKGROUND //这个参数就有点意思了，如果接收的事件是从UI线程发出的，则事件处理会在新线程中运行，如果接收的事件是从子线程发出的，则
    事件处理线程和事件发出线程是同一个线程。
    
    ASYNC //事件处理在新线程中运行。

其次，我们这个方法不需要在任何地方手动调用，这就是注解的强大作用啦，当有事件发送时，EventBus会先去找这些被注解了的方法，然后进行事件类型匹配（如果现在不明白，先知道有这么回事，看完下面的事件发送就明白了），如果事件类型匹配上，EventBus就会自动调用这个方法~

最后，这个方法的名字可以随意起，阿猫阿狗都可以~

3、事件发送

我们还是先看下代码，下面解释：

public class SecondActivity extends AppCompatActivity {
    private TextView tv_second;
    private Button btn_second;
    
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_second);
    
        EventBus.getDefault().register(this);
    
        tv_second = (TextView)findViewById(R.id.second_tv);
    
        btn_second = (Button)findViewById(R.id.second_btn);
    
        btn_second.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                new Thread() {
                    @Override
                    public void run() {
                    //发送事件
                        EventBus.getDefault().post(new MessageEvent("我是SecondActivity传过来的message"));
                    }
                }.run();
    
            }
        });
    }
    }

我们来单独看看发送事件：

EventBus.getDefault().post(new MessageEvent("我是SecondActivity传过来的message"));

还是先获取了一个默认的EventBus对象，然后调用它的post方法，就这样，SecondActivity就成功通知EventBus发送了一条事件，可以看到我们是子线程中发送的，不过我们的接收方法已经用注解标识了在UI线程中运行。我们可以看到本次事件发送的事件类型是一个我们一开始定义好的MessageEvent类自定义类型，回过头去发现我们接受方法的参数也是一个MessageEvent类型，这样本次发送的事件就能被刚刚的接收方法接收并处理，刚刚说的类型匹配也就是这个意思。  
当然，如果我们发送其他类型的事件，比如发送一个String字符串，就像这样：

EventBus.getDefault().post("我是SecondActivity传过来的message");

那么我们刚刚的接收方法就无法接收到事件，因为事件类型不匹配。

对于一个发送事件来说，接收事件可能不只是一个，只要类型匹配成功，都可以接收。

这样，一个 发送事件—接收事件 的过程也就解释完了。

--------------------

MQL于2017年8月20日完成本文。

[Demo]: https://github.com/MQLX1004/EventBusDemo
[Link 1]: http://www.jianshu.com/p/1942ad208927