使用ServletContextListener實現優雅的系統初始化

ServletContext 被 Servlet 程序用來與 Web 容器通信。例如寫日誌，轉發請求。每一個 Web 應用程序含有一個Context，被Web應用內的各個程序共享。因爲Context可以用來保存資源並且共享，所以我所知道的 ServletContext 的最大應用是Web緩存----把不經常更改的內容讀入內存，所以服務器響應請求的時候就不需要進行慢速的磁盤I/O了。

ServletContextListener 是 ServletContext 的監聽者，如果 ServletContext 發生變化，如服務器啓動時 ServletContext 被創建，服務器關閉時 ServletContext 將要被銷燬。

在JSP 文件中，application 是 ServletContext 的實例，由JSP容器默認創建。Servlet 中調用 getServletContext()方法得到 ServletContext 的實例。

我們使用緩存的思路大概是：

1. 服 務器啓動時，ServletContextListener 的 contextInitialized()方法被調用，所以在裏面創建好緩存。可以從文件中或者從數據庫中讀取取緩存內容生成類，用 ervletContext.setAttribute()方法將緩存類保存在 ServletContext 的實例中。

2. 程 序使用 ServletContext.getAttribute()讀取緩存。如果是 JSP，使用a pplication.getAttribute()。如果是 Servlet，使用 getServletContext().getAttribute()。如果緩存發生變化(如訪問計數)，你可以同時更改緩存和文件/數據庫。或者你等 變化積累到一定程序再保存，也可以在下一步保存。

3. 服務器將要關閉 時，ServletContextListener 的 contextDestroyed()方法被調用，所以在裏面保存緩存的更改。將更改後的緩存保存迴文件或者數據庫，更新原來的內容。

 1  import  User;  // my own class 
 2  import  DatabaseManager;  //  my own class 
 3  import  javax.servlet.ServletContext;
 4  import  javax.servlet.ServletContextListener;
 5  
 6  public   class  MyContextListener
 7  
 8       implements  ServletContextListener {
 9       private  ServletContext context  =   null ;
10  
11       public   void  contextInitialized(ServletContextEvent event) {
12          context  =  event.getServletContext();
13          User user  =  DatabaseManager.getUserById( 1 );
14          context.setAttribute( " user1 " , user);
15      }
16  
17       public   void  contextDestroyed(ServletContextEvent event) {
18          User user  =  (User)context.getAttribute( " user1 " );
19          DatabaseManager.updateUserData(user);
20           this .context  =   null ;
21      }
22  }

佈署 ServletContextListener，你實現(implements)了 ServletContextListener 編譯後，把它放在正確的WEB-INF/classes目錄下，更改WEB-INF目錄下的 web.xml文件，在web-app節點裏添加

1  < listener > 
2       < listener-class > MyServletContextListener </ listener-class > 
3  </ listener >

在Struts中實現系統的初始化工作

在Struts中，我們可以寫一個Servlet讓它繼承於ActionServlet並覆 蓋其init()方法，然後修改web.xml文件的Struts啓動相關配置來達到目的。 

 

package fangwei.servlet;

import javax.servlet.ServletException;
import org.apache.struts.action.ActionServlet;

/**
 * 系統唯一的Servlet類BaseServlet<br>
 * 完成系統初始化的工作
 */
public class BaseServlet extends ActionServlet {

    private static final long serialVersionUID = -4743066925691800288L;

    @Override
    /*
     * 系統初始化
     */
    public void init() throws ServletException {
        super.init();

        // 初始化系統全局變量
        // ...

        // 加載自定義配置文件
        // ...

        // 啓動定時任務
        // ...
    }

}

 

Xml代碼

 

<?xml version="1.0" encoding="UTF-8"?>
<web-app>
  <!-- struts servlet begin -->
  <servlet>
    <servlet-name>struts</servlet-name>
    <servlet-class>fangwei.servlet.BaseServlet</servlet-class>
    <init-param>
      <param-name>config</param-name>
      <param-value>/WEB-INF/struts/struts-config.xml</param-value>
    </init-param>
    <load-on-startup>0</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>struts</servlet-name>
    <url-pattern>*.do</url-pattern>
  </servlet-mapping>
  <!-- struts servlet end -->
</web-app>

那麼，在Struts2 中我 們應該怎麼做呢？ 

在Struts2 中 實現系統的初始化工作

在Struts2 中， 我們可以寫一個filter讓它繼承於FilterDispatcher並覆蓋其 init()方法，然後修改web.xml文件的Struts2啓動相關配置來達到目的。

 

package fangwei.filter;

import javax.servlet.FilterConfig;
import javax.servlet.ServletException;

import org.apache.struts2.dispatcher.FilterDispatcher;

public class BaseFilterDispatcher extends FilterDispatcher {

    @Override
    public void init(FilterConfig arg0) throws ServletException {
        super.init(arg0);

        // 初始化系統全局變量
        // ...

        // 加載自定義配置文件
        // ...

        // 啓動定時任務
        // ...
    }

}

 

Xml代碼

 

 

<?xml version="1.0" encoding="UTF-8"?>
<web-app>
  <filter>
    <filter-name>struts2</filter-name>
    <filter-class>fangwei.filter.BaseFilterDispatcher</filter-class>
  </filter>
  <filter-mapping>
    <filter-name>struts2</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>
</web-app>

 

思考

不管是Struts、Struts2 還是其他的web層框架， 它們目前基於的技術都是 Servlet，只要根據web.xml找到那個啓動類，我們就能通過覆蓋該類的的init()方法來實現系統的初始化工作。

比較優雅的 實現系統的初始化工作

以上的實現方式都侵入了框架的原生類，利用Servlet 容器的特性我們可以更優雅的實現系統的初始化工作。 我 們可以寫一個listener讓它實現ServletContextListener 接 口，在contextInitialized()方法中做想做的事情。將此listener配置到web.xml中，Servlet容器如tomcat會 在啓動該web應用程序時調用此方法。

package fangwei.listener;

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;

public class InitListener implements ServletContextListener {

    public void contextDestroyed(ServletContextEvent sce) {
        System.out.println("web exit ... ");
    }

    public void contextInitialized(ServletContextEvent sce) {
        System.out.println("web init ... ");
        //系統的初始化工作
        // ...
    }

}

Xml代碼

<?xml version="1.0" encoding="UTF-8"?>
<web-app>
  <listener>
    <listener-class>fangwei.listener.InitListener</listener-class>
  </listener>
  <filter>
    <filter-name>struts2</filter-name>
    <filter-class>org.apache.struts2.dispatcher.FilterDispatcher</filter-class>
  </filter>
  <filter-mapping>
    <filter-name>struts2</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>

</web-app>

參考：

在 Servlet API 中有一個 ServletContextListener 接口，它能夠監聽 ServletContext 對象的生命週期，實際上就是監聽 Web 應用的生命週期。

當Servlet 容器啓動或終止Web 應用時，會觸發ServletContextEvent 事件，該事件由ServletContextListener 來處理。在 ServletContextListener 接口中定義了處理ServletContextEvent 事件的兩個方法。

Java代碼  

1. /** 
2.  * 當Servlet 容器啓動Web 應用時調用該方法。在調用完該方法之後，容器再對Filter 初始化， 
3.  * 並且對那些在Web 應用啓動時就需要被初始化的Servlet 進行初始化。 
4.  */  
5. contextInitialized(ServletContextEvent sce)   
6.   
7.   
8. /** 
9.  * 當Servlet 容器終止Web 應用時調用該方法。在調用該方法之前，容器會先銷燬所有的Servlet 和Filter 過濾器。 
10.  */  
11. contextDestroyed(ServletContextEvent sce)  

原文：

http://blog.163.com/yuxiangtong0524@126/blog/static/80086163201079112928456/

http://blog.csdn.net/ethanq/article/details/7358346