开源库之EventBus使用详解

其他 2021-02-28 22:24:33 阅读次数: 0

简介

EventBus是一种用于Android的发布/订阅事件总线。简化了应用程序内各组件间、组件与后台线程间的通信。常用于Activity、Fragment和后台Service之间通信、传递数据。

GitHub地址：https://github.com/greenrobot/EventBus

API

eventbus

作为一个消息总线主要有三个组成部分:事件（Event）、事件订阅者（Subscriber）、事件发布者（Publisher）。

使用

  • 在模块的 build.gradle 构建脚本中添加EventBus依赖
dependencies {
    ...
   implementation 'org.greenrobot:eventbus:3.1.1'
}
  • 定义事件，事件可以是任意普通的Java对象，没有任何特殊的要求
public class MessageEvent {

    private String msg;

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

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }
}
  • 订阅事件
 @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_event_bus);
        //  注册订阅者
        EventBus.getDefault().register(this);
    }

    // 事件处理方法
    @Subscribe(threadMode = ThreadMode.MAIN)
    public void onMainEvent(MessageEvent event) {
        Log.e(TAG, "onMainEvent方法接收的数据---->" + event.getMsg());
    }

     // 注销订阅者
    @Override
    protected void onDestroy() {
        super.onDestroy();
        EventBus.getDefault().unregister(this);
    }
  • 发布事件, 在需要的地方发布事件，所有订阅了该类型事件并已注册的订阅者将收到该事件。
   EventBus.getDefault().post(new MessageEvent("main"));

线程模式

使用线程模式来指定订阅者方法的线程

  1. ThreadMode.POSTING

    订阅者方法将在发布事件所在的线程中被调用。这是默认的线程模式,事件的传递是同步的，一旦发布事件，所有该模式的订阅者方法都将被调用。这种线程模式意味着最少的性能开销，因为它避免了线程的切换。因此，对于不要求是主线程并且耗时很短的简单任务推荐使用该模式。使用该模式的订阅者方法应该快速返回，以避免阻塞发布事件的线程，这可能是主线程。

  2. ThreadMode.MAIN

    订阅者方法将在主线程（UI线程）中被调用。因此，可以在该模式的订阅者方法中直接更新UI界面。如果发布事件的线程是主线程，那么该模式的订阅者方法将被直接调用。使用该模式的订阅者方法必须快速返回，以避免阻塞主线程。

  3. ThreadMode.MAIN_ORDERED

    订阅者方法将在主线程（UI线程）中被调用。因此，可以在该模式的订阅者方法中直接更新UI界面。事件将先进入队列然后才发送给订阅者，所以发布事件的调用将立即返回。这使得事件的处理保持严格的串行顺序。使用该模式的订阅者方法必须快速返回，以避免阻塞主线程

  4. ThreadMode.BACKGROUND

    订阅者方法将在后台线程中被调用。如果发布事件的线程不是主线程，那么订阅者方法将直接在该线程中被调用。如果发布事件的线程是主线程，那么将使用一个单独的后台线程，该线程将按顺序发送所有的事件。使用该模式的订阅者方法应该快速返回，以避免阻塞后台线程。

  5. ThreadMode.ASYNC

    订阅者方法将在一个单独的线程中被调用。因此，发布事件的调用将立即返回。如果订阅者方法的执行需要一些时间，例如网络访问，那么就应该使用该模式。避免触发大量的长时间运行的订阅者方法，以限制并发线程的数量。EventBus使用了一个线程池来有效地重用已经完成调用订阅者方法的线程。

具体示例

  • ThreadMode.POSTING
// 在EventBusActivity 中进行注册订阅、处理订阅者方法、注销订阅
public class EventBusActivity extends AppCompatActivity {
    
    
  private static final String TAG = EventBusActivity.class.getSimpleName();
  @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_event_bus);
        //  注册订阅者
        EventBus.getDefault().register(this);
    }

    // 事件处理方法
    @Subscribe(threadMode = ThreadMode.POSTING)
    public void onPostingEvent(MessageEvent event) {
        Log.e(TAG, "onPostingEvent方法接收的数据---->" + event.getMsg()+ "---所在线程---->" + Thread.currentThread().getName());
    }

     // 注销订阅者
    @Override
    protected void onDestroy() {
        super.onDestroy();
        EventBus.getDefault().unregister(this);
    }
}


//  在EventSecondActivity 进行发送事件
public class EventSecondActivity extends AppCompatActivity implements View.OnClickListener {
    
    
    private static final String TAG = EventSecondActivity.class.getSimpleName();
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_event_second);

        Button btn = findViewById(R.id.btn);
        btn.setOnClickListener(this);
    }
    @Override
    public void onClick(View view) {
        switch (view.getId()) {
            case R.id.btn:
                // 在main 主线程调用
                EventBus.getDefault().post(new MessageEvent("posting"));
                break;
         }
    }
}

结果：
这里写图片描述

  • ThreadMode.MAIN
// EventBusActivity 代码
......

 @Subscribe(threadMode = ThreadMode.MAIN)
    public void onMainEvent(MessageEvent event) {

        Log.e(TAG, "onMainEvent方法接收的数据---->" + event.getMsg() + "---所在线程---->" + Thread.currentThread().getName());
    }

.......

// EventSecondActivity 进行发送事件
.......

EventBus.getDefault().post(new MessageEvent("main"));
  • ThreadMode.BACKGROUND
// EventBusActivity 代码
   @Subscribe(threadMode = ThreadMode.BACKGROUND)
    public void onBackgroundEvent(MessageEvent event) {
        Log.e(TAG, "onBackgroundEvent方法接收的数据---->" + event.getMsg() + "---所在线程---->" + Thread.currentThread().getName());
    }

 // EventSecondActivity 进行发送事件
 new Thread(new Runnable() {
     @Override
     public void run() {
      EventBus.getDefault().post(new MessageEvent("background"));
         Log.e(TAG, "---所在线程为--->" + Thread.currentThread().getName());
      }
 }).start();

结果：
这里写图片描述

  • ThreadMode.ASYNC
// EventBusActivity 代码
 @Subscribe(threadMode = ThreadMode.ASYNC)
    public void onAsyncEvent(MessageEvent event) {
        Log.e(TAG, "onAsyncEvent 方法接收的数据---->" + event.getMsg() + "---所在线程---->" + Thread.currentThread().getName());
    }
// EventSecondActivity 进行发送事件
 EventBus.getDefault().post(new MessageEvent("async"));

结果：
这里写图片描述

事件优先级

EventBus支持在定义订阅者方法时指定事件传递的优先级。默认情况下，订阅者方法的事件传递优先级为0。数值越大，优先级越高。在相同的线程模式下，更高优先级的订阅者方法将优先接收到事件 

// EventBusActivity 代码
@Subscribe(threadMode = ThreadMode.MAIN, priority = 1)
    public void onMainEvent(MessageEvent event) {

        Log.e(TAG, "onMainEvent方法接收的数据---->" + event.getMsg() + "---所在线程---->" + Thread.currentThread().getName());
    }

    @Subscribe(threadMode = ThreadMode.MAIN, priority = 2)
    public void onMainEvent_2(MessageEvent event) {
        Log.e(TAG, "onMainEvent_2方法接收的数据---->" + event.getMsg() + "---所在线程---->" + Thread.currentThread().getName());
    }

    @Subscribe(threadMode = ThreadMode.MAIN, priority = 3)
    public void onMainEvent_3(MessageEvent event) {

        Log.e(TAG, "onMainEvent_3方法接收的数据---->" + event.getMsg() + "---所在线程---->" + Thread.currentThread().getName());
    }

注意：优先级只有在相同的线程模式下才有效。
结果：
这里写图片描述

粘性事件

如果先发布了事件，然后有订阅者订阅了该事件，那么除非再次发布该事件，否则订阅者将永远接收不到该事件。此时，可以使用粘性事件。发布一个粘性事件之后，EventBus将在内存中缓存该粘性事件。当有订阅者订阅了该粘性事件，订阅者将接收到该事件

示例：

// EventBusActivity 代码
TextView tv_sticky = findViewById(R.id.tv_sticky);
tv_sticky.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                EventBus.getDefault().postSticky(new MessageEvent("sticky"));
            }
  });

 Button btn = findViewById(R.id.btn);
 btn.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
       Intent intent = new Intent(EventBusActivity.this, EventSecondActivity.class);
       startActivity(intent);
    }
 });

// EventSecondActivity
 @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_event_second);
        EventBus.getDefault().register(this);
  }

  @Subscribe(threadMode = ThreadMode.MAIN, sticky = true)
    public void onStickyEvent(MessageEvent event) {
        Log.e(TAG,"onStickyEvent 粘性事件接收---------->"+event.getMsg());
    }

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

    }

结果：
这里写图片描述

相关API:

  • removeStickyEvent(Object event)
    移除指定的粘性事件
  • removeStickyEvent(Class eventType);
    移除指定类型的粘性事件
  • removeAllStickyEvents();
    移除所有的粘性事件

EventBus 插件

项目使用EventBus ，里面各种事件乱窜，这个插件对于项目中事件横飞的情况，还是非常好用的

  • 在AndroidStudio Setting——–>Plugins
    这里写图片描述
  • 点击post事件小图标，会直接列出所有接收的地方
    这里写图片描述
  • 点击接收事件的图标，会直接列出所有发送事件的地方：
    这里写图片描述

猜你喜欢

转载自blog.csdn.net/xufei5789651/article/details/82667995
今日推荐
面壁智能发布 Eurux-8x22B 开源大模型 —— 堪称「理科状元」
开源日报 | 谷歌扶持鸿蒙上位；开源Rabbit R1；Docker加持的安卓手机；微软的焦虑和野心；海尔电器把开放平台关了
中国码农的“35岁魔咒”
蘭雅 CorelDRAW 插件 2024.5.1 国际劳动节版，免费下载
Arc Browser for Windows 1.0 正式 GA
90后程序员开发视频搬运软件、不到一年获利超 700 万，结局很刑！
周排行
【转】spring中对控制反转和依赖注入的理解
tms webcore 安装和使用
java程序员进阶相关书籍
SpringMVC接受请求参数、
如何保存训练好的机器学习模型
MyEclipse、Eclipse设置项目JDK的三个地方
商超行业微信小程序开发定制一般多少钱 （行业技术人员解读）
Markdown编辑器语言——30分钟入门到到精通
Linux系统下MongoDB的简单安装与基本操作
Power Strings
每日归档
更多
2024-05-07(14)
2024-05-06(40)
2024-05-05(0)
2024-05-04(7)
2024-05-03(19)
2024-05-02(0)
2024-05-01(4)
2024-04-30(1)
2024-04-29(40)
2024-04-28(0)

代码天地 © 2018 codetd.com

境外服务器   最新电视剧2022