从零开始“撸”出自己的EventBus(一)

转载文章请标明出处http://www.jianshu.com/p/476a3a6dc789
其他同系列文章

1. 从零开始“撸”出自己的EventBus(二)
2. 从零开始“撸”出自己的EventBus(三)

当初学Android的时候，无意间发现了EventBus这个库，就像发现了一片新大陆一样。居然可以直接在Android的组件之间互相传递数据，为啥作者就这么牛逼呢？为啥能弄出这么叼的东西？随着知识的不断累计，发现其实当初觉得非常神秘，遥不可及的东西，其实原理相当的简单。对，简单到你也可以写出来的。下面，我就来教教大家如何从零开始“撸”出自己的EventBus。当然，你得具备一定得Java基础以及Android基础，不然你也不会看到这篇文章～

原理

先来讲讲原理啊～网上得说法几乎都是讲EventBus是基于观察者模式的。嗯，那么究竟谁是观察者，谁是被观察者呢？EventBus这个东东本身是观察者还是被观察者？按照我的理解，EventBus它既不是观察者，也不是被观察者，它不过是连接观察者和被观察者之间的桥梁。那么观察者是谁？观察者就是在你调用EventBus.getDefault().register(this)中的'this',它可能是个Activity、Fragment，也可能是个Service啥的(其实更准确的说应该是其中你onEvent开头或标记了Subscribe注解的方法)。那么被观察者自然就是所有可以向EventBus传递消息对象。这里盗用一张EventBus官网的图。

EvenBus原理图

梦想起航

好的，了解了原理我们现在开始来“撸”代码。从第一步开始，首先建个工程，起名就叫MiniBus吧，毕竟我们没有人家强大。等我们强大起来就改名叫SuperBus。哈哈哈哈哈哈。。。。

首先新建个类就叫MiniBus,和工程名相同。首先明确其需要基于单例模式，毕竟不希望使用者可以new出来好几个MiniBus，那样的话这些观察者就没法管理了。单例这种东西对于身经百战的我们来说是So easy。在这里，我就随意选了一种单例的写法。

public class MiniBus {
    private MiniBus() {
    }

    private static class BusHolder {
        private static MiniBus instance = new MiniBus();
    }

    public static MiniBus getInstance() {
        return BusHolder.instance;
    }
}

然后呢？我们需要暴露出我们的方法。包括观察者注册的方法register()、观察者取消注册的方法unregister()、被观察者发送事件的方法post()。嗯，暂时就这三个方法吧。

//观察者注册
public void register(Object subscriber){}

//观察者取消注册
public void unregister(Object subscriber){}

//被观察者发送消息，在此暂时不考虑粘性事件等复杂情况
public void post(Object event){}

至此，MiniBus大致的骨架已经搭建好了，接下来就要依照这些骨架填充好其血肉啦(为啥感觉这句话这么血腥？)。

冲浪～

首先来看看register()方法该做一些什么工作。

初级方案

最刚开始我想的就是直接把注册的观察者直接存到一个List集合里面，然后当有post请求事件发出的时候遍历这些观察者拿到对应的该执行的方法，然后通过反射拿到这些方法去执行。当然，这种方法是可行的，但是存在一个问题。那就是每次有事件发出都要去遍历一遍观察者的所有方法，效率很低。

好一点的方案

改进的方案就是以牺牲空间换取时间的方法。在注册的时候直接遍历出该对象的有效方法，然后存储为和subscriber对应的Map类型的数据,这样的话，每次post事件发出是仅仅只需要遍历有效的方法，效率上要比初级方案遍历每次都遍历所有的方法要高很多。

更好的方案

第二种方案虽然提升了不小的效率，但是仍然会在每次请求的时候遍历所有的有效方法。通过仔细思考，在第二种方案上做一丝丝改动，就是不以subscriber为Map的key值，而是以event的类型作为Map的key值，这样的话就不用每次post请求可以直接通过key值取出对应的方法，都遍历一遍那么多的方法啦～

虽然第三种方案相对最好，但是这里我为了简单起见，选择了折中的第二种方案。下面我们就来徒手撸代码。

public class MiniBus {
    
    private MiniBus() {
    }

    private static class BusHolder {
        private static MiniBus instance = new MiniBus();
        //存储观察者以及其有效的观察者方法
        private static Map> subMethods = new HashMap<>();
    }

    public static MiniBus getInstance() {
        return BusHolder.instance;
    }

    public void register(Object subscriber) {

        Class subClass = subscriber.getClass();
        Method[] methods = subClass.getDeclaredMethods();
        List usefulMethods = new ArrayList<>();
        //遍历观察者所有的方法，拿到所有有效的方法
        for (Method method : methods) {
            if (checkIsUsefulMethod(method)) {
                usefulMethods.add(method);
            }
        }

        if (usefulMethods.size() > 0) {
            BusHolder.subMethods.put(subscriber, usefulMethods);
        }
    }
    
    /**
     * 判断一个方法是否是有效的观察者方法，
     * 在此先采用EventBus3.0版本以前的方式，
     * 也就是以onEvent开头的方法，返回值为void
     * 并且只有一个参数，即视为有效方法
     */
    private boolean checkIsUsefulMethod(Method method) {
        String methodName = method.getName();
        Class returnType = method.getReturnType();
        Class[] paramsClass = method.getParameterTypes();
        if (methodName.startsWith("onEvent")
                && returnType.equals(Void.TYPE)
                && paramsClass.length == 1) {
            return true;
        }
        return false;
    }
}

接下来看看unregister()方法的实现。那就简单了，直接移除该key值以及对应的数据就好了。

public void unregister(Object subscriber) {
    BusHolder.subMethods.remove(subscriber);
}

post()方法的实现刚才已经讲过了，就是遍历所有的观察者方法，然后比对事件类型，若事件类型相同即为对应的观察者方法，即对其发送post事件消息。

public void post(final Object event) {
        Class eventClass = event.getClass();
        Set