Android开发之EventBus讲解

Love The Way You Lie 2022-06-12 02:58 270阅读 0赞

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

**Event：**事件,可以是任意类型的对象。  
**Subscriber：**事件订阅者，接收特定的事件,在EventBus中，使用约定来指定事件订阅者以简化使用。即所有事件订阅都都是以onEvent开头的函数，具体来说，函数的名字是 onEvent,onEventMainThread,onEventBackgroundThread,onEventAsync这四个，这个和ThreadMode有关。  
**Publisher:**事件发布者，用于通知Subscriber有事件发生,可以在任意线程任意位置发送事件，直接调用EventBus的`post(Object)`方法，可以自己实例化EventBus对象，但一般使用默认的单例就好了：EventBus.getDefault()，根据post函数参数的类型，会自动调用订阅相应类型事件的函数。

### ThreadMode ###

前面说了，Subscriber函数的名字只能是那4个，因为每个事件订阅函数都是和一个`ThreadMode`相关联的，ThreadMode指定了会调用的函数。有以下四个ThreadMode：  
**PostThread：**事件的处理在和事件的发送在相同的进程，所以事件处理时间不应太长，不然影响事件的发送线程，而这个线程可能是UI线程。对应的函数名是onEvent。  
**MainThread:** 事件的处理会在UI线程中执行。事件处理时间不能太长，这个不用说的，长了会ANR的，对应的函数名是onEventMainThread。  
**BackgroundThread：**事件的处理会在一个后台线程中执行，对应的函数名是onEventBackgroundThread，虽然名字是BackgroundThread，事件处理是在后台线程，但事件处理时间还是不应该太长，因为如果发送事件的线程是后台线程，会直接执行事件，如果当前线程是UI线程，事件会被加到一个队列中，由一个线程依次处理这些事件，如果某个事件处理时间太长，会阻塞后面的事件的派发或处理。  
**Async：**事件处理会在单独的线程中执行，主要用于在后台线程中执行耗时操作，每个事件会开启一个线程（有线程池），但最好限制线程的数目。  
根据事件订阅都函数名称的不同，会使用不同的ThreadMode，比如果在后台线程加载了数据想在UI线程显示，订阅者只需把函数命名为onEventMainThread。

使用步骤  
基本的使用步骤就是如下4步，  
定义事件类型：  
`public class MyEvent {}`  
定义事件处理方法：  
`public void onEventMainThread`  
注册订阅者：  
`EventBus.getDefault().register(this)`  
发送事件：  
`EventBus.getDefault().post(new MyEvent())`

实例  
下面我们来实现一个具体的例子来介绍EventBus的基本使用。  
需求如下：在MainActivity中注册EventBus事件，并实现事件响应方法，当点击MainActivity中的按钮时跳转到SecondActivity，当点击SecondActivity中的按钮时向MainActivity发送Event事件，当MainActivity收到事件后，将事件内容显示在TextView中。  
事件类Event

public class Event {
        private String messgae;
        public Event(String messgae) {
            this.messgae = messgae;
        }
        public String getMessgae() {
            return messgae;
        }
    }

MainActivity在OnCreate()函数中注册EventBus，在Ondestroy()函数中取消注册。

public class MainActivity extends AppCompatActivity { 
        @Bind(R.id.btn_open)
        Button mOpenBtn;
        @Bind(R.id.tv_showinfo)
        TextView mInfoTxt;
        @Override
        protected void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_main);
            ButterKnife.bind(this);
            //注册
            EventBus.getDefault().register(this);
        }
    
        /** * 事件响应方法 * 接收消息 * @param event */
        @Subscribe(threadMode = ThreadMode.MAIN)
        public void onEvent(Event event) {
            String msg = event.getMessgae();
            mInfoTxt.setText(msg);
        }
    
        //绑定点击事件
        @OnClick(R.id.btn_open)
        public void openSecondActivity(View view) {
                Intent intent = new Intent(MainActivity.this, SecondActivity.class);
                startActivity(intent);
        }
    
        @Override
        protected void onDestroy() {
            super.onDestroy();
            //反注册
            EventBus.getDefault().unregister(this);
        }
    }

SecondActivity

public class SecondActivity extends AppCompatActivity { 
        @Bind(R.id.btn_post)
        Button mPostBtn;
        @Override
        protected void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_second);
            ButterKnife.bind(this);
            mPostBtn.setOnClickListener(new View.OnClickListener() {
                @Override
                public void onClick(View v) {
                    new Thread(new Runnable() {
                        @Override
                        public void run() {
                            //发送事件
                            EventBus.getDefault().post(new Event("Just do it"));
                        }
                    }).start();
                }
            });
        }
    }