事件总线模式——实例讲解

上一篇博客我们讲解了事件总线模式的概念及其实现原理 ,我们在实际运用中,大多数是在Android开发中运用到事件总线模式,它实现了事件订阅者和事件发布者的解耦,让我们更加容易在actvity等组件间传递信息。这篇文章通过这个简单的实例,给大家说明EventBus实现的原理,一起来打造一个简单的事件总线框架。如果你明白了这个框架的设计原理,那么EventBus也就相差不大,两者比起来只是后者更加完善和高效。

由于是模仿EventBus写得,所以我也把这个“框架”称为EventBus,先来看一下我们怎么使用这个框架。

现在我们实现的一个效果是,有两个acivity如图MainActivity:当点击"click"按钮的时候,就会跳转到secondActivity,而secondActivity里面有两个按钮,点击以后,可以改变MainActivity里面TextView的文字。

这其实就是一个消息传递的过程,假设我们用EventBus,下面我们来看一下,代码是怎么写的。

public class MainActivity extends FragmentActivity {  

    Button btn;
    TextView text;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        EventBus.getInstance().register(this);
        btn = (Button) findViewById(R.id.btn);
        text = (TextView) findViewById(R.id.text);
        btn.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                startActivity(new Intent(MainActivity.this,SecondActivity.class));
            }
        });
    }  

    public void onEvent(Info i){
        Log.i("cky", i.msg);
    }  

    public void onEventMain(Info i){
        text.setText(i.msg);
    }  

    public void onEventMain(Info2 i){
        text.setText(text.getText()+i.msg);
    }
}  

可以看到,我们在onCreate()里面调用了EventBus.register(this),来注册事件然后又两者函数,一个是onEvent(),这个方法里面的代码,会在一个子线程中执行一个是onEventMain(),这个方法里面的代码,会在UI线程执行。在这里,我们改变了TextView中的文字。使用过EventBus的朋友,现在看来使用方式是不是跟EventBus很像(我就是想实现EventBus的效果啊)。EventBus对事件在不同线程中处理,有四种方式,但是我们这里只写了简单的两者,主线程和非主线程,这样代码更加简单,而且原理是一样的,会写两个,就会写多个。然后SecondActivity里面,大家一定知道是怎么回事,肯定是在点击里面调用了post()方法。

public class SecondActivity extends Activity {  

    Button btn2;
    Button btn3;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_second);
        btn2 = (Button) findViewById(R.id.btn2);
        btn2.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                EventBus.getInstance().post(new Info("信息1"));
            }
        });
        btn3 = (Button) findViewById(R.id.btn3);
        btn3.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                EventBus.getInstance().post(new Info2("信息2"));
            }
        });
    }
}  

就是这么简单,使用方法跟EventBus如出一辙。

大家可能会好奇到底怎么样用简单的代码,实现这样的效果,下面我带大家看我的代码。!

先看EventBus

public class EventBus {
    HashMap<Class<?>,ArrayList<Subscription>> subscriptionsByEventType =
            new HashMap<Class<?>,ArrayList<Subscription>>();
    MainThreadHandler mainThreadHandler = new MainThreadHandler(this,Looper.getMainLooper());
    AsyThreadHandler asyThreadHandler = new AsyThreadHandler(this);  

    private final static EventBus instance = new EventBus();
    public static EventBus getInstance(){
           return instance;
    }
    private EventBus(){};
}  

有几个地方:

1,将构造函数设为私有,使用了getInstance()来给外界提供EventBus实例,其实就是一个单例模式

2,有几个复杂的属性,首先是subscriptionsByEventType,这是一个map,key代表某个bean类。

使用过EventBus都知道,我们在传递信息的时候,要传递一个实体类,例如我上面的例子,就是Info这个类。

value值是一个ArrayList<Subscription>,Subscription的意义就是一个订阅,是一个我创建的实体类。这个类的具体含义留到后面讲。

剩下两个mainThreadHandler和asyThreadHandler,顾名思义就是分别用来处理主线程和子线程的,都是我创建的类。

看到这里可能大家有点糊涂,出现了三个类,别急,我一定会解释清楚。现在先让我们来看非常重要的register()方法。

public void register(Object subscriber){
        Class<?> clazz = subscriber.getClass();//获取订阅者的类型
        Method[] methods = clazz.getMethods();//获取该类的所有方法
        for(Method m:methods){//遍历方法
            String name = m.getName();//获取方法名
            if(name.startsWith("onEvent")){//判断方法名是否以"onEvent"开头             </span>
                Class<?>[] params = m.getParameterTypes();//获取该方法的参数类型
                ArrayList<Subscription> arr;
                if(subscriptionsByEventType.containsKey(params[0])){
                    arr = subscriptionsByEventType.get(params[0]);
                }else{
                    arr = new ArrayList<Subscription>();
                }
                int len = name.substring("onEvent".length()).length();//截取方法除"onEvent"部分
                Subscription sub;
                if(len==0){//如果剩余长度为0,说明是子线程中执行
                    sub =  new Subscription(subscriber,new SubscriberMethod(m,params[0],0));
                }else{//否则,在主线程执行
                    sub =  new Subscription(subscriber,new SubscriberMethod(m,params[0],1));
                }
                arr.add(sub);
                subscriptionsByEventType.put(params[0],arr);
            }
        }
    } 

从上面的注释我们可以看到,我们先获取了订阅者(例子中是MainActivity)的方法,找到onEvent开头的方法,获得它们的参数类型

然后判断subscriptionsByEventType是否有以这些参数类型为key的数据,如果没有,新建一个ArrayList<Subscription>。

然后我们先看Subscription

public class Subscription {
    Object subscriber;
    SubscriberMethod SubscriberMethod;
    public Subscription(Object subscriber, SubscriberMethod SubscriberMethod) {
        this.subscriber = subscriber;
        this.SubscriberMethod = SubscriberMethod;
    }
}  

它代表一个订阅,拥有subsriber,也就是订阅者

还有一个SubscriberMethod,这是订阅方法类

public class SubscriberMethod {
    Method m;
    int type;
    public SubscriberMethod(Method m, Class<?> param, int type) {
        this.m = m;
        this.type = type;
    }
}  

它有一个Method m属性,就是我们注册的方法,另外一个type就是标记,0代表m在子线程中执行,其余代表在主线程中执行。

所以总的来说register()通过遍历订阅者,找到订阅方法(onEvent(),onEventMain()),将方法包装成SubscriberMethod类,再将SubscriberMethod和订阅者一起,

包装成Subscription类。

而subscriptionsByEventType根据参数类型为key,所谓参数类型,在例子中就是Info.class和info2.class

为什么我们要用参数类型为键呢?我们来想,以后我们在post的时候,是这样调用post的:

EventBus.getINstance().post(new Info("信息"));  

我们要传进去一个参数,而EventBus的任务就是,调用所有注册了这个参数类型的订阅方法。

所有显然,我们要根据参数类型,找到这些方法,这是key是参数类型的原因了。

Ok,register()方法下来,最重要的一件事就是我们得到了subscriptionsByEventType

接下来我们就可以看post方法了

public void post(Object event){
        Class<?> clazz = event.getClass();
        ArrayList<Subscription> arr = subscriptionsByEventType.get(clazz);
        for(Subscription sub:arr){//遍历订阅
            if(sub.SubscriberMethod.type==0){
                asyThreadHandler.post(sub,event);
            }else{
                mainThreadHandler.post(sub,event);
            }
        }
    }  

post()方法里面,如同我们上面所说,获取了参数类型,然后在subscriptionsByEventType中查询所有改类型对应的订阅Subscription

对于Subscription,它有我们订阅类的所有信息。

首先根据type判断是在主线程还是子线程执行,然后调用一开始讲到的两个类的实例就好了。

我们先看asyThreadHandler,这个会在子线程执行

public class AsyThreadHandler {
    private EventBus eventBus;
    AsyThreadHandler(EventBus eventBus) {
        this.eventBus = eventBus;
    }  

    public void post(final Subscription sub, final Object event){
        new Thread(){
            @Override
            public void run() {
                eventBus.invoke(sub,event,sub.SubscriberMethod.m);
            }
        }.start();
    }
}  

代码很简单,其实它的post方法,就是启用了一个线程,然后在线程里面,调用了EventBus的invoke()方法。

我们看这个方法

public void invoke(final Subscription sub, final Object event,Method m){
        try {
            m.invoke(sub.subscriber,event);
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        } catch (InvocationTargetException e) {
            e.printStackTrace();
        }
    }  

其实只有一句话,就是调用了反射去执行方法。m是订阅方法,sub.subscriber就是订阅者,event就是post()方法传入的实体

这样我们就在子线程中调用了这个方法了,相当于MainActivity主动调用这个方法。

那么在主线程中呢,大同小异

public class MainThreadHandler extends Handler{
    private final EventBus eventBus;  

    MainThreadHandler(EventBus eventBus, Looper looper) {
        super(looper);
        this.eventBus = eventBus;
    }  

    @Override
    public void handleMessage(Message msg) {
        EventBus.getInstance().invoke(sub,event,sub.SubscriberMethod.m);
    }  

    Subscription sub;
    Object event;
    public void post(Subscription sub, Object event){
        this.sub = sub;
        this.event = event;
        sendEmptyMessage(0);
    }
}  

可以看到继承了handler,表明在主线程中调用。

post方法传递了一个空message,在handlerMessage()方法里面,又是调用了EventBus的invoke()方法。

殊途同归,最后都是调用EventBus的invoke()方法,不过一个在子线程中调用,一个在主线程中调用。

就这样,我们轻而易举得实现了EventBus的基本功能哦!

是不是觉得代码很简单,其实上面的代码,已经将EventBus框架的思路将清楚了,大家明白这思路,再看EventBus就容易多了。

原文地址:https://www.cnblogs.com/zll20153246/p/9097355.html

时间: 2024-08-07 21:16:46

事件总线模式——实例讲解的相关文章

EventBus 事件总线模式实例(发布/订阅事件)

在我们公司经常用到总线,具体的总线是什么让我理解我也不清楚,但是在这几个月下来,我已经知道总线如何使用,现在加上示例讲解总线如何使用. 1. 首先我们的新建一个类,这个类其实是用于总线传递的模型 using System; namespace PurchaseDevices.Model.CommonModel{/// <summary>/// 事件传递参数/// </summary>/// <typeparam name="T"></typep

【设计模式】事件总线模式

前言 事件总线模式(Event Bus Pattern)是发布/订阅模式的一种实现.它是一种集中式的事件处理机制,允许不同组件彼此通信,但又不相互依赖,实现松耦合.Grafana 开源项目的软件架构就采用了事件总线模式. 事件总线模式 事件总线模式包含如下组件: Event:不同组件间传递的数据.可广泛地说,事件可以分为三类:Event,Command 和 Request.三者的区分可以参考 Grafana 设计文档(在 Grafana 中,Request 被称为 Query) Bus:各通信组

事件总线模式

事件总线定义:事件总线是对发布-订阅模式的一种实现.它是一种集中式事件处理机制,允许不同的组件之间进行彼此通信而又不需要相互依赖,达到一种解耦的目的. 事件总线的处理流程: 发布订阅模式主要有两个角色: 发布方(Publisher):也称为被观察者,当状态改变时负责通知所有订阅者. 订阅方(Subscriber):也称为观察者,订阅事件并对接收到的事件进行处理. 发布订阅模式有两种实现方式: 简单的实现方式:由Publisher维护一个订阅者列表,当状态改变时循环遍历列表通知订阅者. 委托的实现

(转)php简单工厂模式实例讲解

简单工厂模式:①抽象基类:类中定义抽象一些方法,用以在子类中实现②继承自抽象基类的子类:实现基类中的抽象方法③工厂类:用以实例化对象 看完文章再回头来看下这张图,效果会比较好 采用封装方式 <?php class Calc{ /** * 计算结果 * * @param int|float $num1 * @param int|float $num2 * @param string $operator * @return int|float */ public function calculate

java代理模式实例讲解

下面这个是设计模式课上的例子: 1 import java.lang.reflect.InvocationHandler; 2 import java.lang.reflect.Method; 3 import java.lang.reflect.Proxy; 4 import java.util.List; 5 import java.util.Vector; 6 7 8 public class VectorProxy implements InvocationHandler { 9 10

PHP中“简单工厂模式”实例讲解

原创文章,转载请注明出处:http://www.cnblogs.com/hongfei/archive/2012/07/07/2580776.html 简单工厂模式:①抽象基类:类中定义抽象一些方法,用以在子类中实现②继承自抽象基类的子类:实现基类中的抽象方法③工厂类:用以实例化对象 看完文章再回头来看下这张图,效果会比较好 1 采用封装方式 2 3 <?php 4 class Calc{ 5 /** 6 * 计算结果 7 * 8 * @param int|float $num1 9 * @pa

PHP 单列模式实例讲解网址

1,http://blog.csdn.net/jungsagacity/article/details/7618587 2,http://www.cnblogs.com/lh460795/archive/2013/07/30/3225650.html

Android事件总线分发库EventBus3.0的简单讲解与实践

Android事件总线分发库EventBus的简单讲解与实践 导语,EventBus大家应该不陌生,EventBus是一款针对Android优化的发布/订阅事件总线.主要功能是替代Intent,Handler,BroadCast在Fragment,Activity,Service,线程之间传递消息.优点是开销小,代码更优雅.以及将发送者和接收者解耦.反正能帮助我们快速开发,这个确实是个好东西,其实鸿洋大神已经对源码作了一个较全面的剖析了 Android EventBus源码解析 带你深入理解Ev

Android 开源项目android-open-project工具库解析之(二) 高版本向低版本兼容,多媒体相关,事件总线(订阅者模式),传感器,安全,插件化,文件

六.Android 高版本向低版本兼容 ActionBarSherlock 为Android所有版本提供统一的ActionBar,解决4.0以下ActionBar的适配问题 项目地址:https://github.com/JakeWharton/ActionBarSherlock Demo地址:https://play.google.com/store/apps/details?id=com.actionbarsherlock.sample.demos APP示例:太多了..现在连google都