Android之数据传输利器和低耦合器EventBus解析
2016-03-10 11:23
573 查看
相信对于android应用开发者来说,Activity、Service、Broadcast等组件并不陌生,它们之间的交互是通过Intent来传递基本数据类型、自定义数据类型来实现的,如若数据多的话会显得非常混乱,特别是广播风暴。大家在java的基础的学习中可能都学过观察者模式,相信对其也有了解!观察者模式就是对某一对象注册一个监听,当该对象发生变化时会触发监听事件。本博文针对数据传输利器和低耦合器非常有用的EventBus作详细的讲解,希望对读者有益:
public void onUpdate();
然后当某一个事件发生时,某个对象会调用观察者的onUpdate方法通知观察者某件事情发生了,但是在EventBus中不需要这样,EventBus中是这样实现的:
在EventBus中的观察者通常有四种订阅函数(就是某件事情发生被调用的方法)
1、onEvent
2、onEventMainThread
3、onEventBackground
4、onEventAsync
这四种订阅函数都是使用onEvent开头的,它们的功能稍有不同,在介绍不同之前先介绍两个概念:
告知观察者事件发生时通过EventBus.post函数实现,这个过程叫做事件的发布,观察者被告知事件发生叫做事件的接收,是通过下面的订阅函数实现的。
onEvent:如果使用onEvent作为订阅函数,那么该事件在哪个线程发布出来的,onEvent就会在这个线程中运行,也就是说发布事件和接收事件线程在同一个线程
4000
。使用这个方法时,在onEvent方法中不能执行耗时操作,如果执行耗时操作容易导致事件分发延迟。
onEventMainThread:如果使用onEventMainThread作为订阅函数,那么不论事件是在哪个线程中发布出来的,onEventMainThread都会在UI线程中执行,接收事件就会在UI线程中运行,这个在Android中是非常有用的,因为在Android中只能在UI线程中跟新UI,所以在onEvnetMainThread方法中是不能执行耗时操作的。
onEvnetBackground:如果使用onEventBackgrond作为订阅函数,那么如果事件是在UI线程中发布出来的,那么onEventBackground就会在子线程中运行,如果事件本来就是子线程中发布出来的,那么onEventBackground函数直接在该子线程中执行。
onEventAsync:使用这个函数作为订阅函数,那么无论事件在哪个线程发布,都会创建新的子线程在执行onEventAsync.
2.SecondActivity.class文件如下:
3.FirstEvent.class文件如下:
4.activity_main.xml文件:
5.second.xml文件如下:
6.EventBus的jar包
EventBus的jar包下载地址:
其实调用的就是同名函数register,它的四个参数意义分别是:
subscriber:就是要注册的一个订阅者,
methodName:就是订阅者默认的订阅函数名,其实就是“onEvent”
sticky:表示是否是粘性的,一般默认都是false,除非你调用registerSticky方法了
priority:表示事件的优先级,默认就行,
接下来我们就看看这个函数具体干了什么
通过一个findSubscriberMethods方法找到了一个订阅者中的所有订阅方法,返回一个 List,进入到findSubscriberMethods看看如何实现的
对于这个方法的讲解都在注释里面了,这里就不在重复叙述了,到了这里我们就找到了一个订阅者的所有的订阅方法
我们回到register方法:
对每一个订阅方法,对其调用subscribe方法,进入该方法看看到底干了什么
好了,到这里差不多register方法分析完了,大致流程就是这样的,我们总结一下:
1、找到被注册者中所有的订阅方法。
2、依次遍历订阅方法,找到EventBus中eventType对应的订阅列表,然后根据当前订阅者和订阅方法创建一个新的订阅加入到订阅列表
3、找到EvnetBus中subscriber订阅的事件列表,将eventType加入到这个事件列表。
所以对于任何一个订阅者,我们可以找到它的 订阅事件类型列表,通过这个订阅事件类型,可以找到在订阅者中的订阅函数。
register分析完了就分析一下post吧,这个分析完了,EventBus的原理差不多也完了…
post里面没有什么具体逻辑,它的功能主要是调用postSingleEvent完成的,进入到这个函数看看吧
这个方法有个核心方法 postToSubscription方法,进入看看吧
源码Demo使用下载地址:
一、EventBus概念
EventBus是android提供的一个开源库,方便android应用开发者使用观察者模式。 EvnetBus的下载地址:https://github.com/greenrobot/EventBus.git
二、EventBus使用步骤
1、下载EventBus库: 2、将EventBus.jar放入自己工程的libs目录即可 3、定义一个事件,这个事件一旦被EventBus分发出去就是代表某一件事情发生了,这个事件就是某个观察者关心的事情(不需要继承任何类) 4、定义观察者,然后将该观察者注册到EventBus 5、由EventBus分发事件,告知观察者某一件事情发生了 6、使用完成后从EventBus中反注册观察者。 熟悉观察者模式的朋友肯定对于上面的流程非常熟悉,其实和观察模式基本是一样的。但是也是有区别的。在观察者模式中,所有的观察者都需要实现一个接口,这个接口有一个统一的方法如:
public void onUpdate();
然后当某一个事件发生时,某个对象会调用观察者的onUpdate方法通知观察者某件事情发生了,但是在EventBus中不需要这样,EventBus中是这样实现的:
在EventBus中的观察者通常有四种订阅函数(就是某件事情发生被调用的方法)
1、onEvent
2、onEventMainThread
3、onEventBackground
4、onEventAsync
这四种订阅函数都是使用onEvent开头的,它们的功能稍有不同,在介绍不同之前先介绍两个概念:
告知观察者事件发生时通过EventBus.post函数实现,这个过程叫做事件的发布,观察者被告知事件发生叫做事件的接收,是通过下面的订阅函数实现的。
onEvent:如果使用onEvent作为订阅函数,那么该事件在哪个线程发布出来的,onEvent就会在这个线程中运行,也就是说发布事件和接收事件线程在同一个线程
4000
。使用这个方法时,在onEvent方法中不能执行耗时操作,如果执行耗时操作容易导致事件分发延迟。
onEventMainThread:如果使用onEventMainThread作为订阅函数,那么不论事件是在哪个线程中发布出来的,onEventMainThread都会在UI线程中执行,接收事件就会在UI线程中运行,这个在Android中是非常有用的,因为在Android中只能在UI线程中跟新UI,所以在onEvnetMainThread方法中是不能执行耗时操作的。
onEvnetBackground:如果使用onEventBackgrond作为订阅函数,那么如果事件是在UI线程中发布出来的,那么onEventBackground就会在子线程中运行,如果事件本来就是子线程中发布出来的,那么onEventBackground函数直接在该子线程中执行。
onEventAsync:使用这个函数作为订阅函数,那么无论事件在哪个线程发布,都会创建新的子线程在执行onEventAsync.
三、Demo示例
demo包含的文件有:类文件-MainActivity.class、SecondActivity.class、FirstEvent.class;布局文件:activity_main.xml、second.xml;还有EventBus的jar包 1.MainActivity.class如下:
package com.jhsys.cn.eventbusdemo; import android.app.Activity; import android.content.Intent; import android.os.Bundle; import android.util.Log; import android.view.View; import android.widget.Button; import android.widget.TextView; import android.widget.Toast; import org.greenrobot.eventbus.EventBus; import org.greenrobot.eventbus.Subscribe; public class MainActivity extends Activity { private Button firstBtn; private TextView firstTv; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); EventBus.getDefault().register(this); firstBtn = (Button) findViewById(R.id.btn_1); firstTv = (TextView) findViewById(R.id.tv_1); firstBtn.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View v) { Intent intent = new Intent(); intent.setClass(MainActivity.this,SecondActivity.class); startActivity(intent); } }); } @Subscribe public void onEventMainThread(FirstEvent event) { String msg = "onEventMainThread收到了消息:" + event.getMsg(); Log.d("harvic", msg); firstTv.setText(msg); Toast.makeText(this, msg, Toast.LENGTH_LONG).show(); } @Override protected void onDestroy() { super.onDestroy(); EventBus.getDefault().unregister(this); } }
2.SecondActivity.class文件如下:
package com.jhsys.cn.eventbusdemo; import android.app.Activity; import android.os.Bundle; import android.view.View; import android.widget.Button; import org.greenrobot.eventbus.EventBus; /** * Created by Administrator on 2016/3/9. */ public class SecondActivity extends Activity{ private Button secondBtn; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.second); secondBtn = (Button) findViewById(R.id.btn_2); secondBtn.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View v) { EventBus.getDefault().post(new FirstEvent("今天下大雨呢!!!")); } }); } }
3.FirstEvent.class文件如下:
package com.jhsys.cn.eventbusdemo; /** * Created by Administrator on 2016/3/9. */ public class FirstEvent { private String mMsg; public FirstEvent(String msg) { mMsg = msg; } public String getMsg(){ return mMsg; } }
4.activity_main.xml文件:
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android" xmlns:tools="http://schemas.android.com/tools" android:layout_width="match_parent" android:layout_height="match_parent" android:paddingBottom="@dimen/activity_vertical_margin" android:paddingLeft="@dimen/activity_horizontal_margin" android:paddingRight="@dimen/activity_horizontal_margin" android:paddingTop="@dimen/activity_vertical_margin" tools:context=".MainActivity" android:gravity="center_horizontal" android:orientation="vertical"> <Button android:id="@+id/btn_1" android:layout_width="wrap_content" android:layout_height="wrap_content" android:text="第一个界面 点击"/> <TextView android:id="@+id/tv_1" android:layout_width="wrap_content" android:layout_height="wrap_content" android:text=""/> </LinearLayout>
5.second.xml文件如下:
<?xml version="1.0" encoding="utf-8"?> <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android" android:layout_width="match_parent" android:layout_height="match_parent" android:gravity="center" android:orientation="vertical"> <Button android:id="@+id/btn_2" android:layout_width="wrap_content" android:layout_height="wrap_content" android:text="第二个界面 点击"/> </LinearLayout>
6.EventBus的jar包
EventBus的jar包下载地址:
四、EventBus源码解析
就从EvnetBus的入口开始看吧:EventBus.registerpublic void register(Object subscriber) { register(subscriber, DEFAULT_METHOD_NAME, false, 0); }
其实调用的就是同名函数register,它的四个参数意义分别是:
subscriber:就是要注册的一个订阅者,
methodName:就是订阅者默认的订阅函数名,其实就是“onEvent”
sticky:表示是否是粘性的,一般默认都是false,除非你调用registerSticky方法了
priority:表示事件的优先级,默认就行,
接下来我们就看看这个函数具体干了什么
private synchronized void register(Object subscriber, String methodName, boolean sticky, int priority) { List<SubscriberMethod> subscriberMethods = subscriberMethodFinder.findSubscriberMethods(subscriber.getClass(), methodName); for (SubscriberMethod subscriberMethod : subscriberMethods) { subscribe(subscriber, subscriberMethod, sticky, priority); } }
通过一个findSubscriberMethods方法找到了一个订阅者中的所有订阅方法,返回一个 List,进入到findSubscriberMethods看看如何实现的
List<SubscriberMethod> findSubscriberMethods(Class<?> subscriberClass, String eventMethodName) { //通过订阅者类名+"."+"onEvent"创建一个key String key = subscriberClass.getName() + '.' + eventMethodName; List<SubscriberMethod> subscriberMethods; synchronized (methodCache) { //判断是否有缓存,有缓存直接返回缓存 subscriberMethods = methodCache.get(key); } //第一次进来subscriberMethods肯定是Null 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; } // Starting with EventBus 2.2 we enforced methods to be public (might change with annotations again) //通过反射,获取到订阅者的所有方法 Method[] methods = clazz.getMethods(); for (Method method : methods) { String methodName = method.getName(); //只找以onEvent开头的方法 if (methodName.startsWith(eventMethodName)) { int modifiers = method.getModifiers(); //判断订阅者是否是public的,并且是否有修饰符,看来订阅者只能是public的,并且不能被final,static等修饰 if ((modifiers & Modifier.PUBLIC) != 0 && (modifiers & MODIFIERS_IGNORE) == 0) { //获得订阅函数的参数 Class<?>[] parameterTypes = method.getParameterTypes(); //看了参数的个数只能是1个 if (parameterTypes.length == 1) { //获取onEvent后面的部分 String modifierString = methodName.substring(eventMethodName.length()); ThreadMode threadMode; if (modifierString.length() == 0) { //订阅函数为onEvnet //记录线程模型为PostThread,意义就是发布事件和接收事件在同一个线程执行,详细可以参考我对于四个订阅函数不同点分析 threadMode = ThreadMode.PostThread; } else if (modifierString.equals("MainThread")) { //对应onEventMainThread threadMode = ThreadMode.MainThread; } else if (modifierString.equals("BackgroundThread")) { //对应onEventBackgrondThread threadMode = ThreadMode.BackgroundThread; } else if (modifierString.equals("Async")) { //对应onEventAsync 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)) { // Only add if not already found in a sub class //封装一个订阅方法对象,这个对象包含Method对象,threadMode对象,eventType对象 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 (SubscriberMethod subscriberMethod : subscriberMethods) { subscribe(subscriber, subscriberMethod, sticky, priority); }
对每一个订阅方法,对其调用subscribe方法,进入该方法看看到底干了什么
private void subscribe(Object subscriber, SubscriberMethod subscriberMethod, boolean sticky, int priority) { subscribed = true; //从订阅方法中拿到订阅事件的类型 Class<?> eventType = subscriberMethod.eventType; //通过订阅事件类型,找到所有的订阅(Subscription),订阅中包含了订阅者,订阅方法 CopyOnWriteArrayList<Subscription> subscriptions = subscriptionsByEventType.get(eventType); //创建一个新的订阅 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); } } } //根据优先级插入订阅 int size = subscriptions.size(); for (int i = 0; i <= size; i++) { if (i == size || newSubscription.priority > subscriptions.get(i).priority) { subscriptions.add(i, newSubscription); break; } } //将这个订阅事件加入到订阅者的订阅事件列表中 List<Class<?>> subscribedEvents = typesBySubscriber.get(subscriber); if (subscribedEvents == null) { subscribedEvents = new ArrayList<Class<?>>(); typesBySubscriber.put(subscriber, subscribedEvents); } subscribedEvents.add(eventType); //这个是对粘性事件的,暂时不讨论 if (sticky) { Object stickyEvent; synchronized (stickyEvents) { stickyEvent = stickyEvents.get(eventType); } if (stickyEvent != null) { postToSubscription(newSubscription, stickyEvent, Looper.getMainLooper() == Looper.myLooper()); } } }
好了,到这里差不多register方法分析完了,大致流程就是这样的,我们总结一下:
1、找到被注册者中所有的订阅方法。
2、依次遍历订阅方法,找到EventBus中eventType对应的订阅列表,然后根据当前订阅者和订阅方法创建一个新的订阅加入到订阅列表
3、找到EvnetBus中subscriber订阅的事件列表,将eventType加入到这个事件列表。
所以对于任何一个订阅者,我们可以找到它的 订阅事件类型列表,通过这个订阅事件类型,可以找到在订阅者中的订阅函数。
register分析完了就分析一下post吧,这个分析完了,EventBus的原理差不多也完了…
public void post(Object event) { //这个EventBus中只有一个,差不多是个单例吧,具体不用细究 PostingThreadState postingState = currentPostingThreadState.get(); List<Object> eventQueue = postingState.eventQueue; //将事件放入队列 eventQueue.add(event); if (postingState.isPosting) { return; } else { 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()) { //分发事件 postSingleEvent(eventQueue.remove(0), postingState); } } finally { postingState.isPosting = false; postingState.isMainThread = false; } } }
post里面没有什么具体逻辑,它的功能主要是调用postSingleEvent完成的,进入到这个函数看看吧
private void postSingleEvent(Object event, PostingThreadState postingState) throws Error { Class<? extends Object> eventClass = event.getClass(); //找到eventClass对应的事件,包含父类对应的事件和接口对应的事件 List<Class<?>> eventTypes = findEventTypes(eventClass); boolean subscriptionFound = false; int countTypes = eventTypes.size(); for (int h = 0; h < countTypes; h++) { Class<?> clazz = eventTypes.get(h); CopyOnWriteArrayList<Subscription> subscriptions; synchronized (this) { //找到订阅事件对应的订阅,这个是通过register加入的(还记得吗....) subscriptions = subscriptionsByEventType.get(clazz); } if (subscriptions != null && !subscriptions.isEmpty()) { 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; } } //如果没有订阅发现,那么会Post一个NoSubscriberEvent事件 if (!subscriptionFound) { Log.d(TAG, "No subscribers registered for event " + eventClass); if (eventClass != NoSubscriberEvent.class && eventClass != SubscriberExceptionEvent.class) { post(new NoSubscriberEvent(this, event)); } } }
这个方法有个核心方法 postToSubscription方法,进入看看吧
private void postToSubscription(Subscription subscription, Object event, boolean isMainThread) { //第一个参数就是传入的订阅,第二个参数就是对于的分发事件,第三个参数非常关键:是否在主线程 switch (subscription.subscriberMethod.threadMode) { //这个threadMode是怎么传入的,仔细想想?是不是根据onEvent,onEventMainThread,onEventBackground,onEventAsync决定的? case PostThread: //直接在本线程中调用订阅函数 invokeSubscriber(subscription, event); break; case MainThread: if (isMainThread) { //如果直接在主线程,那么直接在本现场中调用订阅函数 invokeSubscriber(subscription, event); } else { //如果不在主线程,那么通过handler实现在主线程中执行,具体我就不跟踪了 mainThreadPoster.enqueue(subscription, event); } break; case BackgroundThread: if (isMainThread) { //如果主线程,创建一个runnable丢入线程池中 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); } }
源码Demo使用下载地址:
相关文章推荐
- Android 中 EventBus 的使用之多线程事件处理
- EventBus
- android EventBus
- EventBus 学习
- EventBus 学习进阶
- eventbus简单使用
- Android EventBus实战 没听过你就out了
- 都在说EventBus,我也来一波EventBus
- EventBus的使用及 解决异常Subscriber ****has no public methods called **
- EventBus使用详解(一)——初步使用EventBus
- EventBus使用详解(二)——EventBus使用进阶
- 使用EventBus实现页面间数据的传递
- EventBus的初级使用技巧
- Event Bus在安卓开发中的使用场景和技巧
- EventBus学习笔记
- eventbus使用
- Android 中 EventBus 的使用(3):多线程事件处理
- Android 中 EventBus 的使用(2):缓存事件
- Android 中 EventBus 的使用(1):为什么要使用 EventBus
- EventBus实例