Tomcat與Spring中的事件機制詳解

knock_小新發表於2019-03-01
TomcatSpring事件

引言

最近在看tomcat原始碼，原始碼中出現了大量事件訊息，可以說整個tomcat的啟動流程都可以通過事件派發機制串起來，研究透了tomcat的各種事件訊息，基本上對tomcat的啟動流程也就有了一個整體的認識。在這一基礎上，聯想到之前在看spring原始碼過程中也存在不少事件相關知識，於是想對這兩個框架中的事件派發機制做一個簡單的總結，加深理解。

事件機制原理其實比較簡單，抽象來看的話，設計模式中的觀察者模式可以說是最經典的事件驅動機制的體現了，觀察者和被觀察者就體現了事件監聽和事件派發的角色。還有各種MQ，其實也是事件機制的一種體現。

理解tomcat和spring中的事件機制之前，讓我們先從最基本的jdk中提供的事件機制開始說起。

JDK中的事件機制

JDK中對事件機制的各個角色提供了完善的抽象，主要包括3個角色：

EventObject（事件關注內容）：事件釋出時需要關注的內容。jdk中提供了EventObject介面。

EventListener（事件監聽者）：事件監聽物件，也就是對EventObject感興趣的物件。jdk中提供了EventListener介面。

EventSource（事件源）：釋出事件的物件，可以在該物件中組冊EventListener，然後在特定的條件下發布EventObject給已經註冊的EventListener。

事件的註冊與釋出，需要這三個物件協同工作，可以通過下面的例子來說明各個物件的作用：

首先是事件關注內容物件MyEventObject，實現了EventObject介面。eventName引數為具體的事件關注內容

public class MyEventObject extends EventObject {

	private String eventName ;
	
	public MyEventObject (Object source, String eventName) {
		
		super(source);
		this.setEventName(eventName);
	}

	public String getEventName() {
		return eventName;
	}

	public void setEventName(String eventName) {
		this.eventName = eventName;
	}

	private static final long serialVersionUID = 8374250957018011175L;
}
複製程式碼

其次是事件監聽介面MyEventListener，繼承了EventListener，定義了一個myEvent介面用來發布事件，任何感興趣的監聽物件都可以實現該介面來監聽。

對MyEventObject感興趣的監聽者MyEventListenerImpl，實現了MyEventListener介面，當事件釋出時會觸發myEvent事件並收到MyEventObject物件。

public interface MyEventListener extends EventListener {

	public void myEvent(MyEventObject eventObject);
}

public class MyEventListenerImpl implements MyEventListener {

	@Override
	public void myEvent(MyEventObject eventObject) {

		System.out.println("MyEventListenerImpl --- " + eventObject.getEventName());
	}
}
複製程式碼

最後是事件釋出源物件MyEventSource，它可以註冊多個事件監聽物件，任何實現了MyEventListener介面的監聽物件都可以註冊，內部通過一個Set來儲存感興趣的監聽物件，並在合適的時機會發布訊息並通知所有監聽物件。

public class MyEventSource {

	private Set<MyEventListener> myEventListeners = new HashSet<>();
	
	public void addListener(MyEventListener listener){
		
		this.myEventListeners.add(listener);
	}
	
	public void removeListener(MyEventListener listener){
		
		this.myEventListeners.remove(listener);
	}
	
	public void pushEvent(){
		//dosomething
        //釋出push event訊息
		notifyListener(new MyEventObject(this, "push event"));
	}
	
	private void notifyListener(MyEventObject eventObject){
		
		for (MyEventListener myEventListener : myEventListeners) {
			myEventListener.myEvent(eventObject);
		}
	}
}
複製程式碼

之後可以通過一個啟動類來註冊並觸發事件：

public static void main(String[] args) {
    
    MyEventSource myEventSource = new MyEventSource();
    
    MyEventListenerImpl myEventListenerImpl = new MyEventListenerImpl();
    
    myEventSource.addListener(myEventListenerImpl);
    
    myEventSource.pushEvent();
}
複製程式碼

MyEventObject定義了感興趣的內容，MyEventListenerImpl是對MyEventObject感興趣的監聽者，MyEventSource會發布MyEventObject給所有組冊的監聽者，最後通過一個main來啟動整個流程。

明白了jdk中對事件機制的定義，再來看看tomcat和spring中的事件機制。

Tomcat的事件機制

tomcat的事件機制也離不開EventObject、EventListener以及EventSource三個物件，只不過在此基礎上提供了更加抽象和便捷的操作。這裡我挑選tomcat的生命週期介面物件Lifecycle來講解整個事件釋出流程：

首先還是EventObject物件LifecycleEvent，這裡只列出了核心程式碼。它的主要引數是Lifecycle，Lifecycle中定義了tomcat各個階段的名稱：before_init、after_init、start等等，是事件監聽者感興趣的物件。

public final class LifecycleEvent extends EventObject {

    //......

    public LifecycleEvent(Lifecycle lifecycle, String type, Object data) {

        super(lifecycle);
        this.type = type;
        this.data = data;
    }

    //......
}

public interface Lifecycle {
    /**
     * The LifecycleEvent type for the "component after init" event.
     */
    public static final String BEFORE_INIT_EVENT = "before_init";

    /**
     * The LifecycleEvent type for the "component after init" event.
     */
    public static final String AFTER_INIT_EVENT = "after_init";

    /**
     * The LifecycleEvent type for the "component start" event.
     */
    public static final String START_EVENT = "start";

    //......
}
複製程式碼

事件監聽介面LifecycleListener，定義了lifecycleEvent方法用來傳遞監聽者感興趣的LifecycleEvent物件，監聽者使用LifecycleEvent引數用來在tomcat的各個階段處理進行相應處理。這些感興趣的物件包括下面這些類：

Tomcat與Spring中的事件機制詳解

這裡使用ContextConfig類為例，可以看到它實現了LifecycleListener介面。這個類在解析server.xml的時候用來監聽StandardContext的各個階段的事件，並做出相應處理：

public interface LifecycleListener {

    public void lifecycleEvent(LifecycleEvent event);
}

public class ContextConfig implements LifecycleListener {
    
    //......
    @Override
    public void lifecycleEvent(LifecycleEvent event) {

        // Identify the context we are associated with
        try {
            context = (Context) event.getLifecycle();
        } catch (ClassCastException e) {
            log.error(sm.getString("contextConfig.cce", event.getLifecycle()), e);
            return;
        }

        // Process the event that has occurred
        if (event.getType().equals(Lifecycle.CONFIGURE_START_EVENT)) {
            configureStart();
        } else if (event.getType().equals(Lifecycle.BEFORE_START_EVENT)) {
            beforeStart();
        } else if (event.getType().equals(Lifecycle.AFTER_START_EVENT)) {
            // Restore docBase for management tools
            if (originalDocBase != null) {
                context.setDocBase(originalDocBase);
            }
        } else if (event.getType().equals(Lifecycle.CONFIGURE_STOP_EVENT)) {
            configureStop();
        } else if (event.getType().equals(Lifecycle.AFTER_INIT_EVENT)) {
            init();
        } else if (event.getType().equals(Lifecycle.AFTER_DESTROY_EVENT)) {
            destroy();
        }
    }

    //......
}
複製程式碼

LifecycleSupport是我們需要了解的主要物件，它是監聽物件的一個管理類，原理其實和上面的例子差不多，對應了MyEventSource類的部分功能，方便EventSource類來管理監聽物件。它把對監聽物件的新增移除以及釋出事件幾個操作進行了統一管理，避免EventSource類中出現太多管理監聽物件的邏輯。

public final class LifecycleSupport {

    //......

    //監聽物件集合
    private LifecycleListener listeners[] = new LifecycleListener[0];
    
    private final Object listenersLock = new Object(); // Lock object for changes to listeners

    //新增監聽物件
    public void addLifecycleListener(LifecycleListener listener) {

      synchronized (listenersLock) {
          LifecycleListener results[] =
            new LifecycleListener[listeners.length + 1];
          for (int i = 0; i < listeners.length; i++)
              results[i] = listeners[i];
          results[listeners.length] = listener;
          listeners = results;
      }

    }

    //釋出監聽物件
    public void fireLifecycleEvent(String type, Object data) {

        LifecycleEvent event = new LifecycleEvent(lifecycle, type, data);
        LifecycleListener interested[] = listeners;
        for (int i = 0; i < interested.length; i++)
            interested[i].lifecycleEvent(event);

    }

    //移除監聽物件
    public void removeLifecycleListener(LifecycleListener listener) {

        synchronized (listenersLock) {
            int n = -1;
            for (int i = 0; i < listeners.length; i++) {
                if (listeners[i] == listener) {
                    n = i;
                    break;
                }
            }
            if (n < 0)
                return;
            LifecycleListener results[] =
              new LifecycleListener[listeners.length - 1];
            int j = 0;
            for (int i = 0; i < listeners.length; i++) {
                if (i != n)
                    results[j++] = listeners[i];
            }
            listeners = results;
        }
    }
}
複製程式碼

使用了LifecycleSupport之後，操作LifecycleListener就簡單多了，只需要呼叫LifecycleSupport的各個方法就可以了：

public abstract class LifecycleBase implements Lifecycle{

    //......
    private LifecycleSupport lifecycle = new LifecycleSupport(this);

    @Override
    public void addLifecycleListener(LifecycleListener listener) {
        lifecycle.addLifecycleListener(listener);
    }

    @Override
    public void removeLifecycleListener(LifecycleListener listener) {
        lifecycle.removeLifecycleListener(listener);
    }

    protected void fireLifecycleEvent(String type, Object data) {
        lifecycle.fireLifecycleEvent(type, data);
    }
    //......
}
複製程式碼

在需要釋出事件時呼叫fireLifecycleEvent方法就可以釋出事件：

fireLifecycleEvent(Lifecycle.CONFIGURE_STOP_EVENT, null);
複製程式碼

tomcat事件機制就是在之前的例子上抽出了一個LifecycleSupport類來方便管理監聽物件的各種操作，這是一個可以借鑑的地方，其他差別並不大。再來看看spring中對事件機制的處理。

Spring的事件機制

spring中的事件機制原理也是一樣的，只是相對來說實現上稍微複雜一點。還是通過相同的角度來看這個問題。

首先是EventObject，spring裡面的主要實現是ApplicationEvent：

Tomcat與Spring中的事件機制詳解

這裡通過ContextStartedEvent類來檢視EventObject，它關注的物件是ApplicationContext，是spring容器在啟動時觸發的事件物件：

public abstract class ApplicationEvent extends EventObject {

    //......
	public ApplicationEvent(Object source) {
		super(source);
		this.timestamp = System.currentTimeMillis();
	}
    //......
}

public abstract class ApplicationContextEvent extends ApplicationEvent {
    public ApplicationContextEvent(ApplicationContext source) {
        super(source);
    }

    public final ApplicationContext getApplicationContext() {
        return (ApplicationContext)this.getSource();
    }
}

public class ContextStartedEvent extends ApplicationContextEvent {
    public ContextStartedEvent(ApplicationContext source) {
        super(source);
    }
}
複製程式碼

事件監聽介面ApplicationListener，定義了onApplicationEvent方法用來傳遞監聽者感興趣的ApplicationEvent物件，監聽者使用ApplicationEvent引數用來在Context的各個階段處理進行相應處理。

如果我們需要在容器啟動後進行相應處理，那麼我們可以在業務類中實現ApplicationListener介面，在事件發生時就會發起通知：

public interface ApplicationListener<E extends ApplicationEvent> extends EventListener {

	void onApplicationEvent(E event);
}

public class MyApplicationListener implements ApplicationListener<ApplicationEvent> {

    @Override
    public void onApplicationEvent(ApplicationEvent applicationEvent) {

        if (applicationEvent instanceof ContextRefreshedEvent){

            System.out.println("context refresh!");   
        }
    }
}
複製程式碼

那麼在spring框架中是怎麼釋出這些事件的呢？是不是也有一個類似tomcat中LifecycleSupport一樣的類呢？通過檢視原始碼可以發現發現，ApplicationContext容器在初始化階段會呼叫refresh()方法，這其中又呼叫了
finishRefresh()方法，這其中呼叫了publishEvent(new ContextRefreshedEvent(this))方法，釋出了ContextRefreshedEvent這一物件。

protected void finishRefresh() {
    
    //......
    // Publish the final event.
    publishEvent(new ContextRefreshedEvent(this));
}

protected void publishEvent(Object event, @Nullable ResolvableType eventType) {

    //......
    getApplicationEventMulticaster().multicastEvent(applicationEvent, eventType);
    //......
}

publishEvent方法通過呼叫一個預設的多播器SimpleApplicationEventMulticaster的multicastEvent方法來發布各種事件：

SimpleApplicationEventMulticaster
public void multicastEvent(final ApplicationEvent event, @Nullable ResolvableType eventType) {
    ResolvableType type = (eventType != null ? eventType : resolveDefaultEventType(event));

    //通過getApplicationListeners獲取了所有監聽器，然後通過invokeListener方法迴圈釋出事件
    for (final ApplicationListener<?> listener : getApplicationListeners(event, type)) {
        Executor executor = getTaskExecutor();
        if (executor != null) {
            executor.execute(() -> invokeListener(listener, event));
        }
        else {
            invokeListener(listener, event);
        }
    }
}

protected void invokeListener(ApplicationListener<?> listener, ApplicationEvent event) {
    //......
    doInvokeListener(listener, event);
}

private void doInvokeListener(ApplicationListener listener, ApplicationEvent event) {
    //......
    listener.onApplicationEvent(event);
}
複製程式碼

也就是說在spring容器中釋出ApplicationListener所關注的物件是通過SimpleApplicationEventMulticaster這個類來管理的，和tomcat中LifecycleSupport的功能類似，只是在實現上有略微差別。

最後提一句，在spring中你也可以自己釋出各種事件，呼叫ApplicationContext的publishEvent方法即可。

applicationContext.publishEvent(new ApplicationEvent(new String("事件釋出")) { });
複製程式碼

總結

這篇文章對Java的事件機制在tomcat以及spring框架中的實現做了一個簡單總結和對比，你需要知道以下幾點：

  1. JDK中定義了EventObject和EventListener兩個介面，奠定了事件機制的基礎。
  2. Tomcat額外提供了一個support類來對監聽器的新增刪除以及釋出進行管理。
  3. Spring容器內部通過SimpleApplicationEventMulticaster來發布各個事件，使用者可以通過實現ApplicationListener介面來監聽自己感興趣的容器事件。

希望你通過這篇文章的學習可以對Java的事件機制有一個更深刻的認識，在實現自己的事件機制時有可以借鑑以及改進的地方。

相關文章