当前位置: 首页 > 工具软件 > EventBus > 使用案例 >

EventBus 的使用

伍昱
2023-12-01

一、前言

在进行Android开发时,当涉及大量组件之间的通信,使用Intent、Handler、Broadcast进行模块间通信、模块与后台线程进行通信时,代码量大,而且高度耦合。EventBus简化了应用程序内各个组件之间进行通信的复杂度,尤其是碎片之间进行通信的问题,可以避免由于使用广播通信而带来的诸多不便。(github地址:EventBus

二、关于EventBus的概述

1、三个角色

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

2.四种线程模型

EventBus3.0有四种线程模型,分别是:

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

三、EventBus的使用

1、导入依赖

 implementation("org.greenrobot:eventbus:3.3.1")

2、自定义事件封装类

定义一个事件的封装对象。在程序内部就使用该对象作为通信的信息:

public class AsnDetailEventBus {

    private String asnCode;
    private String lotNo;
    private String ItemCode;
    private String ItemName;
    private String packageUnit;
    private String status;
    private String sortCategory;
    private String planQty;
    private String receiveQty;
    private String putawayQty;

    public String getAsnCode() {
        return asnCode;
    }

    public void setAsnCode(String asnCode) {
        this.asnCode = asnCode;
    }

    public String getLotNo() {
        return lotNo;
    }

    public void setLotNo(String lotNo) {
        this.lotNo = lotNo;
    }

    public String getItemCode() {
        return ItemCode;
    }

    public void setItemCode(String itemCode) {
        ItemCode = itemCode;
    }

    public String getItemName() {
        return ItemName;
    }

    public void setItemName(String itemName) {
        ItemName = itemName;
    }

    public String getPackageUnit() {
        return packageUnit;
    }

    public void setPackageUnit(String packageUnit) {
        this.packageUnit = packageUnit;
    }

    public String getStatus() {
        return status;
    }

    public void setStatus(String status) {
        this.status = status;
    }

    public String getSortCategory() {
        return sortCategory;
    }

    public void setSortCategory(String sortCategory) {
        this.sortCategory = sortCategory;
    }

    public String getPlanQty() {
        return planQty;
    }

    public void setPlanQty(String planQty) {
        this.planQty = planQty;
    }

    public String getReceiveQty() {
        return receiveQty;
    }

    public void setReceiveQty(String receiveQty) {
        this.receiveQty = receiveQty;
    }

    public String getPutawayQty() {
        return putawayQty;
    }

    public void setPutawayQty(String putawayQty) {
        this.putawayQty = putawayQty;
    }

    public AsnDetailEventBus(String asnCode, String lotNo, String itemCode, String itemName, String packageUnit, String status, String sortCategory, String planQty, String receiveQty, String putawayQty) {
        this.asnCode = asnCode;
        this.lotNo = lotNo;
        ItemCode = itemCode;
        ItemName = itemName;
        this.packageUnit = packageUnit;
        this.status = status;
        this.sortCategory = sortCategory;
        this.planQty = planQty;
        this.receiveQty = receiveQty;
        this.putawayQty = putawayQty;
    }
}

3、注册事件

在Activity或者Fragment里订阅事件时,注册EventBus。一般选择在Activity的onCreate()方法里去注册EventBus,在onDestory()方法里,去解除注册。

注册事件

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

解除注册

    @Override
    public void onDestroy() {
        //移除所有粘性事件
        EventBus.getDefault().removeAllStickyEvents();
        //解除注册
        EventBus.getDefault().unregister(this);
        super.onDestroy();
    }

4、发布事件

 // 发布粘性事件
EventBus.getDefault().postSticky(asnDetailEventBus )
 // 发布普通事件
 EventBus.getDefault().post(messageEvent);

5、处理事件

//处理黏性事件
@Subscribe(threadMode = ThreadMode.MAIN,sticky = true)
    public void StickyEventBus(AsnDetailEventBus event){
        //TODO
    }
//处理普通事件
@Subscribe(threadMode = ThreadMode.MAIN)
public void eventBus(AsnDetailEventBus event) {
     //TODO
}

四、 普通事件与粘性事件

所谓粘性事件,就是在发送事件之后再订阅该事件也能收到该事件。请注意这里与普通事件的区别,普通事件是先注册在绑定。

 类似资料: