web.xml中的contextConfigLocation

这几天在看spring的源码，涉及到spring启动位置的部分，下面就看看spring到底是从哪儿开始加载的。本文使用的是spring3.0M3 

首先spring的加载会借助一个监听器ContextLoaderListener，直接上web.xml文件 

<listener>
    <listener-class>org.springframework.web.context.ContextLoaderListenerlistener-class>
listener>

我们通常会对加载位置统一管理   

<context-param>
       <param-name>contextConfigLocationparam-name>
       <param-value>
        /WEB-INF/conf/spring/**/*.xml
       param-value>
   context-param>

这个org.springframework.web.context.ContextLoaderListener类型是springframework中的原始加载上下文的监听器， 
通常我们会自定义一个Listener去继承ContextLoaderListener并另外实现我们需要初始化的接口(通常我们会选择实现一些接口来对session的管理) 

public class FrameServletContextListener extends ContextLoaderListener implements ServletContextListener,HttpSessionAttributeListener,HttpSessionListener {
    //
    private ServletContext initPath(ServletContextEvent event) {

    }

        public synchronized void contextDestroyed(ServletContextEvent event) {
    //
    }

    ...
}

当监听器设置好了之后 ，启动web容器 监听器开始启动ContextLoaderListenerl 
类中的方法contextInitialized() 

/**
 * Initialize the root web application context.
 */
public void contextInitialized(ServletContextEvent event) {
    this.contextLoader = createContextLoader();
    if (this.contextLoader == null) {
        this.contextLoader = this;
    }
    this.contextLoader.initWebApplicationContext(event.getServletContext());
}

这样this.contextLoader.initWebApplicationContext(event.getServletContext());ContextLoaderListener 
就会借助容器的上下文去初始一个spring的应用上下文，使用到了ContextLoader这个类 



在ContextLoader初始化时我们看到这样一块static代码 

static {
    // Load default strategy implementations from properties file.
    // This is currently strictly internal and not meant to be customized
    // by application developers.
    try {
        //这一句会去加载同在此包下的一个properties文件的值（ContextLoader.properties）
        ClassPathResource resource = new ClassPathResource(DEFAULT_STRATEGIES_PATH, ContextLoader.class);
        defaultStrategies = PropertiesLoaderUtils.loadProperties(resource);
    }
    catch (IOException ex) {
        throw new IllegalStateException("Could not load 'ContextLoader.properties': " + ex.getMessage());
    }
}

属性文件中这样定义 

引用

org.springframework.web.context.WebApplicationContext=org.springframework.web.context.support.XmlWebApplicationContext

这样我们就能根据属性文件中的定义反射出一个XmlWebApplicationContext上下文了 

然而我们在XmlWebApplicationContext中看到如下变量 

/** Default config location for the root context */
public static final String DEFAULT_CONFIG_LOCATION = "/WEB-INF/applicationContext.xml";

至此我们已经知道默认加载spring文件的启动位置了 


当我们再看ContextLoader类，我们就会看到传说中的参数contextConfigLocation 

public static final String CONFIG_LOCATION_PARAM = "contextConfigLocation";

而XmlWebApplicationContext对象正是调用了这个参数去设置启动位置 

wac.setConfigLocation(servletContext.getInitParameter(CONFIG_LOCATION_PARAM));

再往上看XmlWebApplicationContext继承的AbstractRefreshableConfigApplicationContext类中的setConfigLocation方法将此抽象类中的String[] configLocations值填充 

并在AbstractRefreshableConfigApplicationContext类中我们看到spring对默认启动文件位置和配置启动文件位置的支持 

protected String[] getConfigLocations() {
    return (this.configLocations != null ? this.configLocations : getDefaultConfigLocations());

} 

至此我们已经清楚spring将从哪儿加载并知道加载哪些文件了。

一个web项目web.xml的配置中配置作用

的作用:
web.xml的配置中配置作用
1. 启动一个WEB项目的时候,容器(如:Tomcat)会去读它的配置文件web.xml.读两个节点: 和

2.紧接着,容器创建一个ServletContext(上下文),这个WEB项目所有部分都将共享这个上下文.

3.容器将转化为键值对,并交给ServletContext.

4.容器创建中的类实例,即创建监听.

5.在监听中会有contextInitialized(ServletContextEvent args)初始化方法,在这个方法中获得ServletContext = ServletContextEvent.getServletContext();
context-param的值 = ServletContext.getInitParameter("context-param的键");

6.得到这个context-param的值之后,你就可以做一些操作了.注意,这个时候你的WEB项目还没有完全启动完成.这个动作会比所有的Servlet都要早.
换句话说,这个时候,你对中的键值做的操作,将在你的WEB项目完全启动之前被执行.

7.举例.你可能想在项目启动之前就打开数据库.
那么这里就可以在中设置数据库的连接方式,在监听类中初始化数据库的连接.

8.这个监听是自己写的一个类,除了初始化方法,它还有销毁方法.用于关闭应用前释放资源.比如说数据库连接的关闭.

如:


    contextConfigLocation
    /WEB-INF/applicationContext.xml,/WEB-INF/action-servlet.xml,/WEB-

INF/jason-servlet.xml


    org.springframework.web.context.ContextLoaderListener

又如: --->自定义context-param,且自定义listener来获取这些信息

    urlrewrite
    false


    cluster
    false


    servletmapping
    *.bbscs


    poststoragemode
    1


    com.laoer.bbscs.web.servlet.SysListener

public class SysListener  extends HttpServlet implements ServletContextListener {

private static final Log logger = LogFactory.getLog(SysListener.class);

public void  contextDestroyed(ServletContextEvent sce) {

    //用于在容器关闭时,操作
}

//用于在容器开启时,操作

public void  contextInitialized(ServletContextEvent sce) {
   String rootpath = sce.getServletContext().getRealPath("/");
   System.out.println("-------------rootPath:"+rootpath);

   if (rootpath != null) {
    rootpath = rootpath.replaceAll(" \\\\", "/");
   } else {
    rootpath = "/";
   }
   if (!rootpath.endsWith("/")) {
    rootpath = rootpath + "/";
   }
   Constant.ROOTPATH = rootpath;
   logger.info("Application Run Path:" + rootpath);
   String urlrewrtie =  sce.getServletContext().getInitParameter("urlrewrite");
   boolean burlrewrtie = false;
   if (urlrewrtie != null) {
    burlrewrtie = Boolean.parseBoolean(urlrewrtie);
   }
   Constant.USE_URL_REWRITE = burlrewrtie;
   logger.info("Use Urlrewrite:" + burlrewrtie);
   其它略之....

   }

}
   /*最终输出
   -------------rootPath:D:\tomcat_bbs\webapps\BBSCS_8_0_3\
   2009-06-09 21:51:46,526 [com.laoer.bbscs.web.servlet.SysListener]-[INFO]

Application Run Path:D:/tomcat_bbs/webapps/BBSCS_8_0_3/
   2009-06-09 21:51:46,526 [com.laoer.bbscs.web.servlet.SysListener]-[INFO]

Use Urlrewrite:true
   2009-06-09 21:51:46,526 [com.laoer.bbscs.web.servlet.SysListener]-[INFO]

Use Cluster:false
   2009-06-09 21:51:46,526 [com.laoer.bbscs.web.servlet.SysListener]-[INFO]

SERVLET MAPPING:*.bbscs
   2009-06-09 21:51:46,573 [com.laoer.bbscs.web.servlet.SysListener]-[INFO]

Post Storage Mode:1
   */

context-param和init-param区别
web.xml里面可以定义两种参数：
(1)application范围内的参数，存放在servletcontext中，在web.xml中配置如下：

           context/param
           avalible during application

(2)servlet范围内的参数，只能在servlet的init()方法中取得，在web.xml中配置如下：

    MainServlet
    com.wes.controller.MainServlet
   
       param1
       avalible in servlet init()
   
    0

在servlet中可以通过代码分别取用：
package com.wes.controller;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;

public class MainServlet extends HttpServlet ...{

    public MainServlet() ...{
        super();
     }
    public void init() throws ServletException ...{
         System.out.println("下面的两个参数param1是在servlet中存放的");
         System.out.println(this.getInitParameter("param1"));
         System.out.println("下面的参数是存放在servletcontext中的");
        System.out.println(getServletContext().getInitParameter("context/param"));
      }
}

第一种参数在servlet里面可以通过getServletContext().getInitParameter("context/param")得到
第二种参数只能在servlet的init()方法中通过this.getInitParameter("param1")取得.