EventBus3.0+ 简单使用

简介

EventBus是由greenrobot 组织贡献的一个Android事件发布/订阅轻量级框架。

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

官网地址：http://greenrobot.org/eventbus/

引入依赖

implementation 'org.greenrobot:eventbus:3.1.1'

基本使用

EventBus的三要素

• Event：事件，可以是任意类型的对象。
• Subscriber：事件订阅者，在EventBus3.0之后，事件处理的方法可以随便取名，但是需要添加一个注解@Subscribe，并且要指定线程模型（默认为POSTING）。
• Publisher：事件发布者，可以在任意线程任意位置发送事件，直接调用EventBus的post(Object)方法。可以自己实例化EventBus对象，但一般使用EventBus.getDefault()就好了，根据post函数参数的类型，会自动调用订阅相应类型事件的函数。

EventBus的四种线程模型（ThreadMode）

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

使用步骤

1.构造事件类Event

	public class MessageEvent {
	
	    private String name;
	    private String password;
	
	    public MessageEvent(String name, String password) {
	        this.name = name;
	        this.password = password;
	    }
	
	    @Override
	    public String toString() {
	        return "MessageEvent{" +
	                "name='" + name + '\'' +
	                ", password='" + password + '\'' +
	                '}';
	    }
	}

2.构造订阅者逻辑

2.1 注册订阅者

EventBus.getDefault().register(this);

2.2 接收消息

既然要订阅了，当发送者发布消息，订阅者接收。

	/**
     * 定义处理接收的方法
     * @param messageEvent
     */
    @Subscribe(threadMode = ThreadMode.MAIN) // 四种线程模型可选择
    public void receiveEventBus(MessageEvent messageEvent){ // 参数必须是ClassEvent类型, 否则不会调用此方法
        receive_tv.setText(messageEvent.toString());
    }

2.3 解注册 (为防止内存泄漏）：EventBus.getDefault().unregister(this);

// 解注册，为防止内存泄漏
        EventBus.getDefault().unregister(this);

订阅者 完整代码如下：

public class MainEnventBusActivity extends AppCompatActivity {

    private TextView receive_tv;

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




        // 注册订阅者
        EventBus.getDefault().register(this);


        receive_tv = findViewById(R.id.receive_tv);

        findViewById(R.id.event_btn).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                Intent intent = new Intent(MainEnventBusActivity.this, SendActivity.class);
                startActivity(intent);
            }
        });

    }

    /**
     * 定义处理接收的方法
     * @param messageEvent
     */
    @Subscribe(threadMode = ThreadMode.MAIN)
    public void receiveEventBus(MessageEvent messageEvent){
        receive_tv.setText(messageEvent.toString());
    }
    
    @Override
    protected void onDestroy() {
        super.onDestroy();

        // 解注册，为防止内存泄漏
        EventBus.getDefault().unregister(this);
    }
}

3.事件发布者逻辑

在任意地方,调用发送事件
一旦执行了此方法， 所有订阅者都会执行事件对应的订阅方法。

注意： 发布者post方法参数是Object类型，也就是可以发布任何事件。订阅者接受消息时，参数和发布者发布的一致，即可被执行。
发布者也可以通过自己接收消息，订阅者也可以作为发布者发消息给自己。

EventBus.getDefault().post(new MessageEvent(“name”,”password”));

完整代码如下：

public class SendActivity extends AppCompatActivity {

    private TextView receive_stick_tv;

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

        receive_stick_tv = findViewById(R.id.receive_stick_tv);
        findViewById(R.id.send_btn).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                EventBus.getDefault().post(new MessageEvent("a bing ","123456")); // 发送事件，当然参数是Object，所以可以发送任何对象
            }
        });

   

    }
}

EnventBus粘性事件

之前说的使用方法，都是需要先注册(register)，再post,才能接受到事件；如果你使用postSticky发送事件，那么可以不需要先注册，也能接受到事件，也就是一个延迟注册的过程。

简单说，上面post直接发送的，事件会立即被消费，你不先注册，你就订阅（接收不到）不了。粘性事件说，你发送了这个事件没有被立即消费，缓存了，而是指在EventBus内部被缓存的纳新事件。直到 removeStickyEvent 删除掉。那么只要订阅了该粘性事件的所有方法，只要被register 的时候，就会被检测到，并且执行。订阅的方法需要添加 sticky = true 属性

原理:EventBus.为每个类(class)类型保存了最近一次被发送的事件–sticky.后续发送过来的**同类的sticky事件会自动替换之前的缓存事件,**当一个监听者向EventBus进行注册时,他会去请求缓存事件.这时,缓存的事件
就是立即自动发送给这个监听者,一定的延时性.

粘性事件简单使用

1.构造发送信息类：（和之前相同）

public class StickyEvent {
    public String msg;

    public StickyEvent(String msg) {
        this.msg = msg;
    }
}

2.发布消息：使用postSticky方法

EventBus.getDefault().postSticky(new StickyEvent(“我是粘性事件”));

3.接收消息：和之前的方法一样，只是多了一个 sticky = true 的属性。

@Subscribe(threadMode = ThreadMode.MAIN, sticky = true)
public void onEvent(StickyEvent event){
    tv_c_result.setText(event.msg);
}

4.注册：（和之前相同）

EventBus.getDefault().register(CActivity.this);

5. 解注册

EventBus.getDefault().removeAllStickyEvents();
EventBus.getDefault().unregister(CActivity.class);

参考：
Android框架之路——EventBus的使用