ServletContextListener使用詳解

在 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. * 當Servlet 容器終止Web 應用時調用該方法。在調用該方法之前,容器會先銷燬所有的Servlet 和Filter 過濾器。

  8. */  

  9. contextDestroyed(ServletContextEvent sce)  

下面通過兩個具體的例子來介紹 ServletContextListener 的用法。


例一:在服務啓動時,將數據庫中的數據加載進內存,並將其賦值給一個屬性名,其它的 Servlet 就可以通過 getAttribute 進行屬性值的訪問。


有如下兩個步驟:


1 : ServletContext 對象是一個爲整個 web 應用提供共享的內存,任何請求都可以訪問裏面的內容  


2 :如何實現在服務啓動的時候就動態的加入到裏面的內容:我們需要做的有:  

1 ) 實現 servletContextListerner 接口 並將要共享的通過 setAttribute ( name,data )方法提交到內存中去   ;

2 )應用項目通過 getAttribute(name) 將數據取到 。


Java代碼  收藏代碼
  1. public class ServletContextLTest implements ServletContextListener{  


  2.    // 實現其中的銷燬函數  


  3.    public void contextDestroyed(ServletContextEvent sce) {  


  4.        System.out.println("this is last destroyeed");      


  5.    }  


  6.    // 實現其中的初始化函數,當有事件發生時即觸發  


  7.    public void contextInitialized(ServletContextEvent sce) {  


  8.        ServletContext sct=sce.getServletContext();  


  9.        Map<Integer,String> depts=new HashMap<Integer,String>();  


  10.        Connection connection=null;  


  11.        PreparedStatement pstm=null;  


  12.        ResultSet rs=null;  




  13.        try{  


  14.            connection=ConnectTool.getConnection();  


  15.            String sql="select deptNo,dname from dept";  


  16.            pstm=connection.prepareStatement(sql);  


  17.            rs=pstm.executeQuery();  


  18.            while(rs.next()){  


  19.                depts.put(rs.getInt(1), rs.getString(2));  


  20.            }  


  21.            // 將所取到的值存放到一個屬性鍵值對中  


  22.            sct.setAttribute("dept", depts);  


  23.            System.out.println("======listener test is beginning=========");  


  24.        }catch(Exception e){  


  25.            e.printStackTrace();  


  26.        }finally{  


  27.            ConnectTool.releasersc(rs, pstm, connection);  


  28.        }  


  29.    }  


  30. }  

在完成上述編碼後,仍需在 web.xml 中進行如下配置,以使得該監聽器可以起作用。


Xml代碼  收藏代碼
  1. <listener>  


  2.   <listener-class>ServletContextTest.ServletContextLTest</listener-class>  


  3. </listener>    


在完成上述配置後, web 服務器在啓動時,會直接加載該監聽器,通過以下的應用程序就可以進行數據的訪問。


Java代碼  收藏代碼
  1. public class CreateEmployee extends HttpServlet{  


  2.    @Override  


  3.    protected void service(HttpServletRequest request, HttpServletResponse response)  


  4.            throws ServletException, IOException {  


  5.        ServletContext sct=getServletConfig().getServletContext();  


  6.        // 從上下文環境中通過屬性名獲取屬性值  


  7.        Map<Integer,String> dept=(Map<Integer,String>)sct.getAttribute("dept");  


  8.        Set<Integer> key=dept.keySet();  


  9.        response.setContentType("text/html;charset=utf-8");  


  10.        PrintWriter out=response.getWriter();  


  11.        out.println("<html>");  


  12.        out.println("<body>");  


  13.        out.println("<form action='/register' action='post'>");  


  14.        out.println("<table alignb='center'>");  


  15.        out.println("<tr>");  


  16.        out.println("<td>");  


  17.        out.println("username:");  


  18.        out.println("</td>");  


  19.        out.println("<td>");  

  1.        out.println("<input type='text' name='username'");  

  1.        out.println("</tr>");  

  1.        out.println("<tr>");  

  1.        out.println("<td>");  

  1.        out.println("city:");  

  1.        out.println("</td>");  

  1.        out.println("<td>");  

  1.        out.println("<select name='dept'");  

  1.        for(Integer i:key){  

  1.            out.println("<option value='"+i+"'>"+dept.get(i)+"</option>");  

  1.        }  

  1.        out.println("</select>");  

  1.        out.println("</td>");  

  1.        out.println("<tr>");  

  1.        out.println("</table>");  

  1.        out.println("</form>");  

  1.        out.println("</body>");  

  1.        out.println("</html>");  

  1.        out.flush();  

  1.    }  

  1. }  

例二:書寫一個類用於統計當Web 應用啓動後,網頁被客戶端訪問的次數。如果重新啓動Web 應用,計數器不會重新從1 開始統計訪問次數,而是從上次統計的結果上進行累加。

在實際應用中,往往需要統計自Web 應用被髮布後網頁被客戶端訪問的次數,這就要求當Web 應用被終止時,計數器的數值被永久存儲在一個文件中或者數據庫中,等到Web 應用重新啓動時,先從文件或數據庫中讀取計數器的初始值,然後在此基礎上繼續計數。

向文件中寫入或讀取計數器的數值的功能可以由自定義的 MyServletContextListener 類來完成,它具有以下功能:

1 、在 Web 應用啓動時從文件中讀取計數器的數值,並把表示計數器的 Counter 對象存放到 Web應用範圍內。存放計數器的文件的路徑爲helloapp/count/count.txt 。

2 、在Web 應用終止時把Web 應用範圍內的計數器的數值保存到count.txt 文件中。

Java代碼  收藏代碼
  1. public class MyServletContextListener implements ServletContextListener{  

  1.  public void contextInitialized(ServletContextEvent sce){  

  1.    System.out.println("helloapp application is Initialized.");  

  1.    // 獲取 ServletContext 對象  

  1.    ServletContext context=sce.getServletContext();  

  1.    try{  

  1.       // 從文件中讀取計數器的數值  

  1.       BufferedReader reader=new BufferedReader(  

  1.           new InputStreamReader(context.  

  1.           getResourceAsStream("/count/count.txt")));  

  1.       int count=Integer.parseInt(reader.readLine());  

  1.       reader.close();  

  1.       // 創建計數器對象  

  1.       Counter counter=new Counter(count);  

  1.       // 把計數器對象保存到 Web 應用範圍  

  1.       context.setAttribute("counter",counter);  

  1.       } catch(IOException e) {  

  1.          e.printStackTrace();  

  1.       }  

  1.   }  

  1.   public void contextDestroyed(ServletContextEvent sce){  

  1.       System.out.println("helloapp application is Destroyed.");  

  1.       // 獲取 ServletContext 對象  

  1.       ServletContext context=sce.getServletContext();  

  1.       // 從 Web 應用範圍獲得計數器對象  

  1.       Counter counter=(Counter)context.getAttribute("counter");  

  1.       if(counter!=null){  

  1.       try{  

  1.          // 把計數器的數值寫到 count.txt 文件中  

  1.          String filepath=context.getRealPath("/count");  

  1.          filepath=filepath+"/count.txt";  

  1.          PrintWriter pw=new PrintWriter(filepath);  

  1.          pw.println(counter.getCount());  

  1.          pw.close();  

  1.         } catch(IOException e) {  

  1.             e.printStackTrace();  

  1.         }  

  1.     }  

  1.   }  

  1. }  

將用戶自定義的 MyServletContextListener 監聽器在 Servlet 容器進行註冊, Servlet 容器會在啓動或終止 Web 應用時,會調用該監聽器的相關方法。在 web.xml 文件中, <listener> 元素用於向容器註冊監聽器:

Xml代碼  收藏代碼
  1. <listener>  

  2. <listener-class> ServletContextTest .MyServletContextListener<listener-class />  

  3. </listener>  

通過上述兩個例子,即可以非常清楚的瞭解到 ServletContextListener 接口的使用方法及技巧。

在Container 加載Web 應用程序時(例如啓動 Container 之後),會呼叫contextInitialized() ,而當容器移除Web 應用程序時,會呼叫contextDestroyed () 方法。

通過 Tomcat 控制檯的打印結果的先後順序,會發現當 Web 應用啓動時,Servlet 容器先調用contextInitialized() 方法,再調用lifeInit 的init() 方法;

當Web 應用終止時,Servlet 容器先調用lifeInit 的destroy() 方法,再調用contextDestroyed() 方法。

由此可見,在Web 應用的生命週期中,ServletContext 對象最早被創建,最晚被銷燬。

原文地址:http://blog.csdn.net/zhaozheng7758/archive/2010/12/28/6103700.aspx



發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章