Router—一个高效,使用方便,基于动态代理实现的Android事件总线库

项目地址:Router

代理模式的学习与应用介绍了代理模式的原理及简单使用方式,Router就是基于此实现了一个Android间组件、线程间方便通信的库。

项目背景

在Android中的,EventBus是开源最流行的事件总线库,大大简化了应用程序内各组件间、组件与后台线程间的通信。之前的个人项目NBAPlus也是使用EventBus来简化开发,但在使用过程中有一些问题。

  1. EventBus对IDE不是很友好,首先不能通过快捷键直接直接从方法处跳转到调用处,而且IDE会给出此方法未调用的提示,这在后面的项目维护中增加隐患,开发过程中方法调用也没有相应提示,
  2. EventBus以类型来判断注册者,这样常用的基本类型一般就不能再使用了,如int,String之类。所以每个回调方法都需要定义一种新的类型,即使两个方法有相同的参数,或只是个简单的基本类型。
  3. 在注册时EventBus做的事太多,方法的查找,类型的判断,尤其是3.0之前更是有大量的反射来查找方法名以onEvent开头的方法,如果一个类的方法数很多的时候,比如应用的主界面,这势必会延长加载的时间,对主界面我们希望能尽可能减少加载的时间。

看起来上面的都不是大问题,但有个重要的因素是,一般项目不是一个人来完成的,这样就增加了维护的成本,尤其当项目变得越来越大,或者项目增加新的成员开发时。

Router的特点

  1. 注册的时候花费时间可忽略不计,因为只是将对象添加到map里。
  2. 对IDE友好,使用时很方便。
  3. 直接通过方法调用,极大的减少定义类。
  4. 由于都是通过接口实现通信的方式,可以很方便的用在MVP模式中,并且你的View层不需要向Presenter内添加监听器。
  5. 已经在多个成熟的项目中使用。

使用

如果你之前使用过EventBus,那Router使用起来会更方便。

第一步,定义接口和方法,无任何要求,和一般接口、方法的定义无差别。

interface AnyInterface {
    void anyMethod(AnyType posting) ;
}

第二步,使用的类注册,并实现定义的接口。

class AnyClass implement AnyInterface {

    //register on a appropriate lifecycle or constructor
    Router.getInstance().register(this); 
    
    //it will be invoked on UI Thread
    void anyMethod(AnyType object)  {
        //do what you want
    }
}

第三步,方法调用

Router.getInstance().getReceiver(AnyInterface.class).anyMethod(AnyType object);

第四步,合适的时机取消订阅

Router.getInstance().unregister(this);

通过注解来决定方法被调用处所在的线程

 @Subscribe(runThread = RunThread.MAIN)
 @Subscribe(runThread = RunThread.POSTING)
 @Subscribe(runThread = RunThread.ASYNC)
 @Subscribe(runThread = RunThread.BACKGROUND)

四种方式,为减少学习成本,四中方式的作用和EvenetBus相同,但实现方式不同。

两种注解模式

模式1,在实现的方法处添加注解,这时方法会在注解指定的线程被调用,即使继承的同一个接口,但注解不同,调用的线程也不同,这也是默认的方式。使用如下:

@Subscribe(runThread = RunThread.BACKGROUND)
public void anyMethod(String msg) {
    ...
}

模式2,在定义接口的地方添加注解,需要事先设置模式:

Router.getInstance().setAnnotateMethodOnInterface(true);

interface TestRunThread {
     @Subscribe(runThread = RunThread.POSTING)
     void anyMethod(String posting) ;
}

这种模式下,所有被实现的该接口的方法,都会在这个被指定的线程被调用。

更多使用细节,见Router里的simple.

你可能感兴趣的:(Router—一个高效,使用方便,基于动态代理实现的Android事件总线库)