Android- EventBus 的使用

1、EventBus 介绍

EventBus是一种用于Android的事件发布-订阅总线，Gihub地址是：EventBus。它简化了应用程序内各个组件之间进行通信的复杂度，尤其是碎片之间进行通信的问题，可以避免由于使用广播通信而带来的诸多不便。

2、EventBus 的好处

为什么会选择使用EventBus来做通信？

简化了组件间交流的方式
对事件通信双方进行解耦
可以灵活方便的指定工作线程，通过ThreadMode
速度快，性能好
库比较小，不占内存
使用这个库的app多，有权威性

3、三个角色

1、Event：事件，它可以是任意类型，EventBus会根据事件类型进行全局的通知。
2、Subscriber：事件订阅者，在EventBus 3.0之前我们必须定义以onEvent开头的那几个方法，分别是onEvent、onEventMainThread、onEventBackgroundThread和onEventAsync，而在3.0之后事件处理的方法名可以随意取，不过需要加上注解@subscribe，并且指定线程模型，默认是POSTING。
3、Publisher：事件的发布者，可以在任意线程里发布事件。一般情况下，使用EventBus.getDefault()就可以得到一个EventBus对象，然后再调用post(Object)方法即可。
关系如下：

image.png

4、四种线程模型

EventBus3.0有四种线程模型，分别是：
POSTING：默认，表示事件处理函数的线程跟发布事件的线程在同一个线程。
MAIN：表示事件处理函数的线程在主线程(UI)线程，因此在这里不能进行耗时操作。
BACKGROUND：表示事件处理函数的线程在后台线程，因此不能进行UI操作。如果发布事件的线程是主线程(UI线程)，那么事件处理函数将会开启一个后台线程，如果果发布事件的线程是在后台线程，那么事件处理函数就使用该线程。
ASYNC：表示无论事件发布的线程是哪一个，事件处理函数始终会新建一个子线程运行，同样不能进行UI操作。

5、EventBus的使用

5.1、引入依赖

implementation 'org.greenrobot:eventbus:3.2.0'

使用一般是四个步骤，定义事件->注册订阅->发布事件 ->处理事件

5.2.1、定义事件

public class MessageWrap {
    public final String message;

    public static MessageWrap getInstance(String message) {
        return new MessageWrap(message);
    }

    private MessageWrap(String message) {
        this.message = message;
    }
}

5.2.2、注册订阅、处理事件

一般都是在在Activity或Fragment的生命周期中注册和注销订阅，视情况而定，这里是在Activity中注册，我们会添加一个监听的方法用于接收发布的消息，即onGetEventBus，这里我们需要为其加入注解Subscribe并指定线程模型为主线程MAIN,通过TextView显示接收到的消息

 public class MainActivity extends AppCompatActivity {

    private TextView textView;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        textView = findViewById(R.id.text);
        findViewById(R.id.main_btn).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                startActivity(new Intent(MainActivity.this, SecondActivity.class));
            }
        });
  
    }

    @Override
    protected void onStart() {
        super.onStart();
        //注册监听 已注册监听 不能继续注册
        if(!EventBus.getDefault().isRegistered(this)){
            EventBus.getDefault().register(this);
        }

    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        //取消监听
        EventBus.getDefault().unregister(this);
    }

    @Subscribe(threadMode = ThreadMode.MAIN)
    public void onGetEventBus(MessageWrap wrap) {
        textView.setText(wrap.message);
    }
}

5.2.3.发布事件

在另外一个Activity中发布事件，传递一个字符串

public class SecondActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_second);
        findViewById(R.id.btn).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                publishContent();
            }
        });
    }
    private void publishContent() {
        String msg = "你好，EventBus";
        EventBus.getDefault().postSticky(MessageWrap.getInstance(msg));
    }
}

5.2.4、步骤
通过在MainActivity注册订阅，点击按钮跳转到另外的Activity中发布消息，在返回来第一个页面，你会发现已经成功了。

image.png

6、EventBus的粘性事件

所谓的黏性事件，就是指事件已经发出去后，在订阅者,依然能够接收到的事件。

使用黏性事件的时候有两个地方需要做些修改。一个是处理事件的地方

    @Subscribe(threadMode = ThreadMode.POSTING, sticky = true)
    public void onGetEventBus(MessageWrap wrap) {
        textView.setText(wrap.message);
    }

2、一个是发布事件的地方

    private void publishContent() {
        String msg = "你好，EventBus";
        EventBus.getDefault().postSticky(MessageWrap.getInstance(msg));
    }

按照上面的模式，我们先在第一个Activity中打开第二个Activity，然后在第二个Activity中发布黏性事件，并回到第一个Activity注册EventBus。根据测试结果，当按下注册按钮的时候，会立即触发上面的订阅方法从而获取到了黏性事件。

7、优先级

在Subscribe注解中总共有3个参数，上面我们用到了其中的两个（threadMode ,sticky ），这里我们使用以下第三个参数，即priority。它用来指定订阅方法的优先级，是一个整数类型的值，默认是0，值越大表示优先级越大。在某个事件被发布出来的时候，优先级较高的订阅方法会首先接受到事件。

这里有几个地方需要注意：
只有当两个订阅方法使用相同的ThreadMode参数的时候，它们的优先级才会与priority指定的值一致；
只有当某个订阅方法的ThreadMode参数为POSTING的时候，它才能停止该事件的继续分发。

在第二个activity中也注册一个订阅，然后设置 priority的优先级为1，同时在方法里面终止事件的继续分发

public class SecondActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_second);
        findViewById(R.id.btn).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                publishContent();
            }
        });
    }
    private void publishContent() {
        String msg = "你好，EventBus";
        EventBus.getDefault().postSticky(MessageWrap.getInstance(msg));
    }

    @Override
    protected void onStart() {
        super.onStart();
        EventBus.getDefault().register(this);
    }

    @Subscribe(threadMode = ThreadMode.POSTING, sticky = true,priority = 1)
    public void onGetEventBus(MessageWrap wrap) {
        Toast.makeText(this, ""+wrap.message, Toast.LENGTH_SHORT).show();
  //终止事件的继续分发
        EventBus.getDefault().cancelEventDelivery(wrap);
    }
}

在第一个Activity中，修改代码如下：
设置优先级为0,最低的优先级

 @Subscribe(threadMode = ThreadMode.POSTING, sticky = true,priority = 0)
    public void onGetEventBus(MessageWrap wrap) {
        textView.setText(wrap.message);
    }

然后点击运行，再第二个Activity发布事件，当前的Activity会弹出一个Toast,但是回到第一个Activity后，字体不会改变了，那是因为事件的分发已经被中止。