一文學會Java事件機制

北魚扶搖發表於2021-10-13
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

相關文章