android EventBus订阅事件用法解析

た入场券 2021-11-11 08:04 390阅读 0赞

EventBus是一款针对Android优化的发布/订阅事件总线，简化了应用程序内各组件间、组件与后台线程间的通信，好处在于开销小，代码更优雅，以及将发送者和接收者解耦。

**1.EventBus的概述**  
Event：事件，可以是任意类型的对象。  
Subscriber：事件订阅者，在EventBus3.0之前消息处理的方法只能限定于onEvent、onEventMainThread、onEventBackgroundThread和onEventAsync，他们分别代表四种线程模型。而在EventBus3.0之后，事件处理的方法可以随便取名，但是需要添加一个注解@Subscribe，并且要指定线程模型（默认为POSTING）。  
Publisher：事件发布者，可以在任意线程任意位置发送事件，直接调用EventBus的post(Object)方法。可以自己实例化EventBus对象，但一般使用EventBus.getDefault()就可以了，根据post函数参数的类型，会自动调用订阅相应类型事件的函数。

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

**3.EventBus的基本操作(demo)**  
EventBus的五大基本操作事件

//自定义一个事件类
    public class MessageEvent {
        ...
    }
    
    //注册订阅事件
    EventBus.getDefault().register(this);
    
    //发送事件（默认是POSTING）
    EventBus.getDefault().post(messageEvent);
    
    //处理相应事件
    @Subscribe(threadMode = ThreadMode.MAIN)
    public void XXX(MessageEvent messageEvent) {
        ...
    }
    
    //取消注册订阅事件
    EventBus.getDefault().unregister(this);

接下来我们就用一个小Demo来阐述EventBus的使用  
首先是导包  
![在这里插入图片描述][20190805122000181.png]  
接下来按着步骤走，创建一个自定义事件类

package com.example.eventbus_demo;
    
    public class MessageEvent {
        private String mMsg;
    
        public MessageEvent(String msg) {
            mMsg = msg;
        }
    
        public String getmMsg() {
            return mMsg;
        }
    
    }

在MainActivity中注册和取消注册订阅事件

发布事件SecondActivity.java

package com.example.eventbus_demo;
    
    import androidx.appcompat.app.AppCompatActivity;
    
    import android.os.Bundle;
    import android.util.Log;
    import android.view.View;
    import android.widget.Button;
    import android.widget.TextView;
    
    import org.greenrobot.eventbus.EventBus;
    import org.greenrobot.eventbus.Subscribe;
    import org.greenrobot.eventbus.ThreadMode;
    
    public class SecondActivity extends AppCompatActivity {
        private Button btn_send;
        private TextView tv_message;
        @Override
        protected void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_main);
            initView();
            btn_send.setText("SendMsg");
            tv_message.setText("SecondActivity");
            btn_send.setOnClickListener(new View.OnClickListener() {
                @Override
                public void onClick(View view) {
                    EventBus.getDefault().post(new MessageEvent("Welcome To Dota"));
                    finish();
                }
            });
    
        }
    
        private void initView() {
            btn_send = findViewById(R.id.btn_sent);
            tv_message = findViewById(R.id.tv_message);
        }
    
    
    }

布局

<?xml version="1.0" encoding="utf-8"?>
    <LinearLayout
        xmlns:android="http://schemas.android.com/apk/res/android"
        xmlns:tools="http://schemas.android.com/tools"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical"
        tools:context=".MainActivity">
        <Button
            android:id="@+id/btn_sent"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:text="@string/send"/>
        <TextView
            android:id="@+id/tv_message"
            android:layout_width="match_parent"
            android:layout_height="56dp"
            android:text="@string/app_name"
            android:gravity="center_horizontal"/>
    
    </LinearLayout>

运行后的界面  
![在这里插入图片描述][2019080514435756.png]  
![在这里插入图片描述][2019080512243693.png]  
![在这里插入图片描述][2019080512250130.png]

**4.EventBus的粘性事件处理**  
粘性事件处理：粘性事件是你可以不需要先注册, 也能接受到事件，就是在发送事件之后再订阅该事件也能收到该事件；  
附上代码

package com.example.eventbus_demo;
    
    import androidx.appcompat.app.AppCompatActivity;
    
    import android.content.Intent;
    import android.os.Bundle;
    import android.util.Log;
    import android.view.View;
    import android.widget.Button;
    import android.widget.TextView;
    import android.widget.Toast;
    
    import org.greenrobot.eventbus.EventBus;
    import org.greenrobot.eventbus.Subscribe;
    import org.greenrobot.eventbus.ThreadMode;
    
    public class MainActivity extends AppCompatActivity {
        public static final String TAG = "MainActivity";
        private Button btn_send;
        private Button btn_Viscous;
        private TextView tv_message;
    
        @Override
        protected void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_main);
            initView();
            tv_message.setText("MainActivity");
            btn_send.setOnClickListener(new View.OnClickListener() {
                @Override
                public void onClick(View view) {
                    //转跳界面
                    Intent intent = new Intent(MainActivity.this,SecondActivity.class);
                    startActivity(intent);
                }
            });
    //        EventBus.getDefault().register(this);
    
    
            btn_Viscous.setOnClickListener(new View.OnClickListener() {
                @Override
                public void onClick(View view) {
                    //注册订阅事件
                    EventBus.getDefault().register(MainActivity.this);
                }
            });
        }
    
        private void initView() {
            btn_send = findViewById(R.id.btn_sent);
            tv_message = findViewById(R.id.tv_message);
            btn_Viscous = findViewById(R.id.btn_viscous);
        }
    
    //    @Subscribe(threadMode = ThreadMode.MAIN)
    //    //ThreadMode设置为MAIN，事件的处理会在UI线程中执行，用TextView来展示收到的事件消息
    //    public void OnEventMessage(MessageEvent messageEvent){
    //        tv_message.setText(messageEvent.getmMsg());
    //        Toast.makeText(MainActivity.this,messageEvent.getmMsg(),Toast.LENGTH_SHORT).show();
    //        Log.d(TAG, "OnEventMessage: ");
    //    }
    
        @Subscribe(threadMode = ThreadMode.POSTING,sticky = true)
        //粘性事件,发送事件之后再订阅该事件也能收到该事件
        public void onMoonStickyEvent(MessageEvent messageEvent){
            tv_message.setText(messageEvent.getmMsg());
            Toast.makeText(MainActivity.this,messageEvent.getmMsg(),Toast.LENGTH_SHORT).show();
            Log.d(TAG, "OnEventMessage: ");
        }
    
        @Override
        protected void onDestroy() {
            super.onDestroy();
            //取消注册订阅事件
            EventBus.getDefault().unregister(this);
        }
    
    }

SecondActivity.java

布局

<?xml version="1.0" encoding="utf-8"?>
    <LinearLayout
        xmlns:android="http://schemas.android.com/apk/res/android"
        xmlns:tools="http://schemas.android.com/tools"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical"
        tools:context=".MainActivity">
        <Button
            android:id="@+id/btn_sent"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:text="发送普通事件"/>
        <Button
            android:id="@+id/btn_viscous"
            android:text="发送粘性事件"
            android:layout_width="match_parent"
            android:layout_height="wrap_content" />
        <TextView
            android:id="@+id/tv_message"
            android:layout_width="match_parent"
            android:layout_height="56dp"
            android:text="FirstActivity"
            android:gravity="center_horizontal"/>
    
    </LinearLayout>

效果图  
这个是一开始运行起来的界面，我们点击send按钮，转跳到SecondActivity  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyODg5NDc2_size_16_color_FFFFFF_t_70]  
![在这里插入图片描述][20190805152444298.png]  
然后点击大宋粘性事件的按钮  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyODg5NDc2_size_16_color_FFFFFF_t_70 1]  
很明显，我们在粘性事件按钮点击时是有发送粘性事件的，可是我们看到界面只是回来到MainActivity上，文本并没有改变，当我们再次点击粘性事件的时候，文本就会发生变化（注册了订阅事件），也就是发送事件之后再订阅该事件也能收到该事件  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyODg5NDc2_size_16_color_FFFFFF_t_70 2]

[20190805122000181.png]: /images/20211109/4656c95cc7764b27a5fc82a3cb0bddad.png
[2019080514435756.png]: /images/20211109/45ed749ffc884ea7bf3808dd58e968ce.png
[2019080512243693.png]: /images/20211109/daee2849ad8b4a7db3d19a0f0fea243b.png
[2019080512250130.png]: /images/20211109/002ce7aa59544fce9f953a845234cf29.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyODg5NDc2_size_16_color_FFFFFF_t_70]: /images/20211109/5020eb51bd3441e4b985b3d5ac1ca880.png
[20190805152444298.png]: /images/20211109/c7d8c88645fc4bcb94f0e07b9a342bd7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyODg5NDc2_size_16_color_FFFFFF_t_70 1]: /images/20211109/7af4c76107d14ad5a85d9a736fc82969.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyODg5NDc2_size_16_color_FFFFFF_t_70 2]: /images/20211109/16f243acc8a34cd0acafde56ffc6eb27.png