一文学会Java事件机制

本文同时发布于个人网站 https://ifuyao.com/blog/java-event/

相信做 Java 开发的朋友，大多都是学习过或至少了解过 Java GUI 编程的，其中有大量的事件和控件的绑定，当我们需要在点击某个按钮实现某些操作的时候，其实就是为这个按钮控件注册了一个合理处理点击事件的监听器。此外，Spring Framework 中也有许多用到事件处理机制的地方，如 ApplicationContextEvent 及其子类，代表着容器的启动、停止、关闭、刷新等事件。本文会为大家介绍 Java 的事件处理机制，也会用示例来说明，如何优雅地触发并处理一个自定义事件。

委托事件模型

Java 自 1.1 之后基于委托事件模型，定义了标准一致的获取和处理事件的方式。它的思路非常简单，由事件源发起特定事件，并将事件发送给一个或多个事件监听器，而监听器在此过程中一直处于等待状态，直到接收到该事件，然后处理事件并返回。实现起来也很简单：

• 定义事件
• 实现特定的监听器接口，接收特定类型的事件
• 实现代码，注册（或解除）监听器作为特定事件类型的接收者
• 在恰当的时机触发事件

核心组件

在 Java 的这个事件处理机制中，包含三个核心组件：

1. 事件 事件对象，描述相位的变化。比如在 GUI 中一个动作的点击，在 Spring Framework 中容器的启停，更多的诸如电脑的开机、关机、休眠，缓存的过期，公众号的关注、取关等等。

2. 事件源 可以是任意对象，它具备触发事件的能力。一般在这个对象中注册（或解除）监听器，此外事件的触发通常也在这里。一个源可能产生多个不同类的事件，要为不同的事件类型分别注册事件监听器，而每个事件类型可以注册一个或多个监听器。

3. 事件监听器 一个实现了特定接口的类，它需要实现对针对特定事件的具体处理方法，且必须被注册到该特定事件上。

那么问题来了，我们如何优雅地触发并处理一个自定义事件呢？

自定义事件

在 Java 中自定义事件非常简单。考虑到现在各个应用中都有绑定社交账号的需求，我们就以此为例，在社交账号绑定或者解绑时简单的打印一条记录。

首先定义一个事件对象，代码如下：

public class SocialEvent extends EventObject {
    private static final long serialVersionUID = -5473622737706032666L;

    public static final int WECHAT_BIND = 1;
    public static final int WECHAT_UNBIND = 2;
    public static final int WEIBO_BIND = 3;
    public static final int WEIBO_UNBIND = 4;

    private int socialType;

    public SocialEvent(Object source, int socialType) {
        super(source);
        this.socialType = socialType;
    }

    public int getSocialType() {
        return socialType;
    }

    public void setSocialType(int socialType) {
        this.socialType = socialType;
    }
}

事件类必须是 EventObject 的子类。值得一提的是，事件对象通常代表一类而非一个事件，即合理的做法是将一类事件而非一个事件概念融合起来。

接下来，我们实现一套事件处理逻辑，即事件监听器：

public class SocialEventListener implements EventListener {
    public void onSocialChanged(SocialEvent event) {
        switch (event.getSocialType()) {
            case SocialEvent.WECHAT_BIND:
                System.out.println("Wechat bind.");
                break;
            case SocialEvent.WECHAT_UNBIND:
                System.out.println("Wechat unbind.");
                break;
            case SocialEvent.WEIBO_BIND:
                System.out.println("Weibo bind.");
                break;
            case SocialEvent.WEIBO_UNBIND:
                System.out.println("Weibo unbind.");
                break;
            default:
                System.out.println("Bad social type.");
                break;
        }
    }
}

此外，我们需要一个事件源：

public class Social {

    private List<SocialEventListener> listeners;

    public void addListener(SocialEventListener listener) {
        if (listeners == null) {
            listeners = new ArrayList<>();
        }
        listeners.add(listener);
    }

    public void removeListener(SocialEventListener listener) {
        if (listeners != null) {
            listeners.remove(listener);
        }
    }

    public void emitEvent(SocialEvent event) {
        for (SocialEventListener listener : listeners) {
            listener.onSocialChanged(event);
        }
    }

    public List<SocialEventListener> getListeners() {
        return listeners;
    }

    public void setListeners(List<SocialEventListener> listeners) {
        this.listeners = listeners;
    }
}

在这里，我们定义了专门的类 Social 作为事件源，事实上，可以在任意其他的类中实现事件的触发与注册逻辑，比如启动类中。

顺便说一句，我们在 Java GUI 编程中，通常只需要为组件注册事件监听器，而无需考虑事件的触发逻辑，这是因为它们的事件是由系统自动触发的。

具体的代码实现细节，请参考源码 Demo Source Code