EventBus学习&事件

朴灿烈づ我的快乐病毒、 2022-09-06 01:25 184阅读 0赞

# 一、简介 #

EventBus是guava中的一个工具，EventBus允许组件之间通过发布-订阅进行通信，而不需要组件之间显示的注册。它专门设计为了代替使用显示注册的传统的Java进程内事件分发。它不是通用的发布-订阅系统，也不是用于进程间通信的。

优点：简化组件之间的通信。是发布者和订阅之间解耦，同时避免了复杂且容易出错的依赖性和生命周期问题。使代码更加简洁

## 1.1 三要素 ##

1）Event 事件。它可以是任意类型。

2）Publisher 事件的发布者（生产者）。管理和追踪监听者，EventBus内部已经实现了监听者的管理。

向监听者分发事件：我们可以在任意线程里发布事件，把事件传递给 [EventBus.post(Object)][EventBus.post_Object]方法。

异步分发可以直接用EventBus的子类[AsyncEventBus][]。

3）Subscriber 事件订阅者（监听者）。事件处理的方法名可以随意取，不过需要加上注解@subscribe()，并且指定线程模型，默认是POSTING。

a、监听特定的事件； 以CustomerChangeEvent为唯一参数创建方法，并用[Subscribe][]注解标记。

把事件监听者注册到事件生产者：在EventBus**实例**上调用[EventBus.register(Object)][EventBus.register_Object]方法；要保证事件生产者和监听者共享相同的EventBus**实例**。

b、按事件超类监听（如，EventObject甚至Object）

EventBus自动把事件分发给事件超类的监听者，并且允许监听者声明监听接口类型和泛型的通配符类型

c、检测么有监听者的事件：

监听[DeadEvent][]；EventBus会把所有发布后没有监听者处理的事件包装为DeadEvent

# 1.3 EventBus常用方法 #

<table> 
 <tbody> 
 <tr> 
 <th> /** * 创建EventBus对象, identifier为“default” */ public EventBus() { this("default"); } /** * 创建EventBus对象, identifier就是用一个字符串来标识EventBus */ public EventBus(String identifier); /** * 创建EventBus对象，exceptionHandler是异常处理类(消息处理过程中有异常，统一处理) * ps: identifier为“default” */ public EventBus(SubscriberExceptionHandler exceptionHandler); /** * EventBus对象标识 */ public final String identifier(); /** * 取消监听者的注册 */ public void unregister(Object object); /** * 发布一个消息 * * @param event 可以认为是消息 */ public void post(Object event); </th> 
 </tr> 
 </tbody> 
</table>

# 二、简单举例 #

## 2.1 事件定义 ##

@Data
    public class EventC {
        private String message;
    }

## 2.2 监听 ##

public class EventCListener {
        @Subscribe
        public void dealWithEvent(EventC eventC){
            System.out.println("deal Event~~~");
            System.out.println(eventC.toString());
        }
    }

## 2.3 测试 ##

public class TestEventC \{  
public static void main(String\[\] a)\{  
EventBus eventBus = new EventBus("eventC");  
eventBus.register(new EventCListener());  
EventC eventC = new EventC();  
eventC.setMessage("this is event C");  
eventBus.post(eventC);  
  
\}  
\}

## 2.4  按事件超类监听举例 ##

====基础事件

public class BaseEvent {
    }

====事件A

public class EventA extends BaseEvent {
        private String info;
    
        public String getInfo() {
            return info;
        }
    
        public void setInfo(String info) {
            this.info = info;
        }
    
        @Override
        public String toString() {
            return "EventA{" +
                    "info='" + info + '\'' +
                    '}';
        }
    }

====事件B

public class EventB  extends BaseEvent{
        private String info;
    
        public String getInfo() {
            return info;
        }
    
        public void setInfo(String info) {
            this.info = info;
        }
    
        @Override
        public String toString() {
            return "EventB{" +
                    "info='" + info + '\'' +
                    '}';
        }
    }

====基础事件监听

public class EventListener {
        @Subscribe
        public void Subscribe(BaseEvent event){
            System.out.println(event.toString());
        }
    
    }

====测试

public class TestEvent {
        public static void main(String[] a){
            EventA eventA = new EventA();
            eventA.setInfo("this is eventA");
    
            EventB eventB = new EventB();
            eventB.setInfo("this is eventB");
    
    //定义EventBus
            EventBus eventBus = new EventBus("baseEvent");
            eventBus.register(new EventListener());
    
            eventBus.post(eventA);
            eventBus.post(eventB);
    
    
        }
    }

## 2.5 监听超类并且不同具体事件的处理方式不同 ##

====事件同上

====监听类--接口类

public interface EventMrg<E extends BaseEvent> {
 void register();
 
 void unRegister();
 
 String type();
 
 void onSubscribe(E event);
 }
 ====监听实现实现类A

@MetaInfServices
 public class EventMrgAImpl implements EventMrg<EventA> {
 @Override
 public void register() {
 EventBusInner.register(this, type());
 }
 
 @Override
 public void unRegister() {
 
 }
 
 @Override
 public String type() {
 return "eventA";
 }
 
 @AllowConcurrentEvents
 @Subscribe
 @Override
 public void onSubscribe(EventA event) {
 System.out.println(System.currentTimeMillis() + " " + event.toString());
 }
 }

====监听实现实现类B

@MetaInfServices
 public class EventMrgBImpl implements EventMrg<EventB> {
 @Override
 public void register() {
 EventBusInner.register(this, type());
 }
 
 @Override
 public void unRegister() {
 
 }
 
 @Override
 public String type() {
 return "eventB";
 }
 
 @AllowConcurrentEvents
 @Subscribe
 @Override
 public void onSubscribe(EventB event) {
 System.out.println(System.currentTimeMillis() + " " + event.toString());
 }
 }
 =====测试

public class TestAync {
 public static void main(String[] a){
 ServiceLoader<EventMrg> load = ServiceLoader.load(EventMrg.class);
 Iterator<EventMrg> iterator = load.iterator();
 while (iterator.hasNext()){
 EventMrg next = iterator.next();
 next.register();
 }
 
 EventA eventA = new EventA();
 eventA.setInfo("this is eventA");
 
 EventB eventB = new EventB();
 eventB.setInfo("this is eventB");
 
 EventBusInner.post(eventA);
 EventBusInner.post(eventB);
 }

完~

[EventBus.post_Object]: http://docs.guava-libraries.googlecode.com/git-history/release/javadoc/com/google/common/eventbus/EventBus.html#post%28java.lang.Object%29
[AsyncEventBus]: http://docs.guava-libraries.googlecode.com/git-history/release/javadoc/com/google/common/eventbus/AsyncEventBus.html
[Subscribe]: http://docs.guava-libraries.googlecode.com/git-history/release/javadoc/com/google/common/eventbus/Subscribe.html
[EventBus.register_Object]: http://docs.guava-libraries.googlecode.com/git-history/release/javadoc/com/google/common/eventbus/EventBus.html#register%28java.lang.Object%29
[DeadEvent]: http://docs.guava-libraries.googlecode.com/git-history/release/javadoc/com/google/common/eventbus/DeadEvent.html