从零开始“撸”出自己的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。哈哈哈哈哈哈。。。。

<br />首先新建个类就叫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大致的骨架已经搭建好了,接下来就要依照这些骨架填充好其血肉啦(为啥感觉这句话这么血腥?)。<br />

冲浪~

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

初级方案

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

好一点的方案

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

更好的方案

第二种方案虽然提升了不小的效率,但是仍然会在每次请求的时候遍历所有的有效方法。通过仔细思考,在第二种方案上做一丝丝改动,就是不以subscriber为Map的key值,而是以event的类型作为Map的key值,这样的话就不用每次post请求可以直接通过key值取出对应的方法,都遍历一遍那么多的方法啦~<br />
虽然第三种方案相对最好,但是这里我为了简单起见,选择了折中的第二种方案。下面我们就来徒手撸代码。

public class MiniBus {
    
    private MiniBus() {
    }

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

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

    public void register(Object subscriber) {

        Class<?> subClass = subscriber.getClass();
        Method[] methods = subClass.getDeclaredMethods();
        List<Method> 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<Object> keys = BusHolder.subMethods.keySet();
        for (final Object key : keys) {
            List<Method> methods = BusHolder.subMethods.get(key);
            for (final Method method : methods) {
                if (method.getParameterTypes()[0].equals(eventClass)) {
                    //打开对私有方法的调用权限
                    method.setAccessible(true);
                    try {
                        method.invoke(key, event);
                    } catch (Exception e) {
                        e.printStackTrace();
                    }
                }
            }
        }

    }

至此,一个简单的EventBus原型已完成。虽然它还存在不少问题,但是EventBus最核心的功能已经实现。让我们建两个Activity试试我们自己徒手撸出来的EventBus。<br />

着陆

第一个Activity测试代码。

public class MainActivity extends AppCompatActivity {
    private boolean first = true;
    private int count = 0;

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

        MiniBus.getInstance().register(this);
    }

    @Override
    protected void onResume() {
        super.onResume();
        if(first){
            startActivity(new Intent(this, SecondActivity.class));
            first = false;
        }
    }

    //观察方法
    private void onEventMain(String str) {
        Toast.makeText(getApplicationContext(), str, Toast.LENGTH_SHORT).show();
        ((TextView) findViewById(R.id.tv))
                .setText("你点了" + (++count) + "下");
    }
}

第二个Activity测试代码。

public class SecondActivity extends AppCompatActivity {
    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_second);

        findViewById(R.id.bt).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                new Thread(){
                    @Override
                    public void run() {
                        MiniBus.getInstance().post("我帅");
                    }
                }.start();
            }
        });
    }
}

在第一个Activity里面定义了一个OnEventMain()的观察方法,向MiniBus注册了观察者,并在onResume()的时候直接跳转到第二个Activity。第二个Activity设置了一个点击事件,点击的时候通知第一个Activity。熟悉EventBus的朋友应该很熟悉,就和EventBus2.x版本的用法几乎一样。然后运行项目,发现点击按钮第一个Activity能成功接收并处理消息。Oh,yes!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,427评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,551评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,747评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,939评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,955评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,737评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,448评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,352评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,834评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,992评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,133评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,815评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,477评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,022评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,147评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,398评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,077评论 2 355

推荐阅读更多精彩内容