记一个Otto Bus使用上的坑

缘起

今天晚上有个同事找我看一个问题,因为他们用到了我们的模块,而我们模块会在工作结束时调用他们塞进来的callback返回回去,但是在他们的callback中两段基本相同的代码却有着不一样的行为,很是令人费解。类似下面这样:

以下是callback中的伪代码:

case 1: // 不同的case,执行的逻辑是相同的
    // before notify code
    notifyResult(case 1); // 这里面有bus.postEvent(Intent)的调用
    // after notify code
    break;
case 2:
    // before notify code
    notifyResult(case 2); // 这里面有bus.postEvent(Intent)的调用
    // after notify code
    break;


另外的某个Act中有handler方法,如下:
@subscribe
public void eventConsumeMethod(Intent intent) {
    System.out.println("consumed");
}

一般大家都会觉得这2种没什么差别,输出(执行顺序)都应该是:
before -> consumed - > after
在这里的case2确实是这样,但case1的输出却是:
before -> after -> consumed
我当时看到的时候也觉得很不可思议,因为Bus的代码我曾经认真看过,按我的理解post event肯定会同步执行的,即post event紧接着就会进到handler方法中,所以这里consume肯定是接着before的啊。下面让我们来分析下出现这个神奇现象的原因。

源码&单步

在分析之前,再补充说明下,前面代码中的case1是通过我们模块里的post Event调出去的,而case2是直接正常回调出去的。
接下来,当我单步调试的时候,很自然地来到了Bus.post(Object event)方法,其源码如下:

public void post(Object event) {
  if (event == null) {
    throw new NullPointerException("Event to post must not be null.");
  }
  enforcer.enforce(this);

  Set<Class<?>> dispatchTypes = flattenHierarchy(event.getClass());

  boolean dispatched = false;
  for (Class<?> eventType : dispatchTypes) {
    Set<EventHandler> wrappers = getHandlersForEventType(eventType);

    if (wrappers != null && !wrappers.isEmpty()) {
      dispatched = true;
      for (EventHandler wrapper : wrappers) {
        enqueueEvent(event, wrapper);
      }
    }
  }

  if (!dispatched && !(event instanceof DeadEvent)) {
    post(new DeadEvent(this, event));
  }

  dispatchQueuedEvents();
}

当出现上面case1的情况时,我就在想会不会是在post的过程中有某些return导致提前返回了,所以在看代码的时候,我专门留意了下,这个方法看起来没有我想要找的return,最后我们来到了dispatchQueuedEvents方法,接着往下看,其源码如下:

protected void dispatchQueuedEvents() {
    // don't dispatch if we're already dispatching, that would allow reentrancy and out-of-order events. Instead, leave
    // the events to be dispatched after the in-progress dispatch is complete.
    if (isDispatching.get()) {
      return; // 罪魁祸首就是这货!!!
    }

    isDispatching.set(true);
    try {
      while (true) {
        EventWithHandler eventWithHandler = eventsToDispatch.get().poll();
        if (eventWithHandler == null) {
          break;
        }

        if (eventWithHandler.handler.isValid()) {
          dispatch(eventWithHandler.event, eventWithHandler.handler);
        }
      }
    } finally {
      isDispatching.set(false);
    }
  

一进来的if和注释算是给了我们答案,我单步debug的时候也发现确实是在此处提前return了,即这次事件并没有马上被处理。这里的注释翻译下就是说:
如果我们正在分发事件,则不继续分发又出现的事件,因为那样会导致事件重入和乱序,所以我们会在处理完当前的事件后再回过头来处理新发生的事件。这里的isDispatching,是个ThreadLocal<Boolean>类型,和每个线程关联。这段代码和注释对应到我们前面出问题的case1中就是:
在我们代码中是通过处理A事件调到上面的callback的(即正在分发处理事件A),而case1中又post了一个新的事件B,so按照这段源码的意思,在处理A事件的过程中,B不会被处理,而是等A处理完后,才会回过来接着处理B,注意理解上面源码中的while(true)循环。

总结

一般来说,即使发生了case1的情况也不是啥大问题,但很不巧的是,这位同事的代码刚好就需要先执行consume方法,然后再执行after逻辑,否则就不对。所以,通过上面的分析,我们也看到了,使用Otto Bus最好不要在处理某个事件的过程中又post了另一个事件,因为越复杂的case,可能会产生越出乎你意料之外的行为,有时也可能会困扰你

当然了,如果全是自己控制,那很好办,大家很容易能避开这样的写法,但就像我们这里一样,一个大的app经常是需要各个模块配合工作的,别人调用你的方法,你不大可能知道他是以怎样的形式回调你的,所以想避免还是不那么明显的。针对这个问题,可以很简单的用Handler.postRunnable来解决,避开post事件的嵌套。可能还有更好的解决方式,欢迎交流、指正。

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,100评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,569评论 25 707
  • ¥开启¥ 【iAPP实现进入界面执行逐一显】 〖2017-08-25 15:22:14〗 《//首先开一个线程,因...
    小菜c阅读 6,204评论 0 17
  • topics: 1.The Node.js philosophy 2.The reactor pattern 3....
    宫若石阅读 1,008评论 0 1
  • 它好像爱上她了。 那个炎热的夏天,空气中都浮动着燥热,它趴在那颗老槐树上,恪尽职守地叫着。突然,它看到了她,那么美...
    鲸衿阅读 181评论 0 0