使用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