android EventBus订阅事件用法解析

原创 于 2019-08-05 15:28:35 发布 · 900 阅读 · 5 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

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的使用
首先是导包
在这里插入图片描述
接下来按着步骤走，创建一个自定义事件类

package com.example.eventbus_demo;

public class MessageEvent {
    private String mMsg;

    public MessageEvent(String msg) {
        mMsg = msg;
    }

    public String getmMsg() {
        return mMsg;
    }

}

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

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 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 TextView tv_message;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        initView();
        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);
    }

    private void initView() {
        btn_send = findViewById(R.id.btn_sent);
        tv_message = findViewById(R.id.tv_message);
    }
    
    @Subscribe(threadMode = ThreadMode.MAIN)
    //ThreadMode设置为MAIN，事件的处理会在UI线程中执行，用TextView来展示收到的事件消息
    public void OnEventMessage(MessageEvent messageEvent){
        tv_message.setText(messageEvent.getmMsg());
        Log.d(TAG, "OnEventMessage: ");
    }
    @Override
    protected void onDestroy() {
        super.onDestroy();
        //取消注册订阅事件
        EventBus.getDefault().unregister(this);
    }

}

发布事件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>

运行后的界面
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

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

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 org.greenrobot.eventbus.EventBus;
import org.greenrobot.eventbus.Subscribe;
import org.greenrobot.eventbus.ThreadMode;

public class SecondActivity extends AppCompatActivity {
    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_second);
        initView();
        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();
            }
        });
        btn_viscous.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                EventBus.getDefault().postSticky(new MessageEvent("粘性事件"));
                finish();
            }
        });
    }

    private void initView() {
        btn_send = findViewById(R.id.btn_sent);
        tv_message = findViewById(R.id.tv_message);
        btn_viscous = findViewById(R.id.btn_viscous);
    }


}

布局

<?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
在这里插入图片描述
在这里插入图片描述
然后点击大宋粘性事件的按钮
在这里插入图片描述
很明显，我们在粘性事件按钮点击时是有发送粘性事件的，可是我们看到界面只是回来到MainActivity上，文本并没有改变，当我们再次点击粘性事件的时候，文本就会发生变化（注册了订阅事件），也就是发送事件之后再订阅该事件也能收到该事件
在这里插入图片描述

评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值