- 手撸一个简易的EventBus可以更容易理解其核心原理
1、首先自定义一个注解类，用于注册回调方法的使用
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Subscribe注解
*
* @author LTP 2021/10/22
*/
@Target(ElementType.METHOD)
// 设置成运行时才可以运行时利用反射获取利用了该注解的方法
@Retention(RetentionPolicy.RUNTIME)
public @interface Subscribe {
/**
* 是否接收粘性事件默认为false
*
* @return 是否接收粘性事件
*/
boolean isSticky() default false;
/**
* 线程类型
*
* @return 线程类型
*/
ThreadMode threadMode() default ThreadMode.MAIN;
}
2、写一个标识线程执行的枚举类
/**
* 线程类型的枚举
*
* @author LTP 2021/10/22
*/
public enum ThreadMode {
/**
* 主线程
*/
MAIN,
/**
* 子线程
*/
BACKGROUND
}
3、一个包装好的回调方法的实体
import java.lang.reflect.Method;
/**
* 回调方法实体
*
* @author LTP 2021/10/22
*/
public class SubscribeMethod {
/**
* 使用@subscribe注解回调的方法
*/
private Method method;
/**
* 线程模式
*/
private ThreadMode threadMode;
/**
* 回调方法中的参数
*/
private Class type;
/**
* 是否是粘性事件的方法回调
*/
private boolean isSticky;
public SubscribeMethod(Method method, ThreadMode threadMode, Class type, boolean isSticky) {
this.method = method;
this.threadMode = threadMode;
this.type = type;
this.isSticky = isSticky;
}
public Method getMethod() {
return method;
}
public void setMethod(Method method) {
this.method = method;
}
public ThreadMode getThreadMode() {
return threadMode;
}
public void setThreadMode(ThreadMode threadMode) {
this.threadMode = threadMode;
}
public Class getType() {
return type;
}
public void setType(Class type) {
this.type = type;
}
public boolean isSticky() {
return isSticky;
}
public void setSticky(boolean sticky) {
isSticky = sticky;
}
}
4、核心代码MyEventBus
import android.os.Handler;
import android.os.HandlerThread;
import android.os.Looper;
import com.btpj.lib_base.utils.LogUtil;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
/**
* 自己实现一个简单的EventBus,更容易理解源码的本质
*
* @author LTP 2021/10/22
*/
public class MyEventBus {
/**
* 单例
*/
private static volatile MyEventBus instance;
/**
* 存储注册的类以及类中使用了@subscribe注解的方法列表的Map集
*/
private final Map> mSubscriberMap;
/**
* 存储粘性事件列表
*/
private final Map, Object> mStickyEventMap;
/**
* 这里设计成构造私有 (注意：EventBus是public的，表示一条事件总线)
*/
private MyEventBus() {
mSubscriberMap = new HashMap<>();
mStickyEventMap = new ConcurrentHashMap<>();
}
/**
* 使用双重校验锁的方式获取单例
*/
public static MyEventBus getDefault() {
if (instance == null) {
synchronized (MyEventBus.class) {
if (instance == null) {
instance = new MyEventBus();
}
}
}
return instance;
}
/**
* 注册
*
* @param subscriber 订阅者，参数为Object类型，EventBus既可以用到Android，也能用在java中
*/
public void register(Object subscriber) {
List list = mSubscriberMap.get(subscriber);
if (list == null) {
list = findSubscribeMethods(subscriber);
mSubscriberMap.put(subscriber, list);
}
for (SubscribeMethod subscribeMethod : list) {
// 判断是否注册有粘性事件
if (subscribeMethod.isSticky()) {
// 遍历mStickyEventMap进行调用
for (Class clazz : mStickyEventMap.keySet()) {
Object event = mStickyEventMap.get(clazz);
// 方法的参数Event是否与发送的Event是同一个类
if (subscribeMethod.getType().isAssignableFrom(clazz)) {
postToSubscription(event, subscriber, subscribeMethod);
}
}
}
}
}
/**
* 寻找注册了EventBus类中使用了@subscribe注解的方法
*
* @param subscriber 注册了EventBus的注册者
* @return 注册者中使用了@subscribe注解的方法集合
*/
private List findSubscribeMethods(Object subscriber) {
List list = new ArrayList<>();
Class clazz = subscriber.getClass();
while (clazz != null) {
// 剔除掉系统的父类，防止无用功，提高性能
if (clazz.getName().startsWith("java.") || clazz.getName().startsWith("javax.")
|| clazz.getName().startsWith("android.")) {
break;
}
Method[] declaredMethods = clazz.getDeclaredMethods();
for (Method method : declaredMethods) {
// 找到其中带有@suscribe注解的方法
Subscribe subscribe = method.getAnnotation(Subscribe.class);
if (subscribe == null) {
continue;
}
// 判断带有@suscribe注解的方法中的参数是否唯一
Class[] parameterTypes = method.getParameterTypes();
if (parameterTypes.length > 1) {
throw new RuntimeException("Event bus only accept one param");
}
ThreadMode threadMode = subscribe.threadMode();
boolean isSticky = subscribe.isSticky();
SubscribeMethod subscribeMethod = new SubscribeMethod(method, threadMode, parameterTypes[0], isSticky);
list.add(subscribeMethod);
}
clazz = clazz.getSuperclass();
}
return list;
}
/**
* 发送普通事件
*
* @param event 事件
*/
public void post(Object event) {
// 遍历hashMap寻找对应的方法进行调用
for (Object obj : mSubscriberMap.keySet()) {
List list = mSubscriberMap.get(obj);
assert list != null;
for (SubscribeMethod subscribeMethod : list) {
// 方法的参数Event是否与发送的Event是同一个类
if (subscribeMethod.getType().isAssignableFrom(event.getClass())) {
postToSubscription(event, obj, subscribeMethod);
}
}
}
}
/**
* 根据线程处理事件的响应
*
* @param event 事件
* @param obj 注册者
* @param subscribeMethod 注册着中的回调方法
*/
private void postToSubscription(Object event, Object obj, SubscribeMethod subscribeMethod) {
switch (subscribeMethod.getThreadMode()) {
case MAIN:
if (Looper.myLooper() == Looper.getMainLooper()) {
// 主 - 主
invoke(subscribeMethod, obj, event);
} else {
// 子 - 主
LogUtil.INSTANCE.d("发送的线程名：" + Thread.currentThread().getName());
new Handler(Looper.getMainLooper()).post(() -> invoke(subscribeMethod, obj, event));
}
break;
case BACKGROUND:
if (Looper.myLooper() == Looper.getMainLooper()) {
// 主 - 子
// EventBus是利用ExecutorService实现的，这里简易的借助HandlerThread
HandlerThread my_thread = new HandlerThread("My Thread") {
@Override
protected void onLooperPrepared() {
super.onLooperPrepared();
new Handler().post(() -> {
LogUtil.INSTANCE.d("发送的线程名：" + Thread.currentThread().getName());
invoke(subscribeMethod, obj, event);
});
}
};
my_thread.start();
} else {
// 子 - 子
LogUtil.INSTANCE.d("发送的线程名：" + Thread.currentThread().getName());
invoke(subscribeMethod, obj, event);
}
break;
}
}
/**
* 利用反射调用回调方法
*
* @param subscribeMethod SubscribeMethod
* @param obj 方法所在的类
* @param event 方法参数
*/
private void invoke(SubscribeMethod subscribeMethod, Object obj, Object event) {
Method method = subscribeMethod.getMethod();
try {
method.invoke(obj, event);
} catch (Exception e) {
e.printStackTrace();
}
}
/**
* 发送粘性事件
*
* @param event 粘性事件
*/
public void postSticky(Object event) {
mStickyEventMap.put(event.getClass(), event);
}
public void unregister(Object subscriber) {
mSubscriberMap.clear();
mStickyEventMap.clear();
}
}
总结：
简易的EventBus实现起来比较简单，手撸最主要的目的是可以更深刻去理解其实现的本质
- EventBus.getDefault()：利用getDefault双重校验锁单例的方式来获取EventBus实例，从而获得一条默认的事件总线,当然你也可以通过默认构造器（public）创建多条事件总线
- EventBus构造方法中传入默认的DEFAULT_BUILDER对象（EventBusBuilder存放一些默认配置）对相关属性进行初始化，也包括粘性事件ConcurrentHashMap
- register(Object subscriber)：注册事件，利用反射来获取当前注册者类或父类中使用了@Subscribe的所有方法缓存起来并调用subscribe方法来订阅,如果是粘性事件,在订阅的时候就取出保存的粘性事件直接发送,这样就做到了发布者先发布事件,之后订阅者订阅事件, 接收订阅之前发布的粘性事件
- post：发送普通事件，post方法将发送的事件保存到List的事件队列，然后循环遍历出队列将事件交给postSingleEvent来处理，最终会调用postToSubscription方法，postToSubscription方法拿到事件后判断事件是否处于UI线程，不是的话采用Handler去处理，是则直接用反射invoke调用被观察的方法
- postSticky：发送粘性事件，主要是将事件类型和对应事件保存到stickyEvents中并执行post方法