当前位置:网站首页>Eventbus source code analysis
Eventbus source code analysis
2022-07-07 01:01:00 【yinianzhijian99】
First look at EventBus Use , It's simple , Example :
// register
EventBus.getDefault().register(this);
// Cancellation of registration
EventBus.getDefault().unregister(this);
// The main thread receives messages
@Subscribe(threadMode = ThreadMode.MAIN)
public void doEventBus(MsgEvent event){
// Processing logic ...
}
obtain EventBus example :
static volatile EventBus defaultInstance;
public static EventBus getDefault() {
if (defaultInstance == null) {
synchronized (EventBus.class) {
if (defaultInstance == null) {
defaultInstance = new EventBus();
}
}
}
return defaultInstance;
}
Use the singleton mode , Get the same instance object
register() Method implementation :
public void register(Object subscriber) {
// First get the subscriber's class object
Class<?> subscriberClass = subscriber.getClass();
// adopt subscriberMethodFinder To find out what events subscribers subscribed to .
// Return to one SubscriberMethod Object's List, Class encapsulates subscription method information
List<SubscriberMethod> subscriberMethods = subscriberMethodFinder.findSubscriberMethods(subscriberClass);
synchronized (this) {
for (SubscriberMethod subscriberMethod : subscriberMethods) {
// subscribe
subscribe(subscriber, subscriberMethod);
}
}
}
SubscriberMethod class , Subscription method information , It encapsulates the method object to respond (method), Which thread will the response subscription be in the future (threadMode), The event type of subscription (eventType), Priority of subscription priority, And whether to receive stickiness sticky The event boolean value .
public class SubscriberMethod {
final Method method;
final ThreadMode threadMode;
final Class<?> eventType;
final int priority;
final boolean sticky;
}
Get subscription method information
List<SubscriberMethod> findSubscriberMethods(Class<?> subscriberClass) {
// Read from cache first
List<SubscriberMethod> subscriberMethods = METHOD_CACHE.get(subscriberClass);
if (subscriberMethods != null) {
return subscriberMethods;
}
// Whether to ignore the generated by the annotator MyEventBusIndex class
if (ignoreGeneratedIndex) {
// Use reflection to get the subscription method information in the subscription class
subscriberMethods = findUsingReflection(subscriberClass);
} else {
// Generated from the annotator MyEventBusIndex Class to get the subscription method information of the subscription class
subscriberMethods = findUsingInfo(subscriberClass);
}
// In obtaining subscriberMethods in the future ,
// If the subscriber does not exist @Subscribe Annotate and for public Subscription method of , An exception will be thrown .
if (subscriberMethods.isEmpty()) {
throw new EventBusException("Subscriber " + subscriberClass
+ " and its super classes have no public methods with the @Subscribe annotation");
} else {
// Save to cache map in
//METHOD_CACHE, It's a map aggregate , The key is class type
METHOD_CACHE.put(subscriberClass, subscriberMethods);
return subscriberMethods;
}
}
Focus on getting subscription information through reflection : Get all the methods through reflection , Traversal methods , Gets the parameter type array of the method , Get the annotation information of the method
private List<SubscriberMethod> findUsingReflection(Class<?> subscriberClass) {
//FindState Used to check and save subscription methods
FindState findState = prepareFindState();
findState.initForSubscriber(subscriberClass);
while (findState.clazz != null) {
// Get subscription method information through reflection
findUsingReflectionInSingleClass(findState);
// Find the subscription method of the parent class
findState.moveToSuperclass();
}
// obtain findState Medium SubscriberMethod( That is, the subscription method List) And back to
return getMethodsAndRelease(findState);
}
private void findUsingReflectionInSingleClass(FindState findState) {
Method[] methods;
// Get the method array through reflection
try {
// This is faster than getMethods, especially when subscribers are fat classes like Activities
methods = findState.clazz.getDeclaredMethods();
} catch (Throwable th) {
// Workaround for java.lang.NoClassDefFoundError, see https://github.com/greenrobot/EventBus/issues/149
methods = findState.clazz.getMethods();
findState.skipSuperClasses = true;
}
// Traverse Method
for (Method method : methods) {
int modifiers = method.getModifiers();
if ((modifiers & Modifier.PUBLIC) != 0 && (modifiers & MODIFIERS_IGNORE) == 0) {
Class<?>[] parameterTypes = method.getParameterTypes();
// Ensure that there must be only one event parameter
if (parameterTypes.length == 1) {
// Get comments
Subscribe subscribeAnnotation = method.getAnnotation(Subscribe.class);
if (subscribeAnnotation != null) {
Class<?> eventType = parameterTypes[0];
// Verify that the method is added
if (findState.checkAdd(method, eventType)) {
ThreadMode threadMode = subscribeAnnotation.threadMode();
// Instantiation SubscriberMethod Object and add
findState.subscriberMethods.add(new SubscriberMethod(method, eventType, threadMode,
subscribeAnnotation.priority(), subscribeAnnotation.sticky()));
}
}
} else if (strictMethodVerification && method.isAnnotationPresent(Subscribe.class)) {
String methodName = method.getDeclaringClass().getName() + "." + method.getName();
throw new EventBusException("@Subscribe method " + methodName +
"must have exactly 1 parameter but has " + parameterTypes.length);
}
} else if (strictMethodVerification && method.isAnnotationPresent(Subscribe.class)) {
String methodName = method.getDeclaringClass().getName() + "." + method.getName();
throw new EventBusException(methodName +
" is a illegal @Subscribe method: must be public, non-static, and non-abstract");
}
}
}
EventBus There are two very important map aggregate
// subscriptionsByEventType aggregate ,key Is the event type , value yes Subscription object , Contains two properties , One is subscriber subscriber ( Reflection execution object ), One SubscriberMethod Annotate all attribute parameter values of the method
private final Map<Class<?>, CopyOnWriteArrayList<Subscription>> subscriptionsByEventType;
// typesBySubscriber aggregate key It's all subscribers ,value Is the parameter of the method in all subscribers class
private final Map<Object, List<Class<?>>> typesBySubscriber;
Event distribution resolution , See sending events post(event) The implementation of the , In fact, that is
Traverse subscriptionsByEventType, Find the matching method and call the method method.invoke() perform , Pay attention to switching threads .
public void post(Object event) {
// Gets the current thread's postingState
PostingThreadState postingState = currentPostingThreadState.get();
// Get the event queue of the current thread
List<Object> eventQueue = postingState.eventQueue;
// Add this event to the current event queue for distribution
eventQueue.add(event);
if (!postingState.isPosting) {
// Determine whether it is in the main thread post
postingState.isMainThread = Looper.getMainLooper() == Looper.myLooper();
postingState.isPosting = true;
if (postingState.canceled) {
throw new EventBusException("Internal error. Abort state was not reset");
}
try {
while (!eventQueue.isEmpty()) {
// Distribute events
postSingleEvent(eventQueue.remove(0), postingState);
}
} finally {
postingState.isPosting = false;
postingState.isMainThread = false;
}
}
}
Deregistration implementation :
public synchronized void unregister(Object subscriber) {
// Get the event types of all subscribers
List<Class<?>> subscribedTypes = typesBySubscriber.get(subscriber);
if (subscribedTypes != null) {
for (Class<?> eventType : subscribedTypes) {
// Remove subscribers from the subscriber collection of event types
unsubscribeByEventType(subscriber, eventType);
}
typesBySubscriber.remove(subscriber);
} else {
Log.w(TAG, "Subscriber to unregister was not registered before: " + subscriber.getClass());
}
}
private void unsubscribeByEventType(Object subscriber, Class<?> eventType) {
// Get all subscribers of the event type
List<Subscription> subscriptions = subscriptionsByEventType.get(eventType);
// Traverse subscriber collection , Remove the cancelled subscriber
if (subscriptions != null) {
int size = subscriptions.size();
for (int i = 0; i < size; i++) {
Subscription subscription = subscriptions.get(i);
if (subscription.subscriber == subscriber) {
subscription.active = false;
subscriptions.remove(i);
i--;
size--;
}
}
}
}
To sum up EventBus How it works
Subscription logic
1. First use register() Method to register a subscriber
2. Methods to get all subscriptions of this subscriber
3. According to the event types of all subscriptions of this subscriber , Store subscribers to each event with event type key Take all subscribers as values Of map Collection
4. Then add the subscription event to the subscriber key Take all subscription events of subscribers as values Of map Collection
5. If it is a subscriber who has subscribed to sticky events , Get the previously sent sticky events from the sticky event buffer , Respond to these sticky events .
Event sending logic
1. First, get the event queue of the current thread
2. Add the event to be sent to the event queue
3. Get all subscribers according to the sending event type
4. According to the execution mode of the response method , Execute the subscriber's subscription method through reflection in the corresponding thread
Cancel logic
1. First, through unregister Method to get the subscriber to cancel
2. Get all subscription event types of the subscriber
3. Traversal event types , Get all subscriber sets according to each event type , And delete the subscriber from the collection
4. Take the subscriber from step 2 Remove from the set of
边栏推荐
- Advanced learning of MySQL -- basics -- multi table query -- self join
- How do novices get started and learn PostgreSQL?
- 第七篇,STM32串口通信编程
- Article management system based on SSM framework
- 用tkinter做一个简单图形界面
- Deep understanding of distributed cache design
- ZYNQ移植uCOSIII
- from .cv2 import * ImportError: libGL.so.1: cannot open shared object file: No such file or direc
- 【批处理DOS-CMD命令-汇总和小结】-字符串搜索、查找、筛选命令(find、findstr),Find和findstr的区别和辨析
- Deep learning framework TF installation
猜你喜欢
View remote test data and records anytime, anywhere -- ipehub2 and ipemotion app
集合(泛型 & List & Set & 自定义排序)
JS+SVG爱心扩散动画js特效
迈动互联中标北京人寿保险,助推客户提升品牌价值
第四篇,STM32中断控制编程
Configuring OSPF basic functions for Huawei devices
深度学习之环境配置 jupyter notebook
[batch dos-cmd command - summary and summary] - jump, cycle, condition commands (goto, errorlevel, if, for [read, segment, extract string]), CMD command error summary, CMD error
ZYNQ移植uCOSIII
C9 colleges and universities, doctoral students make a statement of nature!
随机推荐
【批处理DOS-CMD命令-汇总和小结】-查看或修改文件属性(ATTRIB),查看、修改文件关联类型(assoc、ftype)
Advanced learning of MySQL -- basics -- multi table query -- self join
Dr selection of OSPF configuration for Huawei devices
【JVM调优实战100例】04——方法区调优实战(上)
Summary of being a microservice R & D Engineer in the past year
城联优品入股浩柏国际进军国际资本市场,已完成第一步
接口(接口相关含义,区别抽象类,接口回调)
「精致店主理人」青年创业孵化营·首期顺德场圆满结束!
深度学习框架TF安装
What kind of experience is it to realize real-time collaboration in jupyter
Part V: STM32 system timer and general timer programming
build. How to configure the dependent version number in the gradle file
Configuring OSPF basic functions for Huawei devices
String comparison in batch file - string comparison in batch file
Zabbix 5.0:通过LLD方式自动化监控阿里云RDS
Learn to use code to generate beautiful interface documents!!!
腾讯云 WebShell 体验
省市区三级坐标边界数据csv转JSON
[HFCTF2020]BabyUpload session解析引擎
【JVM调优实战100例】05——方法区调优实战(下)