Android事件总线AndroidEventBus的使用
阅读原文时间:2021年04月20日阅读:1

今天学了了一个开源框架AndroidEventBus,该框架主要针对不同组件间的通信,如Activity、Fragment、Service等,在没有AndroidEventBus前,我们如果需要在不同的Activity或Fragment间通信,一般会选择使用广播来处理,在某个Activity中注册广播,在另一个Activity中发送广播,这么做虽然可以达到通信的目的,但是编码起来非常繁琐,AndroidEventBus的出现,简化了组件间的通信,下面我记录使用AndroidEventBus的步骤:

1、首先在github上下载AndroidEventBus,地址为:https://github.com/bboyfeiyu/AndroidEventBus

2、新建Android工程,导入AndroidEventBus的jar包androideventbus-1.0.2.jar

3、在Activity中注册和取消注册EventBus,一般在onCreate方法中注册,在OnDestory方法中取消注册,如下代码:

public class YourActivity extends Activity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        EventBus.getDefault().register(this);
    }

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

}

4、post消息和处理消息

AndroidEventBus框架的主体类就是EventBus这个单例类,通过该类的post方法,可以发送一个消息,如下代码:

String msg = "hello world";
EventBus.getDefault().post(msg, "update");

上面的post方法有两个参数,第一个为Object类型,第二个为String类型,第一个参数指定了要传给接受方法的值,第二个参数则指定了一个tag,然后在接受消息的方法中,对应tag的方法会被执行

5、编写消息处理方法

@Subscriber(tag = "update")
public void update(String msg){

}

上面的消息处理方法,对应了之前post的方法,由于post的值为String类型,所以这里update方法的参数也是String类型,这里使用注解的方式给方法加上了tag,tag名为update,正好对应之前post方法中的update参数,所以,当前面的post方法被调用时,转而会执行这里的update方法,这就是AndroidEventBus的主要使用步骤了,下面用一个demo来展示该框架的使用

首先是MainActivity的布局文件activity_main.xml

<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">

    <Button 
        android:layout_width="fill_parent"
        android:layout_height="wrap_content"
        android:onClick="toOtherActivity"
        android:text="进入OtherActivity,并在其中更新下面的hello文字"
        android:layout_marginTop="10dp"
        />

    <Button 
        android:layout_width="fill_parent"
        android:layout_height="wrap_content"
        android:onClick="updateProgressbar"
        android:text="更新进度条"
        android:layout_marginTop="10dp"
        />

    <TextView 
        android:id="@+id/tv"
        android:layout_width="fill_parent"
        android:layout_height="fill_parent"
        android:textSize="22sp"
        android:gravity="center"
        android:text="hello"
        />

</LinearLayout>

页面效果图如下:

MainActivity的代码如下:

package com.example.test01;

import org.simple.eventbus.EventBus;
import org.simple.eventbus.Subscriber;

import android.app.Activity;
import android.content.Intent;
import android.os.Bundle;
import android.view.View;
import android.widget.TextView;

public class MainActivity extends Activity {

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

    //当在OtherActivity点击了更新按钮时,该方法会被执行,
    //接受从OtherActivity传过来的参数,并显示在界面上
    @Subscriber(tag = "update")
    public void update(String msg){
        TextView tv = (TextView) findViewById(R.id.tv);
        tv.setText(msg);
    }

    //点击按钮跳转到OtherActivity
    public void toOtherActivity(View view){
        startActivity(new Intent(this, OtherActivity.class));
    }

    //点击按钮跳转到TestProgressBarActivity
    public void updateProgressbar(View view){
        startActivity(new Intent(this, TestProgressBarActivity.class));
    }

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

}

点击第一个按钮后,跳转到OtherActivity,该Activity中只有一个按钮,点击按钮后更新MainActivity中的TextView,代码如下:

package com.example.test01;

import org.simple.eventbus.EventBus;

import android.app.Activity;
import android.os.Bundle;
import android.view.View;

public class OtherActivity extends Activity {

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

    //更新MainActivity
    public void updateClick(View view){
        String msg = "this msg was send by OtherActivity";
        //这里post了一个带tag的消息,将msg传给MainActivity,MainActivity中带有名为update的tag的方法会被执行
        EventBus.getDefault().post(msg, "update");
    }

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

}

点击MainActivity中的第二个按钮,会跳转到TestProgressBarActivity,该Activity的布局文件就是一个按钮和一个进度条,代码如下:

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical" >

    <Button 
        android:layout_width="fill_parent"
        android:layout_height="wrap_content"
        android:text="download"
        android:onClick="btnClick"
        />

    <ProgressBar 
        android:id="@+id/pb"
        android:layout_width="fill_parent"
        android:layout_height="wrap_content"
        style="@android:style/Widget.ProgressBar.Horizontal"
        android:layout_marginTop="20dp"
        />


</LinearLayout>

TestProgressBarActivity的代码中,使用AndroidEventBus框架更新进度条进度,代码如下:

package com.example.test01;

import org.simple.eventbus.EventBus;
import org.simple.eventbus.Subscriber;
import org.simple.eventbus.ThreadMode;

import android.app.Activity;
import android.os.Bundle;
import android.view.View;
import android.widget.ProgressBar;

public class TestProgressBarActivity extends Activity {

    private ProgressBar pb;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_testprogressbar);

        pb = (ProgressBar) findViewById(R.id.pb);
        EventBus.getDefault().register(this);
    }

    //模拟下载
    public void btnClick(View view){
        //这里post了一个带tag的消息,则下面对应该tag的方法会被执行
        EventBus.getDefault().post(view, "start download");
    }

    /**
     * 这里的mode属性指定了该方法执行在哪个线程,有三个取值:MAIN, POST, ASYNC
     * MAIN即该方法执行在UI线程,ASYNC即该方法执行在异步线程,POST则代表该方法
     * 执行在与被调用的post方法相同的线程中,这里因为是模拟耗时的网络操作,所以
     * 该方法一定要异步执行,若将mode改为MAIN,则界面会阻塞
     * @param view
     */
    @Subscriber(tag = "start download", mode = ThreadMode.ASYNC)
    public void startDownload(View view){
        int progress = 0;
        while(progress <= 100){
            progress += 10;
            //这里post当前的下载进度,下面与这里指定的tag相同的方法会被执行
            EventBus.getDefault().post(progress, "update progress");
            try {
                Thread.sleep(1000);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
        }
    }

    //该方法的参数就是上面post的数据,在这里更新UI,且在主线程执行该方法
    @Subscriber(tag = "update progress", mode = ThreadMode.MAIN)
    public void updateProgress(int progress){
        pb.setProgress(progress);
    }

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

}

AndroidEventBus总结:

AndroidEventBus框架为组件间的通信提供了一种简便的模式,通过发布订阅模式,使得不同的组件间可以很方便的通信,框架的核心是一个单例模式实现的类EventBus,该类的内部使用反射机制将使用@Subscriber注解的方法存放在一个Map中,当调用EventBus的post方法时,会根据post方法的tag参数,从Map中找到对应的方法,将参数传递给该方法并调用之,这就是AndroidEventBus框架的思想。

AndroidEventBus为退出Android应用提供了一种简便的思路,在以前,我们退出Android应用,一般使用一个BaseActivity,用一个List保存每一个打开的Activity,退出时通过遍历List,一个个关闭Activity以达到退出应用的功能,有了AndroidEventBus后,我们可以这么做:

1、定义一个BaseActivity,代码如下:

package com.example.test01;

import org.simple.eventbus.EventBus;
import org.simple.eventbus.Subscriber;

import android.app.Activity;
import android.os.Bundle;

public class BaseActivity extends Activity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        EventBus.getDefault().register(this);
    }

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

    @Subscriber(tag = "exit")
    public void close(String msg){
        finish();
    }

}

该Activity中注册和取消注册EventBus,并且还包含一个tag为exit的方法,在该方法中调用了finish方法,接下来,其他的Activity都继承BaseActivity,并且在需要退出应用时,做如下的调用就行了:

package com.example.test01;

import org.simple.eventbus.EventBus;

import android.os.Bundle;

public class NewActivity extends BaseActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
    }

    /**
     * 退出应用时调用该方法,则所有tag为exit的方法都会被调用,
     * 而在BaseActivity中,tag为exit的方法里又调用了finish方法,
     * 则所有的Activity都会被结束掉,从而达到退出应用的目的
     */
    public void exitApp(){
        EventBus.getDefault().post("", "exit");
    }

}

在退出整个应用时,由于post了一个tag为exit的消息,则所有的Activity都会调用close方法,达到退出应用的目的。这里需要注意的是,使用@Subcriber注解的方法,一定要包含一个参数代表传过来的消息,如果没有参数的话,则发送的消息不会被接收到,例如上面的代码中,BaseActivity里注解的close方法,就包含一个String类型的参数,如果没有这个参数,则不会接收到退出应用的消息。

参考文章:http://www.csdn.net/article/2015-04-22/2824531/1

Demo源码下载