ServletContextListener作用、使用详解

时间：2022-09-25 19:36:34

ServletContextListener使用详解

在Servlet API中有一个ServletContextListener接口，它能够监听ServletContext对象的生命周期，实际上就是监听Web应用的生命周期。

当Servlet容器启动或终止Web应用时，会触发ServletContextEvent事件，该事件由ServletContextListener 来处理。在 ServletContextListener 接口中定义了处理ServletContextEvent事件的两个方法。

l  contextInitialized(ServletContextEventsce)：当Servlet容器启动Web应用时调用该方法。在调用完该方法之后，容器再对Filter初始化，并且对那些在Web应用启动时就需要被初始化的Servlet进行初始化。

l  contextDestroyed(ServletContextEventsce)：当Servlet容器终止Web应用时调用该方法。在调用该方法之前，容器会先销毁所有的Servlet和Filter过滤器。

下面通过两个具体的例子来介绍ServletContextListener的用法。

例一：在服务启动时，将数据库中的数据加载进内存，并将其赋值给一个属性名，其它的Servlet就可以通过getAttribute进行属性值的访问。有如下两个步骤：

1：ServletContext对象是一个为整个web应用提供共享的内存，任何请求都可以访问里面的内容 

2：如何实现在服务启动的时候就动态的加入到里面的内容：我们需要做的有： 

1）实现servletContextListerner接口并将要共享的通过setAttribute（name,data）方法提交到内存中去 ；

2）应用项目通过getAttribute(name)将数据取到。

packageServletContextTest; 

 

importjava.sql.Connection; 

importjava.sql.PreparedStatement; 

importjava.sql.ResultSet; 

importjava.util.HashMap; 

importjava.util.Map; 

 

importjavax.servlet.ServletContext; 

importjavax.servlet.ServletContextEvent; 

importjavax.servlet.ServletContextListener; 

 

importutil.ConnectTool; 

 

publicclass ServletContextLTest implements ServletContextListener{ 

    //实现其中的销毁函数

    public void contextDestroyed(ServletContextEventsce) { 

        System.out.println("thisis last destroyeed");    

    } 

    //实现其中的初始化函数，当有事件发生时即触发

    public voidcontextInitialized(ServletContextEvent sce) { 

        ServletContextsct=sce.getServletContext(); 

        Map<Integer,String> depts=newHashMap<Integer,String>(); 

        Connection connection=null; 

        PreparedStatement pstm=null; 

        ResultSet rs=null; 

         

        try{ 

           connection=ConnectTool.getConnection(); 

            String sql="select deptNo,dnamefrom dept"; 

           pstm=connection.prepareStatement(sql); 

            rs=pstm.executeQuery(); 

            while(rs.next()){ 

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

            } 

            //将所取到的值存放到一个属性键值对中

            sct.setAttribute("dept",depts); 

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

        }catch(Exception e){ 

            e.printStackTrace(); 

        }finally{ 

            ConnectTool.releasersc(rs, pstm,connection); 

        } 

    } 

} 

在完成上述编码后，仍需在web.xml中进行如下配置，以使得该监听器可以起作用。

<listener> 

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

</listener> 

在完成上述配置后，web服务器在启动时，会直接加载该监听器，通过以下的应用程序就可以进行数据的访问。

packageServletContextTest; 

importjava.io.IOException; 

importjava.io.PrintWriter; 

importjava.util.*; 

importjavax.servlet.ServletContext; 

importjavax.servlet.ServletException; 

importjavax.servlet.http.HttpServlet; 

importjavax.servlet.http.HttpServletRequest; 

importjavax.servlet.http.HttpServletResponse; 

publicclass CreateEmployee extends HttpServlet{ 

 

    @Override 

    protected void service(HttpServletRequestrequest, HttpServletResponse response) 

            throws ServletException,IOException { 

        ServletContextsct=getServletConfig().getServletContext(); 

//从上下文环境中通过属性名获取属性值

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

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

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

        PrintWriterout=response.getWriter(); 

       out.println("<html>"); 

       out.println("<body>"); 

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

        out.println("<tablealignb='center'>"); 

       out.println("<tr>"); 

       out.println("<td>"); 

       out.println("username:"); 

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

       out.println("<td>"); 

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

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

       out.println("<tr>"); 

        out.println("<td>"); 

        out.println("city:"); 

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

       out.println("<td>"); 

        out.println("<selectname='dept'"); 

        for(Integer i:key){ 

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

        } 

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

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

       out.println("<tr>"); 

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

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

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

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

        out.flush(); 

    } 

} 

例二：书写一个类用于统计当Web应用启动后，网页被客户端访问的次数。如果重新启动Web应用，计数器不会重新从1开始统计访问次数，而是从上次统计的结果上进行累加。在实际应用中，往往需要统计自Web应用被发布后网页被客户端访问的次数，这就要求当Web应用被终止时，计数器的数值被永久存储在一个文件中或者数据库中，等到Web应用重新启动时，先从文件或数据库中读取计数器的初始值，然后在此基础上继续计数。

向文件中写入或读取计数器的数值的功能可以由自定义的 MyServletContextListener类来完成，它具有以下功能：

1、在 Web 应用启动时从文件中读取计数器的数值，并把表示计数器的 Counter对象存放到 Web 应用范围内。存放计数器的文件的路径为helloapp/count/count.txt。

2、在Web应用终止时把Web应用范围内的计数器的数值保存到count.txt文件中。

packageServletContextTest; 

importjavax.servlet.ServletContext; 

importjavax.servlet.ServletContextEvent; 

importjavax.servlet.ServletContextListener; 

publicclass MyServletContextListener implements ServletContextListener{

  public voidcontextInitialized(ServletContextEvent sce){

    System.out.println("helloappapplication is Initialized.");

    //获取ServletContext对象

    ServletContextcontext=sce.getServletContext();

    try{

       //从文件中读取计数器的数值

       BufferedReader reader=newBufferedReader(

           new InputStreamReader(context.

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

       intcount=Integer.parseInt(reader.readLine());

       reader.close();

       //创建计数器对象

       Counter counter=new Counter(count);

       //把计数器对象保存到Web应用范围

      context.setAttribute("counter",counter);

       } catch(IOException e) {

          e.printStackTrace();

       }

   }

   public voidcontextDestroyed(ServletContextEvent sce){

       System.out.println("helloappapplication is Destroyed.");

       //获取ServletContext对象

       ServletContextcontext=sce.getServletContext();

       //从Web应用范围获得计数器对象

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

       if(counter!=null){

       try{

          //把计数器的数值写到count.txt文件中

          Stringfilepath=context.getRealPath("/count");

         filepath=filepath+"/count.txt";

          PrintWriter pw=newPrintWriter(filepath);

          pw.println(counter.getCount());

          pw.close();

         } catch(IOException e) {

             e.printStackTrace();

         }

     }

   }

}

将用户自定义的MyServletContextListener监听器在Servlet容器进行注册，Servlet容器会在启动或终止Web应用时，会调用该监听器的相关方法。在web.xml文件中，<listener>元素用于向容器注册监听器：

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

通过上述两个例子，即可以非常清楚的了解到ServletContextListener接口的使用方法及技巧。在Container加载Web应用程序时（例如启动 Container之后），会呼叫contextInitialized()，而当容器移除Web应用程序时，会呼叫contextDestroyed ()方法。通过Tomcat控制台的打印结果的先后顺序，会发现当 Web 应用启动时，Servlet容器先调用contextInitialized()方法，再调用lifeInit的init()方法；当Web应用终止时，Servlet容器先调用lifeInit的destroy()方法，再调用contextDestroyed()方法。由此可见，在Web应用的生命周期中，ServletContext对象最早被创建，最晚被销毁。 



作用：

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>
标签：

相关文章