EventBus源码解析

本文涉及的产品
公共DNS(含HTTPDNS解析),每月1000万次HTTP解析
全局流量管理 GTM,标准版 1个月
云解析 DNS,旗舰版 1个月
简介: EventBus是一个开源的事件总线项目,项目地址:EventBusEventBus通过注册监听器和发布消息的方式来完成事件的传递,如下所示:EventBus事件传递机制其中Publisher为事件的发布者,Subscriber为事件的订阅者。

EventBus是一个开源的事件总线项目,项目地址:EventBus

EventBus通过注册监听器和发布消息的方式来完成事件的传递,如下所示:

img_c5d20f6c24e4fe2273ae85874a950c22.png
EventBus事件传递机制

其中Publisher为事件的发布者,Subscriber为事件的订阅者。下图为EventBus的DEMO使用方法:

img_a51ecbc6b68f524e3a53381b3e36648c.png
DEMO使用方法

使用EventBus主要分为以下四步:

1、注册成为事件接受者:EventBus.getDefault().register(this)将当前类注册为事件接受者

2、注销:通过EventBus.getDefault().unregister(this)进行注销;

3、订阅事件:通过@Subscribe注解对方法进行注解,注解的方法必须有且仅有一个参数,这里我们定义了MyEvent作为订阅的事件。

4、发布事件:EventBus.getDefault().post(MyEvent)可以发布一个事件,EventBus会根据发布的消息的类型,找到该类型消息的订阅者,完成消息的传递。

@Subscribe注解

img_fce4e46c689ace8741b4eb919f70a9b5.png
@Subscribe注解

@Subscribe注解的定义如上图所示,通过@Rentention将注解定义为TUNTIME,表示该注解将会保留到JVM运行时,也就是可以通过反射进行调用;通过@Target将注解定义为METHOD,表示该注解只能应用于method;在使用@Subscribe注解时,可以设置threadMode、sticky、priority属性。

threadMode:指定订阅方法运行的线程,根据其值在对应的线程调用订阅Method。

sticky:指定是否是粘性事件,如果为true,在调用register的时候,会接受到注册监听之前EventBus postSticky发送过的同一类型的消息。

priority:优先级,EventBus根据订阅者的优先级来顺序发布事件。

EventBus的主要成员

EventBus.getDefault()以单例的方式获取EventBus实例,这里重点介绍下EventBus的成员变量:

img_979f6dbd9e720c30523e37257aaa44da.png
EventBus构造

1、subscriptionsByEventType

img_7f92d92e42c5bc8ccb30c4b9daf5d05b.png

是一个Map对象,Key为@Subcribe注解的方法的参数类型,对应到本文一开始的DEMO的MyEvent的Class对象,Value为Subscription列表。

img_714af5a5b1668784f111efa42edcd25b.png
Subscription

Subscription的subscriber对象指的是EventBus.getDefault().register(this)的this对象,subscriberMethod指的是@Subcribe注解的方法的Method对象。

一句话:subscriptionsByEventType保存了订阅MyEvent事件的订阅者列表。

2、typesBySubscriber

img_fbdb6a7357e66ebc8fce5c77806864d8.png

是一个Map对象,Key为EventBus.getDefault().register(this)的this对象,Value为this对象中所有的@Subcribe注解方法的参数类型,也就是订阅的事件类型。

3、stickyEvents

img_75cd7c15be45fbbc64380603109fa11e.png

是一个Map对象,postSticky发送的粘性事件会保存到该Map中。

img_518ce6fcd32913bafcaf77b59f60a587.png
发送粘性事件

Key为发送的粘性事件的Class对象,Value为粘性事件。

4、mainThreadSupport&mainThreadPoster(threadMode=MAIN 或者MAIN_ORDERED)

类型为mainThreadSupport类型为MainThreadSupport,mainThreadPoster类型为HandlerPoster。

img_827180b9feec66d6f87c4f36b7cd1e1f.png
mainThreadSupport的实现

通过Looper对象判断当前是否是主线程,创建HandlerPoster赋值给mainThreadPoster,HandlerPoster继承自Handler,handleMessage完成事件的分发,保证订阅方法运行在主线程。

5、backgroundPoster(threadMode=BACKGROUND)

和mainThreadPoster类似,实现类是BackgroundPoster,该类继承实现了Runnable接口,在异步线程调用订阅者的方法。

img_30141d238faaa46542f5656a9c30516c.png
BackgroundPoster

6、asyncPoster(threadMode=ASYNC)

img_e2edfafbcbee2a8a0954fd77ebcd2c43.png
AsyncPoster

实现类是AsyncPoster,也是通过后台线程调用订阅者方法,完成事件发布。但与BackgroundPoster有如下区别:

BackgroundPoster:如果当前线程是主线程,就调用backgroundPoster发布事件;如果当前发布时已经是异步线程,那么就直接反射运行订阅者方法,不需要开启线程了。

AsyncPoster:无论在哪个线程post事件都开启新的线程执行。

7、subscriberMethodFinder

实现类是SubscriberMethodFinder,在EventBus.getDefault().register(this)的时候查询this对象及其父类对象的所有@Subcribe注解的方法。

到这里,介绍完EventBus主要的成员后,下面分析下EventBus.getDefault().register的流程。

注册事件订阅者

EventBus.getDefault().register(this);将当前类注册为事件订阅者。

img_5681ced6563e6885221c624dfb87bcdc.png
register

register主要分为以下三步:

1、subscriber.getClass获取订阅者的Class对象

2、subscriberMethodFinder.findSubscriberMethods(subscriberClass)获取订阅者及其父类的所有@Subscribe注解的Method。

img_62e4d2a9cdc71c945d010c9485aeb5f1.png
findSubscriberMethods

通过findUsingInfo来获取订阅者及其父类的所有订阅方法:

img_a88aef8fffc72b48a72067979bf95392.png
findUsingInfo

findUsingInfo首先初始化了FindState,FindState是个什么东东?

img_589c2c28038ef40922fe5f8b1dc606b2.png
FindState

上图描述了FindState的作用和信息,FindState用来查找和保存订阅者及其父类的订阅信息,订阅的方法保存在subscriberMethods中;subscriberInfo默认为空,所以在初始化完FindState后会循环调用findUsingReflectionInSingleClass方法,该方法通过反射来获取FindState.clazz的@Subscribe注解方法,findUsingInfo会一直循环,直到clazz已经没有符合要求的父类了。

img_53d99d25276535529cf28be9142679c7.png
findUsingReflectionInSingleClass

在循环结束后,findState.subscriberMethods保存了订阅者及其父类的所有SubscriberMethod。

3、对每个subscriberMethod调用subscribe(subscriber, subscriberMethod)方法。

第2步获取到所有订阅方法后,就循环调用subscribe(subscriber, subscriberMethod)。

img_36151e9b2167d4dfb9848f6914d2dbac.png
img_ef6a61763cd0daff7a5f005ac1348534.png
subscribe

至此,register方法运行结束了,subscriptionsByEventType中保存了某个类型消息对应的Subscription列表,Subscription中包含了订阅者和订阅方法;typesBySubscriber保存了某个订阅者的所有订阅事件类型;最后也完成了sticky事件的发布。

发布事件

通过EventBus.getDefault().post(postEvent);可以发布一个事件。

img_1d7755447f161ada8346367be487d63d.png
post

发布事件有以下过程:


1、获取当前的发布状态PostingThreadState

img_2039aea4131bcc4630be505070f6b7c4.png
PostingThreadState

PostingThreadState定义了当前正在发布的事件状态。

2、将事件保存到等待队列

3、循环调用postSingleEvent发布事件

img_5e29e7e057d85f481f23806e5037eeab.png
postSingleEvent

postSingleEvent调用了lookupAllEventTypes()获取要发布的事件及其父类的Class对象,也就是说如果发布MyEvent事件,订阅了MyEvent事件或者其父类事件的订阅者都能收到MyEvent事件(可以这样理解,订阅了MyEvent的父类事件,MyEvent是其父类的一种类型,也应该发布)。postSingleEventForEventType完成单个事件的发布:

img_aad6e70c36805856dc607b06a58de732.png
postSingleEventForEventType

首先在subscriptionsByEventType获取eventClass对应的订阅列表,然后调用postToSubscription进行发布。

img_cd59378ab08b9f07e033a6dbedfe05e4.png
postToSubscription

postToSubscription会根据SubscriberMethod的ThreadMode确定调用哪个Poster就进行事件发布。无论在主线程还是异步线程,最终都是调用了invokeSubscriber:

img_100094e1a73873490598efc294693b63.png
invokeSubscriber

invokeSubscriber通过反射调用了subscriber的method,并传入了Event参数。

4、重置PostingThreadState状态

注销

通过EventBus.getDefault().unregister(this);可以完成注销,即订阅者不在关注任何事件了。

img_962354a09748ed2dddd86e372a5f2312.png
unregister
img_548a2512d7b60bbd39c580b49c69d638.png
unsubscribeByEventType


至此,EventBus的注册、订阅消息、发布消息、注销的流程都已经分析完毕。

目录
相关文章
|
2月前
|
监控 Java 应用服务中间件
高级java面试---spring.factories文件的解析源码API机制
【11月更文挑战第20天】Spring Boot是一个用于快速构建基于Spring框架的应用程序的开源框架。它通过自动配置、起步依赖和内嵌服务器等特性,极大地简化了Spring应用的开发和部署过程。本文将深入探讨Spring Boot的背景历史、业务场景、功能点以及底层原理,并通过Java代码手写模拟Spring Boot的启动过程,特别是spring.factories文件的解析源码API机制。
88 2
|
13天前
|
存储 设计模式 算法
【23种设计模式·全精解析 | 行为型模式篇】11种行为型模式的结构概述、案例实现、优缺点、扩展对比、使用场景、源码解析
行为型模式用于描述程序在运行时复杂的流程控制,即描述多个类或对象之间怎样相互协作共同完成单个对象都无法单独完成的任务,它涉及算法与对象间职责的分配。行为型模式分为类行为模式和对象行为模式,前者采用继承机制来在类间分派行为,后者采用组合或聚合在对象间分配行为。由于组合关系或聚合关系比继承关系耦合度低,满足“合成复用原则”,所以对象行为模式比类行为模式具有更大的灵活性。 行为型模式分为: • 模板方法模式 • 策略模式 • 命令模式 • 职责链模式 • 状态模式 • 观察者模式 • 中介者模式 • 迭代器模式 • 访问者模式 • 备忘录模式 • 解释器模式
【23种设计模式·全精解析 | 行为型模式篇】11种行为型模式的结构概述、案例实现、优缺点、扩展对比、使用场景、源码解析
|
13天前
|
设计模式 存储 安全
【23种设计模式·全精解析 | 创建型模式篇】5种创建型模式的结构概述、实现、优缺点、扩展、使用场景、源码解析
结构型模式描述如何将类或对象按某种布局组成更大的结构。它分为类结构型模式和对象结构型模式,前者采用继承机制来组织接口和类,后者釆用组合或聚合来组合对象。由于组合关系或聚合关系比继承关系耦合度低,满足“合成复用原则”,所以对象结构型模式比类结构型模式具有更大的灵活性。 结构型模式分为以下 7 种: • 代理模式 • 适配器模式 • 装饰者模式 • 桥接模式 • 外观模式 • 组合模式 • 享元模式
【23种设计模式·全精解析 | 创建型模式篇】5种创建型模式的结构概述、实现、优缺点、扩展、使用场景、源码解析
|
13天前
|
设计模式 存储 安全
【23种设计模式·全精解析 | 创建型模式篇】5种创建型模式的结构概述、实现、优缺点、扩展、使用场景、源码解析
创建型模式的主要关注点是“怎样创建对象?”,它的主要特点是"将对象的创建与使用分离”。这样可以降低系统的耦合度,使用者不需要关注对象的创建细节。创建型模式分为5种:单例模式、工厂方法模式抽象工厂式、原型模式、建造者模式。
【23种设计模式·全精解析 | 创建型模式篇】5种创建型模式的结构概述、实现、优缺点、扩展、使用场景、源码解析
|
2月前
|
缓存 监控 Java
Java线程池提交任务流程底层源码与源码解析
【11月更文挑战第30天】嘿,各位技术爱好者们,今天咱们来聊聊Java线程池提交任务的底层源码与源码解析。作为一个资深的Java开发者,我相信你一定对线程池并不陌生。线程池作为并发编程中的一大利器,其重要性不言而喻。今天,我将以对话的方式,带你一步步深入线程池的奥秘,从概述到功能点,再到背景和业务点,最后到底层原理和示例,让你对线程池有一个全新的认识。
57 12
|
1月前
|
PyTorch Shell API
Ascend Extension for PyTorch的源码解析
本文介绍了Ascend对PyTorch代码的适配过程,包括源码下载、编译步骤及常见问题,详细解析了torch-npu编译后的文件结构和三种实现昇腾NPU算子调用的方式:通过torch的register方式、定义算子方式和API重定向映射方式。这对于开发者理解和使用Ascend平台上的PyTorch具有重要指导意义。
|
14天前
|
安全 搜索推荐 数据挖掘
陪玩系统源码开发流程解析,成品陪玩系统源码的优点
我们自主开发的多客陪玩系统源码,整合了市面上主流陪玩APP功能,支持二次开发。该系统适用于线上游戏陪玩、语音视频聊天、心理咨询等场景,提供用户注册管理、陪玩者资料库、预约匹配、实时通讯、支付结算、安全隐私保护、客户服务及数据分析等功能,打造综合性社交平台。随着互联网技术发展,陪玩系统正成为游戏爱好者的新宠,改变游戏体验并带来新的商业模式。
|
3月前
|
缓存 Java 程序员
Map - LinkedHashSet&Map源码解析
Map - LinkedHashSet&Map源码解析
89 0
|
3月前
|
算法 Java 容器
Map - HashSet & HashMap 源码解析
Map - HashSet & HashMap 源码解析
69 0
|
3月前
|
存储 Java C++
Collection-PriorityQueue源码解析
Collection-PriorityQueue源码解析
75 0

热门文章

最新文章

推荐镜像

更多