【Guava学习】EventBus

1,简单使用

首先引入guave的依赖;

<dependency>
    <groupId>com.google.guava</groupId>
    <artifactId>guava</artifactId>
    <version>23.6-jre</version>
</dependency>

再来看一下基础的使用:

EventBus eventBus = new EventBus();
eventBus.register(new Object() {
    @Subscribe
    public void hehe(String name) {
        System.out.println(name);
    }

    @Subscribe
    public void haha(Object object) {
        System.out.println(object);
    }
});
eventBus.post("huang");//输出两遍huang;
eventBus.post(17);//输出一遍17;
  • 首先需要一个总线EventBus,直接new出来;
  • 然后需要一个观察者,可以理解为监听器,最简洁的方式是直接new一个Object,然后向其中新增方法;
  • 然后需要将观察者注册到总线中;
  • 最后发布事件;

注意点:

  • 使用@Subscribe注解来标注方法,该方法的返回值不会被处理,所以有无返回值都是一样的,方法的参数类型是接受的事件类型,所以方法有且只能有一个参数;
  • 当多个标注了@Subscribe的方法的参数存在父子关系的时候,当发布子类型的事件时,父类型的方法也将被执行,这就是上面代码输出两遍huang的原因;
  • 如果方法只标注了@Subscribe,那么该方法的执行是同步的,即使是多线程发布同一事件,那多个线程之间存在互斥锁,同一时间点,只能有一个或零个执行该方法,如下面的代码所示;
EventBus eventBus = new EventBus();
eventBus.register(new Object() {
    @Subscribe
    public void hehe(Integer num) throws InterruptedException {
        System.out.println(num + ":" + System.currentTimeMillis());
        Thread.currentThread().sleep(100);
    }
});
for (int i = 0; i < 10; i++) {
    int finalI = i;
    new Thread(new Runnable() {
        @Override
        public void run() {
            eventBus.post(finalI);
        }
    }).start();
}
//4:1517538494324
//1:1517538494425
//8:1517538494529
//0:1517538494632
//5:1517538494735
//2:1517538494838
//9:1517538494942
//6:1517538495043
//3:1517538495147
//7:1517538495250

2,关于EventBus的并行

线程安全问题是每个java程序猿都应该时刻注意的,当带有@Subscribe的方法被多个方法同时执行,且该方法内部逻辑涉及到更改成员变量时,就会出现线程安全问题,在默认情况下,如果只有@Subscribe注解时,方法时是异步执行的,即使多个线程同时调用,也需要竞争方法的同步锁,然后依次执行;

当需要@Subscribe标注的方法能被多个线程同时调用,需要配合@AllowConcurrentEvents注解使用,该注解表示允许并行执行该方法,当有多个线程同时调用方法时,因为方法无锁,所以线程可以同时进入执行,有锁和无锁,取决于@AllowConcurrentEvents,当没有该注解时,EventBus在生成Subscriber时,使用了SynchronizedSubscriber,该类型在真实调用带有@Subscribe方法时,使用了同步锁,具体后面讲解;

EventBus eventBus = new EventBus();
eventBus.register(new Object() {
    @Subscribe
    @AllowConcurrentEvents
    public void hehe(Integer num) throws InterruptedException {
        System.out.println(num + ":" + System.currentTimeMillis());
        Thread.currentThread().sleep(100);
    }
});
for (int i = 0; i < 10; i++) {
    int finalI = i;
    new Thread(new Runnable() {
        @Override
        public void run() {
            eventBus.post(finalI);
        }
    }).start();
}
//7:1517543101034
//9:1517543101034
//1:1517543101034
//4:1517543101034
//5:1517543101034
//8:1517543101034
//0:1517543101034
//6:1517543101034
//2:1517543101034
//3:1517543101034

关于多线程调用:

  • 当直接new一个EventBus时,当使用post方法发布一个事件是,那么调用带有@Subscribe的方法的线程是当前线程,在哪个线程中调用,就在哪个线程中执行;
  • 当需要在多线程中执行同一个标注了@Subscribe的方法时,需要使用AsyncEventBus类,并指定一个Executor线程池,那么发布事件时,调用的方法都将在指定的线程池中执行;
  • 即使指定了线程池,如果没有使用@AllowConcurrentEvents,那么即使调用方法(同一方法)的线程不一样,因为同步锁的存在,执行的时机还是依次执行,多个线程并不会同时执行同一方法;
  • 只有指定了线程池,并且使用了@AllowConcurrentEvents注解,才能实现在多个线程中同时调用某个标注了@Subscribe的方法,这时需要格外注意线程并发导致的线程安全问题;
EventBus eventBus = new AsyncEventBus(Executors.newFixedThreadPool(3));
eventBus.register(new Object() {
    @Subscribe
    @AllowConcurrentEvents
    public void hehe(Integer num) throws InterruptedException {
        Thread.currentThread().sleep(100);
        System.out.println(Thread.currentThread().getName() + "-" + num + "-" + System.currentTimeMillis());
    }
});
for (int i = 0; i < 9; i++) {
    eventBus.post(i);
}
//pool-1-thread-2-1-1517546343599
//pool-1-thread-1-0-1517546343599
//pool-1-thread-3-2-1517546343599
//pool-1-thread-2-3-1517546343704
//pool-1-thread-3-5-1517546343704
//pool-1-thread-1-4-1517546343704
//pool-1-thread-3-7-1517546343807
//pool-1-thread-1-8-1517546343807
//pool-1-thread-2-6-1517546343807

3,源码解析

基本组件:

  • Executor:执行的线程池,默认是DirectExecutor,他未开启新的线程,而是在当前线程中直接执行;
  • SubscriberRegistry:Subscriber注册器,每个带有@Subscribe的方法会被注册到该类中;
  • Dispatcher:调度器,负责将事件,分发给事件对应的Subscriber,并使用Executor执行这些Subscriber;
  • SubscriberExceptionHandler:异常处理器,用来处理异常;

3.1,Executor

private enum DirectExecutor implements Executor {
    INSTANCE;
    
    @Override
    public void execute(Runnable command) {
      command.run();
    }
    
    @Override
    public String toString() {
      return "MoreExecutors.directExecutor()";
    }
}
  • 默认的执行器,直接实现了Executor接口,然后覆写方法,因为没有开启新的线程,所以默认是在当前线程中执行;
  • 如果是在主线程中调用,那么DirectExecutor对应的线程就是主线程,如果在其他线程中执行,那么DirectExecutor对应的就是其他线程,总之,就是调用线程;

3.2,Dispatcher

private static final class PerThreadQueuedDispatcher extends Dispatcher {
    private final ThreadLocal<Queue<Event>> queue =
            new ThreadLocal<Queue<Event>>() {
                @Override
                protected Queue<Event> initialValue() {
                    return Queues.newArrayDeque();
                }
            };

    private final ThreadLocal<Boolean> dispatching =
            new ThreadLocal<Boolean>() {
                @Override
                protected Boolean initialValue() {
                    return false;
                }
            };

    @Override
    void dispatch(Object event, Iterator<Subscriber> subscribers) {
        checkNotNull(event);
        checkNotNull(subscribers);
        Queue<Event> queueForThread = queue.get();
        queueForThread.offer(new Event(event, subscribers));

        if (!dispatching.get()) {
            dispatching.set(true);
            try 
                Event nextEvent;
                while ((nextEvent = queueForThread.poll()) != null) {
                    while (nextEvent.subscribers.hasNext()) {
                        nextEvent.subscribers.next().dispatchEvent(nextEvent.event);
                    }
                }
            } finally {
                dispatching.remove();
                queue.remove();
            }
        }
    }
}
  • 该调度器名为单线程调度器,当某个线程调用dispatch方法时,首先从当前线程中获取queue,这是一个ThreadLocal类型的Event队列,然后将当前事件放置进去;
  • 然后根据同样是ThreadLocal类型的dispatching字段,判断是否正在调用中,如果不是,则开始执行具体的调度任务;
    • 但是此处的if判断我不是很理解,因为结果必然一定成立;
    • 如果是单个线程,if条件中的逻辑没有执行完时,是不可能再次调用dispatch方法的;
    • 如果是多线程调用,每个线程拿到的dispatching都是不同的,相互之间不存在干扰,所以这个if条件是必然成立的,望大神排异解惑;

下面的代码是具体的调用逻辑,使用的是Executor进行具体调用,并执行方法:

final void dispatchEvent(final Object event) {
    executor.execute(
            new Runnable() {
                @Override
                public void run() {
                    try {
                        invokeSubscriberMethod(event);
                    } catch (InvocationTargetException e) {
                        bus.handleSubscriberException(e.getCause(), context(event));
                    }
                }
            });
}

@VisibleForTesting
void invokeSubscriberMethod(Object event) throws InvocationTargetException {
    try {
        method.invoke(target, checkNotNull(event));
    } catch (IllegalArgumentException e) {
        throw new Error("Method rejected target/argument: " + event, e);
    } catch (IllegalAccessException e) {
        throw new Error("Method became inaccessible: " + event, e);
    } catch (InvocationTargetException e) {
        if (e.getCause() instanceof Error) {
            throw (Error) e.getCause();
        }
        throw e;
    }
}

3.3,SubscriberRegistry

  • SubscriberRegistry只有一个类就是SubscriberRegistry;
  • 该类可以注册也可以取消注册Subscriber;
  • 还需要注意的是,当没有@AllowConcurrentEvents注解时,Subscriber使用的是SynchronizedSubscriber类型,而有@AllowConcurrentEvents注解时,使用的是Subscriber类型;
    • 当方法被调用时都是调用invokeSubscriberMethod方法;
    • SynchronizedSubscriber类继承了Subscriber类,并重写了invokeSubscriberMethod方法;
    • 不同的是SynchronizedSubscriber类型对方法使用了同步锁,导致的结果就是,没有@AllowConcurrentEvents注解时invokeSubscriberMethod方法会在多个线程中同步执行;
static final class SynchronizedSubscriber extends Subscriber {

    private SynchronizedSubscriber(EventBus bus, Object target, Method method) {
        super(bus, target, method);
    }

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

推荐阅读更多精彩内容

  • 我从去年开始使用 RxJava ,到现在一年多了。今年加入了 Flipboard 后,看到 Flipboard 的...
    Jason_andy阅读 5,381评论 7 62
  • 转一篇文章 原地址:http://gank.io/post/560e15be2dca930e00da1083 前言...
    jack_hong阅读 883评论 0 2
  • 来自于:CSDNblog.csdn.net/caihongdao123/article/details/51897...
    于加泽阅读 1,216评论 0 5
  • 从来不知道一米五几的自己也会被说太要强。 而且是从你的嘴里。 我应该早点醒悟的。 见面那天,我蹬着高跟鞋绕着会场跑...
    刘怪怪阅读 301评论 0 2
  • 月底又赶上季度结束,公司的事,都催的紧。一天什么都不写的话,感觉一天匆匆而过,都没有什么值得留恋的。 公司里的...
    右右多阅读 141评论 2 2