Spring實現內置監聽器

Posted on by

Spring內置監聽器

對於 Web 應用來說，ServletContext 對象是唯一的，一個 Web 應用，隻有一個ServletContext 對象，該對象是在 Web 應用裝載時初始化的。若將 Spring 容器的創建時機，放在 ServletContext 初始化時，就可以保證 Spring 容器的創建隻會執行一次，也就保證瞭Spring 容器在整個應用中的唯一性。

當 Spring 容器創建好後，在整個應用的生命周期過程中，Spring 容器應該是隨時可以被訪問的。即，Spring 容器應具有全局性。而放入 ServletContext 對象的屬性，就具有應用的全局性。所以，將創建好的 Spring 容器，以屬性的形式放入到 ServletContext 的空間中，就保證瞭 Spring 容器的全局性。

上述的這些工作，已經被封裝在瞭如下的 Spring 的 Jar 包的相關 API 中：spring-web-5.2.5.RELEASE

下面演示使用步驟

pom.xml文件中加入依賴

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-web</artifactId>
    <version>5.2.5.RELEASE</version>
</dependency>

在web.xml文件中註冊監聽器

若要在 ServletContext 初 始 化 時 創 建 Spring 容 器 ， 就 需 要 使 用 監 聽 器 接 口ServletContextListener 對 ServletContext 進行監聽。在 web.xml 中註冊該監聽器

Spring 為該監聽器接口定義瞭一個實現類 ContextLoaderListener，完成瞭兩個很重要的工作：創建容器對象，並將容器對象放入到瞭 ServletContext 的空間中。打開 ContextLoaderListener 的源碼。看到一共四個方法，兩個是構造方法，一個初始化方法，一個銷毀方法

<!--註冊監聽器 ContextLoaderListener-->
<!--
    監聽器被創建對象後，會讀取/WEB-INF/applicationContext.xml
    可以修改默認的文件位置，使用context-param重新指定文件位置
-->
<context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>classpath:applicationContext.xml</param-value>
</context-param>
<listener>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
try {
    if (this.context == null) {
        this.context = this.createWebApplicationContext(servletContext);
    }
    if (this.context instanceof ConfigurableWebApplicationContext) {
        ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext)this.context;
        if (!cwac.isActive()) {
            if (cwac.getParent() == null) {
                ApplicationContext parent = this.loadParentContext(servletContext);
                cwac.setParent(parent);
            }
            this.configureAndRefreshWebApplicationContext(cwac, servletContext);
        }
    }
    servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);

上面是initWebApplicationContext()方法的部分源碼，可以看到在該方法中創建瞭容器對象context，並且將context對象加入到瞭servletContext全局作用域對象中，key值為WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE

獲取容器對象

1、直接通過key值獲取

WebApplicationContext context = null;
Object attr = getServletContext().getAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE);
if (attr != null){
    context = (WebApplicationContext)attr;
}

2、通過WebApplicationContextUtils工具類獲取

以下是WebApplicationContextUtils中的調用關系可以清晰的獲得

public static WebApplicationContext getRequiredWebApplicationContext(ServletContext sc) throws IllegalStateException {
    WebApplicationContext wac = getWebApplicationContext(sc);
    if (wac == null) {
        throw new IllegalStateException("No WebApplicationContext found: no ContextLoaderListener registered?");
    } else {
        return wac;
    }
}
@Nullable
public static WebApplicationContext getWebApplicationContext(ServletContext sc) {
    return getWebApplicationContext(sc, WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE);
}
@Nullable
public static WebApplicationContext getWebApplicationContext(ServletContext sc, String attrName) {
    Assert.notNull(sc, "ServletContext must not be null");
    Object attr = sc.getAttribute(attrName);

ServletContext sc = getServletContext();
WebApplicationContext context = WebApplicationContextUtils.getWebApplicationContext(sc);

總結

本篇文章就到這裡瞭，希望能給你帶來幫助，也希望您能夠多多關註WalkonNet的更多內容！

推薦閱讀：