EventBus源码分析

分析下边代码
// Activity中注册反注册
EventBus.getDefault().register(this);
EventBus.getDefault().unregister(this);
// Activity中用于接收数据写的方法
public void onEventMainThread()
// 发送数据的页面
EventBus.getDefault().post(param);
1. register

EventBus.getDefault()是一个单例

    // 双重校验锁,防止并发,提高效率
    public static EventBus getDefault() {
        if (defaultInstance == null) {
            synchronized (EventBus.class) {
                if (defaultInstance == null) {
                    defaultInstance = new EventBus();
                }
            }
        }
        return defaultInstance;
    }

register方法:

private synchronized void register(Object subscriber, String methodName, boolean sticky, int priority) {
        // 调用 SubscriberMethodFinder类中的 findSubscriberMethods方法,
        // 传入 this,methodName,返回一个 List<SubscriberMethod> subscriberMethods
        List<SubscriberMethod> subscriberMethods = subscriberMethodFinder.findSubscriberMethods(subscriber.getClass(),
                methodName);
        // for循环扫描到的 方法,然后调用 subscribe,SubscriberMethod 中保存了 
        // method、threadMode、eventType,通过上边方法已经分析
        for (SubscriberMethod subscriberMethod : subscriberMethods) {
            subscribe(subscriber, subscriberMethod, sticky, priority);
        }
    }

subscriber:扫描的类,就是register(this)中的this;
methodName:写死的 onEvent,扫描该类中以 onEvent开头的方法;
sticky:
priority:优先级

调用 SubscriberMethodFinder 类中的 findSubscriberMethods方法,传入this,methodName,返回一个 List<SubscriberMethod> subscriberMethods,

// 遍历该类所有方法,根据 methodName 去匹配,匹配成功的 封装成 SubscriberMethod,然后返回 一个 List
List<SubscriberMethod> findSubscriberMethods(Class<?> subscriberClass, String eventMethodName) {
        String key = subscriberClass.getName() + '.' + eventMethodName;
        List<SubscriberMethod> subscriberMethods;
        synchronized (methodCache) {
            subscriberMethods = methodCache.get(key);
        }
        if (subscriberMethods != null) {
            return subscriberMethods;
        }
        subscriberMethods = new ArrayList<SubscriberMethod>();
        Class<?> clazz = subscriberClass;
        HashSet<String> eventTypesFound = new HashSet<String>();
        StringBuilder methodKeyBuilder = new StringBuilder();
        while (clazz != null) {
            String name = clazz.getName();
            if (name.startsWith("java.") || name.startsWith("javax.") || name.startsWith("android.")) {
                // Skip system classes, this just degrades performance
                break;
            }
 
            // 获取该类所有的方法
            Method[] methods = clazz.getMethods();
            // 遍历所有方法
            for (Method method : methods) {
                String methodName = method.getName();
                // 判断是否以 onEvent开头、是否是public、且不是static和abstract,是否是1个参数 
                // 如果都符合,就封装
                if (methodName.startsWith(eventMethodName)) {
                    int modifiers = method.getModifiers();
                    if ((modifiers & Modifier.PUBLIC) != 0 && (modifiers & MODIFIERS_IGNORE) == 0) {
                        Class<?>[] parameterTypes = method.getParameterTypes();
                        if (parameterTypes.length == 1) {
                            String modifierString = methodName.substring(eventMethodName.length());
                            ThreadMode threadMode;
                            if (modifierString.length() == 0) {
                                // 根据方法的后缀,确定threadMode,是枚举类型
                                threadMode = ThreadMode.PostThread;
                            } else if (modifierString.equals("MainThread")) {
                                threadMode = ThreadMode.MainThread;
                            } else if (modifierString.equals("BackgroundThread")) {
                                threadMode = ThreadMode.BackgroundThread;
                            } else if (modifierString.equals("Async")) {
                                threadMode = ThreadMode.Async;
                            } else {
                                if (skipMethodVerificationForClasses.containsKey(clazz)) {
                                    continue;
                                } else {
                                    throw new EventBusException("Illegal onEvent method, check for typos: " + method);
                                }
                            }
                            Class<?> eventType = parameterTypes[0];
                            methodKeyBuilder.setLength(0);
                            methodKeyBuilder.append(methodName);
                            methodKeyBuilder.append('>').append(eventType.getName());
                            String methodKey = methodKeyBuilder.toString();
                            if (eventTypesFound.add(methodKey)) {
                                // 这里将 method、threadMode、eventType传入构造方法,
                                // 封装成 SubscriberMethod,添加到list集合,然后返回
                                subscriberMethods.add(new SubscriberMethod(method, threadMode, eventType));
                            }
                        }
                    } else if (!skipMethodVerificationForClasses.containsKey(clazz)) {
                        Log.d(EventBus.TAG, "Skipping method (not public, static or abstract): " + clazz + "."
                                + methodName);
                    }
                }
            }
            // 扫描所有父类,并不是当前类
            clazz = clazz.getSuperclass();
        }
        if (subscriberMethods.isEmpty()) {
            throw new EventBusException("Subscriber " + subscriberClass + " has no public methods called "
                    + eventMethodName);
        } else {
            synchronized (methodCache) {
                methodCache.put(key, subscriberMethods);
            }
            return subscriberMethods;
        }
    }

继续 register中的方法,for 循环 扫描到的所有方法,然后调用 subscribe

for (SubscriberMethod subscriberMethod : subscriberMethods) {
      subscribe(subscriber, subscriberMethod, sticky, priority);
}

private final Map<Class<?>, CopyOnWriteArrayList<Subscription>> subscriptionsByEventType;

 // Must be called in synchronized block
    private void subscribe(Object subscriber, SubscriberMethod subscriberMethod, boolean sticky, int priority) {
        subscribed = true;
        Class<?> eventType = subscriberMethod.eventType;
        // 根据 subscriberMethod.eventType ,在 subscriptionsByEventType 中查找
        // CopyOnWriteArrayList<Subscription>,如果没有则创建

        // subscriptionsByEventType 是 Map集合,用于存储EventBus所有方法的地方
        // key: eventType,value: CopyOnWriteArrayList<Subscription>
        CopyOnWriteArrayList<Subscription> subscriptions = subscriptionsByEventType.get(eventType);
        // 把 传入的参数封装成 Subscription(subscriber, subscriberMethod, priority) 对象
        Subscription newSubscription = new Subscription(subscriber, subscriberMethod, priority);
        if (subscriptions == null) {
            subscriptions = new CopyOnWriteArrayList<Subscription>();
            subscriptionsByEventType.put(eventType, subscriptions);
        } else {
            for (Subscription subscription : subscriptions) {
                if (subscription.equals(newSubscription)) {
                    throw new EventBusException("Subscriber " + subscriber.getClass() + " already registered to event "
                            + eventType);
                }
            }
        }
 
        // Starting with EventBus 2.2 we enforced methods to be public (might change with annotations again)
        // subscriberMethod.method.setAccessible(true);
 
        int size = subscriptions.size();
        for (int i = 0; i <= size; i++) {
            if (i == size || newSubscription.priority > subscriptions.get(i).priority) {
                // 添加 newSubscription,优先级高的 添加到 list集合前边
                subscriptions.add(i, newSubscription);
                break;
            }
        }
 
        List<Class<?>> subscribedEvents = typesBySubscriber.get(subscriber);
        if (subscribedEvents == null) {
            subscribedEvents = new ArrayList<Class<?>>();
            typesBySubscriber.put(subscriber, subscribedEvents);
        }
        // 根据  subscriber 存储 所有的 eventType
        // subscribedEvents是 Map 集合,key:subscriber  value: List<eventType>
        subscribedEvents.add(eventType);
 
        // 判断 sticky:如果为true,从 stickyEvents 中 根据 eventType查找有没有 stickyEvent 
        // stickyEvent 就是 post(javabean)中传递的参数,
        // 如果有就调用 postToSubscription,发布
        if (sticky) {
            Object stickyEvent;
            synchronized (stickyEvents) {
                stickyEvent = stickyEvents.get(eventType);
            }
            if (stickyEvent != null) {
                // If the subscriber is trying to abort the event, it will fail (event is not tracked in posting state)
                // --> Strange corner case, which we don't take care of here.
                postToSubscription(newSubscription, stickyEvent, Looper.getMainLooper() == Looper.myLooper());
            }
        }
    }

分析:
1>:首先根据 subscriberMethod.eventType,在 subscriptionsByEventType 中查找 CopyOnWriteArrayList<Subscription>,没有就创建;
subscriptionsByEventType 是一个Map集合,用于存储 EventBus 所有的方法,
key: eventType,value: CopyOnWriteArrayList<Subscription>;
2>:然后把 传入的 参数 封装成 Subscription(subscriber, subscriberMethod, priority) 对象;
3>:然后添加 上边的对象 newSubscription ,根据 优先级 添加到 list集合
register结论:扫描该类中所有的方法,把匹配的方法保存到subscriptionsByEventType(Map,key:eventType,value:CopyOnWriteArrayList<Subscription>)

eventType:就是post(Javabean)数据类型,
Subscription保存了 subscriber、subscriberMethod(method,threadMode,eventType,priority,sticky)

2. post

register:把所有方法存储到subscriptionsByEventType,post就是从该Map集合中取方法,然后调用

    public void post(Object event) {
        // currentPostingThreadState:ThreadLocal类型的,里边存储的 PostingThreadState 
        // PostingThreadState 包含:eventQueue队列 和 一些标志位
        PostingThreadState postingState = currentPostingThreadState.get();
        List<Object> eventQueue = postingState.eventQueue;

        // eventQueue队列:用于保存 post 传入的event,其实就是 post传入过来的 javabean数据
        eventQueue.add(event);

        if (!postingState.isPosting) {
            // 判断是否是主线程,
            postingState.isMainThread = Looper.getMainLooper() == Looper.myLooper();
            postingState.isPosting = true;
            if (postingState.canceled) {
                throw new EventBusException("Internal error. Abort state was not reset");
            }
            try {
                // 遍历队列中存储的所有的 event,调用 下边的方法,
                while (!eventQueue.isEmpty()) {
                    postSingleEvent(eventQueue.remove(0), postingState);
                }
            } finally {
                postingState.isPosting = false;
                postingState.isMainThread = false;
            }
        }
    }


// currentPostingThreadState 是 ThreadLocal 类型的,用于存储 PostingThreadState
private final ThreadLocal<PostingThreadState> currentPostingThreadState = new ThreadLocal<PostingThreadState>() {
        @Override
        protected PostingThreadState initialValue() {
            return new PostingThreadState();
        }
    };

final static class PostingThreadState {
        // eventQueue 
        final List<Object> eventQueue = new ArrayList<Object>();  
        // 下边是一些标志位
        boolean isPosting;
        boolean isMainThread;
        Subscription subscription;
        Object event;
        boolean canceled;
    }

post:就是把event,其实就是传入的 Javabean数据 , 保存在当前线程的 PostingThreadState 的 eventQueue队列 中
1>:首先:判断当前是否是主线程;
2>:然后:遍历 eventQueue队列中所有的 event,其实就是遍历所有 post(param) 中传递的参数,然后调用 postSingleEvent

private void postSingleEvent(Object event, PostingThreadState postingState) throws Error {
        // 获取当前 Javabean数据 所在的 Class对象
        Class<? extends Object> eventClass = event.getClass();
        // 根据eventClass获取 List<Class<?>>,其实就是 Javabean数据 的当前Class、
        // 及父类和接口的Class类型,用于匹配
        // eventTypes:是所有 Class
        List<Class<?>> eventTypes = findEventTypes(eventClass);
        boolean subscriptionFound = false;

        // 遍历所有Class,在 subscriptionsByEventType中 查找 subscriptions ,
        // register注册:就是把 所有方法都存储到 subscriptionsByEventType集合中
        int countTypes = eventTypes.size();
        for (int h = 0; h < countTypes; h++) {
            Class<?> clazz = eventTypes.get(h);
            CopyOnWriteArrayList<Subscription> subscriptions;
            synchronized (this) {
                subscriptions = subscriptionsByEventType.get(clazz);
            }
            if (subscriptions != null && !subscriptions.isEmpty()) {
                // 遍历每个 subscription ,依次调用 postToSubscription
                for (Subscription subscription : subscriptions) {
                    postingState.event = event;
                    postingState.subscription = subscription;
                    boolean aborted = false;
                    try {
                        postToSubscription(subscription, event, postingState.isMainThread);
                        aborted = postingState.canceled;
                    } finally {
                        postingState.event = null;
                        postingState.subscription = null;
                        postingState.canceled = false;
                    }
                    if (aborted) {
                        break;
                    }
                }
                subscriptionFound = true;
            }
        }
        if (!subscriptionFound) {
            if (eventClass != NoSubscriberEvent.class && eventClass != SubscriberExceptionEvent.class) {
                post(new NoSubscriberEvent(this, event));
            }
        }
    }

分析postSingleEvent:
1>首先:获取当前 Javabean 数据所在的 Class对象,根据 该 对象获取 List<Class<?>>,这个就是 Javabean 数据 当前 Class及父类和接口的Class类型,用于匹配;
2>然后:遍历onEventMainThread(参数)中参数的所有 Class,在 subscriptionsByEventType中 查找 subscriptions,register注册时就是把 所有方法都存储到 subscriptionsByEventType集合中;
3>然后:然后 遍历每个 subscription,依次调用 postToSubscription,这个就是反射执行的方法,register时的 if(sticky) 就执行这个方法

private void postToSubscription(Subscription subscription, Object event, boolean isMainThread) {
        switch (subscription.subscriberMethod.threadMode) {
        case PostThread:
            invokeSubscriber(subscription, event);
            break;
        case MainThread:
            if (isMainThread) {
                invokeSubscriber(subscription, event);
            } else {
                mainThreadPoster.enqueue(subscription, event);
            }
            break;
        case BackgroundThread:
            if (isMainThread) {
                backgroundPoster.enqueue(subscription, event);
            } else {
                invokeSubscriber(subscription, event);
            }
            break;
        case Async:
            asyncPoster.enqueue(subscription, event);
            break;
        default:
            throw new IllegalStateException("Unknown thread mode: " + subscription.subscriberMethod.threadMode);
        }
    }

根据threadMode判断,应该在哪个线程调用 反射方法
case PostThread:在当前线程,调用反射;
case MainThread:如果是主线程,则调用反射,否则用 handler发送消息,然后执行;
case BackgroundThread:如果是主线程,将任务加入到后台队列中,然后由EventBus中的一个线程池调用,如果是子线程,则直接调用反射;
case Async:与BackgroundThread一样,把任务加入到后台队列中,由EventBus中的一个线程池调用;且二者是同一个线程池;
BackgroundThread 与 Async区别:
BackgroundThread :它里边的任务一个接一个调用,中间用 boolean类型变量 handlerActive控制;
Async:动态控制并发;

3. 总结

register把当前类中 匹配的方法存储到一个 map集合中,post 根据传入的参数到map集合查找然后反射调用

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

推荐阅读更多精彩内容

  • EventBus源码分析 Android开发中我们最常用到的可以说就是EventBus了,今天我们来深入研究一下E...
    BlackFlag阅读 507评论 3 4
  • EventBus源码分析(一) EventBus官方介绍为一个为Android系统优化的事件订阅总线,它不仅可以很...
    蕉下孤客阅读 3,972评论 4 42
  • 前面对EventBus 的简单实用写了一篇,相信大家都会使用,如果使用的还不熟,或者不够6,可以花2分钟瞄一眼:h...
    gogoingmonkey阅读 314评论 0 0
  • EventBus 源码分析 分析源码之前 EventBus 大神的 github,最好的老师。 一、使用 我们在平...
    猪_队友阅读 360评论 0 4
  • EventBus是在Android中使用到的发布-订阅事件总线框架,基于观察者模式,将事件的发送者和接收者解耦,简...
    BrotherTree阅读 400评论 0 1