j2ee项目开发web.xml文件加载及配置详解

一、容器启动

1、启动一个WEB项目的时候，WEB容器会去读取它的配置文件web.xml，读取<listener>和<context-param>两个结点。 

2、紧接着，容器创建一个ServletContext（servlet上下文），这个web项目的所有信息都将共享这个上下文。 

3、容器将<context-param>转换为键值对，并交给ServletContext。 

4、容器创建<listener>中的类实例，创建监听器。 

二、Load-on-startup

        Load-on-startup 元素在web应用启动的时候指定了servlet被加载的顺序，它的值必须是一个整数。如果它的值是一个负整数或是这个元素不存在，那么容器会在该servlet被调用的时候，加载这个servlet 。如果值是正整数或零，容器在配置的时候就加载并初始化这个servlet，容器必须保证值小的先被加载。如果值相等，容器可以自动选择先加载谁。  

       在servlet的配置当中，<load-on-startup>5</load-on-startup>的含义是： 

       标记容器是否在启动的时候就加载这个servlet。 

       当值为0或者大于0时，表示容器在应用启动时就加载这个servlet； 

       当是一个负数时或者没有指定时，则指示容器在该servlet被选择时才加载。 

       正数的值越小，启动该servlet的优先级越高。 

三、加载顺序

        首先可以肯定的是，加载顺序与它们在 web.xml 文件中的先后顺序无关。即不会因为 filter 写在 listener 的前面而会先加载 filter。最终得出的结论是：listener -> filter -> servlet ；

        同时还存在着这样一种配置节点：context-param，它用于向 ServletContext 提供键值对，即应用程序上下文信息。我们的 listener, filter 等在初始化时会用到这些上下文中的信息，那么 context-param 配置节是不是应该写在 listener 配置节前呢？实际上 context-param 配置节可写在任意位置，因此真正的加载顺序为：context-param -> listener -> filter -> servlet

        对于某类配置节而言，与它们出现的顺序是有关的。以 filter 为例，web.xml 中当然可以定义多个 filter，与 filter 相关的一个配置节是 filter-mapping，这里一定要注意，对于拥有相同 filter-name 的 filter 和 filter-mapping 配置节而言，filter-mapping 必须出现在 filter 之后，否则当解析到 filter-mapping 时，它所对应的 filter-name 还未定义。web 容器启动时初始化每个 filter 时，是按照 filter 配置节出现的顺序来初始化的，当请求资源匹配多个 filter-mapping 时，filter 拦截资源是按照 filter-mapping 配置节出现的顺序来依次调用 doFilter() 方法的。

        servlet 同 filter 类似，此处不再赘述。

       由此，可以看出，web.xml 的加载顺序是：context-param -> listener -> filter -> servlet ，而同个类型之间的实际程序调用的时候的顺序是根据对应的 mapping 的顺序进行调用的。

四、web.xml文件详解

web.xml详细配置，前10个是最常见的配置节点。

Repeatable="true" 表示可以有多个这样的元素，Optional="true" 表示该元素可以省略，是可选择的，以上这两个属性均为自己添加，为方便理解。

<web-app>
	<!-- 1、Web应用图标：指出IDE和GUI工具用来表示Web应用的大图标和小图标 ,没用过~-->
	<!-- icon元素包含small-icon和large-icon两个子元素.用来指定web站台中小图标和大图标的路径. -->
	<icon Optional="true">
		<small-icon>路径/app_small.gif</small-icon>
		<!--small-icon元素应指向web站台中某个小图标的路径,大小为16 X 16 pixel,但是图象文件必须为GIF或JPEG格式,扩展名必须为:.gif或.jpg. --> 
		<large-icon>路径/app_large.gif</large-icon>
		<!--large-icon元素应指向web站台中某个大图表路径,大小为32 X 32 pixel,但是图象文件必须为GIF或JPEG的格式,扩展名必须为; gif或jpg.-->
	</icon> 
	
	<!-- 2、Web 应用名称：如果使用工具编辑部署描述符，display-name元素包含的就是XML编辑器显示的名称 -->
	<display-name Optional="true">网站名称</display-name>
	<!-- 3、Web 应用描述：给出于此相关的说明性文本 -->
	<description Optional="true">网站描述</description>
	<!-- 4、上下文参数：声明应用范围内的初始化参数 ，用来设定web站台的环境参数(context),如spring的典型配置-->
	<context-param> 
    	<param-name>contextConfigLocation</param-name> 
      	<param-value> 
       	<!--加载多个spring配置文件 --> 
        /WEB-INF/applicationContext.xml, /WEB-INF/action-servlet.xml 
      	</param-value> 
   	</context-param>
	<!-- 备注：此所设定的参数,在JSP网页中可以使用下列方法来取得:${initParam.param_name}
	                           若在Servlet可以使用下列方法来获得:String param_name=getServletContext().getInitParameter("context/param"); 
  
  
	-->
	<!-- 5、监听器配置 -->
	<!-- ServletContextListener接口的实现，监听Content -->
	<!-- 监听类实现javax.servlet.ServletContextListener接口 及contextInitialized方法-->
	<listener Repeatable="true">
		<listener-class>监听类</listener-class>
	</listener>
	<listener>
      	<!-- HttpSessionListener, HttpSessionAttributeListener接口的实现，监听session -->
      	<listener-class>org.cjj.listener.SessionListener</listener-class>
   	</listener>
	<!-- 6、过滤器配置：filter-class类实现javax.servlet.Filter接口 -->
	<filter Repeatable="true">
		<!--定义Filter的名称,为filter-class别名 -->
		<filter-name>filterClassAliasDemo01</filter-name> 
		<!-- 定义Filter的类名称 -->
		<filter-class>com.cn.package.ClassDemo</filter-class> <!-- 对应的类 ，该类实现javax.servlet.Filter接口及doFilter()方法 -->
		<init-param Optional="true" Repeatable="true"> <!-- 为filter-class类初始化参数 -->
			<param-name>encoding</param-name>
			<param-value>UTF-8</param-value>
		</init-param>
	</filter>
	<!-- 用来定义Filter所对应的URL.和下面的servlet-mapping一样 -->
	<filter-mapping Repeatable="true">
		<!-- 定义Filter的名称,和上面定义的Filter名称要一致 -->
		<filter-name>filterClassAliasDemo01</filter-name> <!-- 此处指定用哪个filter便别名的类，通过该类进行过滤 -->
		<url-pattern>/urlDemo/*</url-pattern> <!-- 当发现/urlDemo/*的url时，调用指定的filter-name的类的doFilter方法。 -->
	</filter-mapping>
	
	<!-- 7、Servlet配置 -->
	<!-- 7.1、基本配置 -->
	<!-- 这里配置和上面的Filter配置一样 -->
	<servlet Repeatable="true">
		<servlet-name>snoop</servlet-name>
		<servlet-class>com.xzy.cn.SnoopServlet</servlet-class> <!-- 继承HttpServlet的类 -->
	</servlet>
	<servlet-mapping Repeatable="true"> 
      <servlet-name>snoop</servlet-name> 
      <url-pattern>/snoop</url-pattern>
      <!-- 当发现 url-pattern（/snoop） 请求时，通过servlet-name(snoop)找到对应的servlet类，并对该请求进行处理-->
    </servlet-mapping> 
	
	<!-- 7.2、高级配置 -->
	<servlet Repeatable="true">
		<display-name Optional="true"></display-name>
		<description Optional="true"></description>
		<servlet-name>HTML Action Servlet</servlet-name>
		<servlet-class>org.cjj.servlet.ActionServlet</servlet-class>
		<init-param Repeatable="true" Optional="true">
			<param-name>config</param-name>
			<param-value>/WEB-INF/struts-config.xml</param-value>
		</init-param>
		<init-param>
         	<param-name>debug</param-name>
         	<param-value>2</param-value>
      	</init-param>
      	<init-param>
         	<param-name>detail</param-name>
         	<param-value>2</param-value>
      	</init-param>
		<load-on-startup Optional="true">0</load-on-startup> 
		<!-- load-on-startup说明：当值为正数或零时：Servlet容器先加载数值小的servlet，再依次加载其他数值大的servlet. 
		当值为负或未定义：Servlet容器将在Web客户首次访问这个servlet时加载它-->
	</servlet>
	<servlet-mapping Repeatable="true">
		<servlet-name>HTML Action Servlet</servlet-name>
		<url-pattern>*.do</url-pattern>
	</servlet-mapping>
	<!--
		init-param 用来定义参数，可有多个init-param。在servlet类中通过getInitParameter(String name)方法访问初始化参数
	 -->
	<!-- 8、会话超时配置：单位为分钟  -->
	<session-config>
		<session-timeout>30</session-timeout>
	</session-config>
	<!-- 如果某个会话在一定时间内未被访问，服务器可以抛弃它以节省内存。   可通过使用HttpSession的setMaxInactiveInterval方法明确设置单个会话对象的超时值，或者可利用session-config元素制定缺省超时值。 -->
	<!-- 9、MIME类型配置：如果Web应用具有特殊的文件，希望能保证给他们分配特定的MIME类型，则mime-mapping元素提供这种保证。  -->
	<!-- mime-mapping包含两个子元素extension和mime-type.定义某一个扩展名和某一mime-type做对映. -->
	<mime-mapping Repeatable="true" Optional="true">
		<!-- 扩展名称  -->
		<extension>htm</extension>
		<!-- MIME格式  -->
		<mime-type>text/html</mime-type>
	</mime-mapping>
	<!-- 10、指定欢迎页配置-->
	<!-- 指服务器在收到引用一个目录名而不是文件名的URL时，使用哪个文件 -->
	<welcome-file-list>
		<welcome-file Repeatable="true">index.jsp</welcome-file>
	</welcome-file-list>
	<!-- 11、配置错误页面 -->
	<!-- error-page元素包含三个子元素error-code,exception-type和location.将错误代码(Error Code)或异常(Exception)的种类对应到web站台资源路径.-->
	 一、 通过错误码来配置error-page
    <error-page Repeatable="true" Optional="true"> 
    	<!-- HTTP Error code -->
    	<error-code>404</error-code>
    	<!-- 在web站点内的相关资源路径  -->
        <location>/NotFound.jsp</location> 
   	</error-page> 
  	<!-- 上面配置了当系统发生404错误时，跳转到错误处理页面NotFound.jsp。 --> 
	二、通过异常的类型配置error-page 
   	<error-page Repeatable="true" Optional="true"> 
   		<!-- 一个完整名称的Java异常类型  -->
        <exception-type>java.lang.NullException</exception-type> 
        <location>/error.jsp</location> 
   	</error-page> 
  	<!-- 上面配置了当系统发生java.lang.NullException（即空指针异常）时，跳转到错误处理页面error.jsp -->
	<!-- 12、TLD配置 -->
	<taglib Repeatable="true" Optional="true"> 
	    <taglib-uri>http://jakarta.apache.org/tomcat/debug-taglib</taglib-uri> 
	    <taglib-location>/WEB-INF/jsp/debug-taglib.tld</taglib-location> 
  	</taglib>
	<!-- 注：如果MyEclipse一直在报错,应该把<taglib> 放到 <jsp-config>中 -->
	<!-- jsp-config元素主要用来设定JSP的相关配置,<jsp:config>包括<taglib>和<jsp-property-group>两个子元素.
	              其中<taglib>元素在JSP 1.2时就已经存在了;而<jsp-property-group>是JSP 2.0新增的元素.
	--> 
	<jsp-config>
		<!-- taglib元素包含两个子元素taglib-uri和taglib-location.用来设定JSP网页用到的Tag Library路径.  -->
		<taglib Repeatable="true" Optional="true">
			<!-- 定义TLD文件的URI,JSP网页的taglib指令可以经由这个URI存取到TLD文件.  -->
			<taglib-uri>bean</taglib-uri> 
			<!-- TLD文件对应Web站台的存放位置.  -->
            <taglib-location>/WEB-INF/tld/struts-bean.tld</taglib-location>
		</taglib>
		<!-- jsp-property-group元素包含8个元素 -->
		<jsp-property-group Optional="true">
		    <!-- 此设定的说明  -->
            <description>Special property group for JSP Configuration JSP example.</description>
            <!-- 此设定的名称  -->
            <display-name>JSPConfiguration</display-name>
            <!-- 设定值所影响的范围,如:/CH2 或者/*.jsp  -->
            <uri-pattern>/*</uri-pattern>
            <!-- 若为true,表示不支持EL语法.  -->
            <el-ignored>true</el-ignored>
            <!-- 若为true表示不支持<%scription%>语法.  -->
            <scripting-invalid>false</scripting-invalid> 
            <!-- 设置JSP网页的抬头,扩展名为.jspf  -->
            <include-prelude>.jspf</include-prelude> 
            <!-- 设置JSP网页的结尾,扩展名为.jspf  -->
            <include-coda>.jspf</include-coda> 
            <!-- 编码 -->
            <page-encoding>utf-8</page-encoding>
        </jsp-property-group>
	</jsp-config>
	
	<!-- 13、资源管理对象配置 -->
	<resource-env-ref> 
        <resource-env-ref-name>jms/StockQueue</resource-env-ref-name> 
    </resource-env-ref>
	<!-- 14、资源工厂配置 -->
	<!-- esource-ref元素包括五个子元素description,res-ref-name,res-type,res-auth,res-sharing-scope.利用JNDI取得站台可  -->
	<resource-ref>
		<!-- 资源说明  -->
		<description>JNDI JDBC DataSource of JSPBook</description>
		<!-- 资源名称  -->
	    <res-ref-name>jdbc/sample_db</res-ref-name>
	    <!-- 资源种类  -->
	    <res-type>javax.sql.DataSoruce</res-type>
	    <!-- 资源由Application或Container来许可,如下面为Container  -->
	    <res-auth>Container</res-auth>
	    <!-- 资源是否可以共享.默认值为 Shareable 可选择Shareable|Unshareable -->
        <res-sharing-scope>Unshareable</res-sharing-scope> 
   	</resource-ref> 
	<!-- 配置数据库连接池就可在此配置 -->
   	<resource-ref> 
	    <description>JNDI JDBC DataSource of shop</description> 
	    <res-ref-name>jdbc/sample_db</res-ref-name> 
	    <res-type>javax.sql.DataSource</res-type> 
	    <res-auth>Container</res-auth> 
    </resource-ref> 
	<!-- 15、安全限制配置 -->
	<security-constraint>
      	<display-name>Example Security Constraint</display-name> 
    	<web-resource-collection> 
        	<web-resource-name>Protected Area</web-resource-name> 
          	<url-pattern>/jsp/security/protected/*</url-pattern> 
         	<http-method>DELETE</http-method> 
         	<http-method>GET</http-method> 
         	<http-method>POST</http-method> 
         	<http-method>PUT</http-method> 
      	</web-resource-collection> 
      	<auth-constraint> 
        	<role-name>tomcat</role-name> 
        	<role-name>role1</role-name> 
      	</auth-constraint> 
	</security-constraint> 
	<!-- 16、登陆验证配置 --> 
   	<login-config> 
    	<auth-method>FORM</auth-method> 
     	<realm-name>Example-Based Authentiation Area</realm-name> 
     	<form-login-config> 
       		<form-login-page>/jsp/security/protected/login.jsp</form-login-page> 
        	<form-error-page>/jsp/security/protected/error.jsp</form-error-page> 
     	</form-login-config> 
   	</login-config> 
	<!-- 17、安全角色：security-role元素给出安全角色的一个列表，这些角色将出现在servlet元素内的security-role-ref元素的role-name子元素中。  分别地声明角色可使高级IDE处理安全信息更为容易。  -->
  	<security-role> 
    	<role-name>tomcat</role-name> 
  	</security-role> 
	<!-- 18、Web环境参数：env-entry元素声明Web应用的环境项 --> 
  	<env-entry> 
    	<env-entry-name>minExemptions</env-entry-name> 
     	<env-entry-value>1</env-entry-value> 
     	<env-entry-type>java.lang.Integer</env-entry-type> 
  	</env-entry> 
	<!-- 19、EJB 声明 -->
	<ejb-ref>
    	<description>Example EJB reference</decription> 
     	<ejb-ref-name>ejb/Account</ejb-ref-name> 
     	<ejb-ref-type>Entity</ejb-ref-type> 
     	<home>com.mycompany.mypackage.AccountHome</home> 
     	<remote>com.mycompany.mypackage.Account</remote> 
  	</ejb-ref> 
	<!-- 20、本地EJB声明 --> 
  	<ejb-local-ref> 
     	<description>Example Loacal EJB reference</decription> 
     	<ejb-ref-name>ejb/ProcessOrder</ejb-ref-name> 
     	<ejb-ref-type>Session</ejb-ref-type> 
     	<local-home>com.mycompany.mypackage.ProcessOrderHome</local-home> 
     	<local>com.mycompany.mypackage.ProcessOrder</local> 
  	</ejb-local-ref> 
	<!-- 21、配置DWR --> 
	<servlet> 
		<servlet-name>dwr-invoker</servlet-name> 
   	  	<servlet-class>uk.ltd.getahead.dwr.DWRServlet</servlet-class> 
	</servlet> 
  	<servlet-mapping> 
    	<servlet-name>dwr-invoker</servlet-name> 
      	<url-pattern>/dwr/*</url-pattern> 
  	</servlet-mapping> 
	<!-- 22、配置Struts --> 
    <display-name>Struts Blank Application</display-name> 
    <servlet> 
        <servlet-name>action</servlet-name> 
        <servlet-class> 
            org.apache.struts.action.ActionServlet 
        </servlet-class> 
        <init-param> 
            <param-name>detail</param-name> 
            <param-value>2</param-value> 
        </init-param> 
        <init-param> 
            <param-name>debug</param-name> 
            <param-value>2</param-value> 
        </init-param> 
        <init-param> 
            <param-name>config</param-name> 
            <param-value>/WEB-INF/struts-config.xml</param-value> 
        </init-param> 
        <init-param> 
            <param-name>application</param-name> 
            <param-value>ApplicationResources</param-value> 
        </init-param> 
        <load-on-startup>2</load-on-startup> 
    </servlet> 
    <servlet-mapping> 
        <servlet-name>action</servlet-name> 
        <url-pattern>*.do</url-pattern> 
    </servlet-mapping> 
    <welcome-file-list> 
        <welcome-file>index.jsp</welcome-file> 
    </welcome-file-list> 

    <!-- Struts Tag Library Descriptors --> 
    <taglib> 
        <taglib-uri>struts-bean</taglib-uri> 
        <taglib-location>/WEB-INF/tld/struts-bean.tld</taglib-location> 
    </taglib> 
    <taglib> 
        <taglib-uri>struts-html</taglib-uri> 
        <taglib-location>/WEB-INF/tld/struts-html.tld</taglib-location> 
    </taglib> 
    <taglib> 
    <taglib-uri>struts-nested</taglib-uri> 
    <taglib-location>/WEB-INF/tld/struts-nested.tld</taglib-location> 
    </taglib> 
    <taglib> 
        <taglib-uri>struts-logic</taglib-uri> 
        <taglib-location>/WEB-INF/tld/struts-logic.tld</taglib-location> 
    </taglib> 
    <taglib> 
        <taglib-uri>struts-tiles</taglib-uri> 
        <taglib-location>/WEB-INF/tld/struts-tiles.tld</taglib-location> 
    </taglib> 
	<!-- 23、配置Spring（基本上都是在Struts中配置的） --> 
    <!-- 指定spring配置文件位置 --> 
    <context-param> 
    	<param-name>contextConfigLocation</param-name> 
      	<param-value> 
       	<!--加载多个spring配置文件 --> 
        /WEB-INF/applicationContext.xml, /WEB-INF/action-servlet.xml 
      	</param-value> 
   	</context-param> 
   <!-- 定义SPRING监听器，加载spring --> 
  	<listener> 
    	<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> 
  	</listener> 
  	<listener> 
     	<listener-class> 
       	org.springframework.web.context.request.RequestContextListener 
     	</listener-class> 
  	</listener> 
</web-app>

 

参见：http://mianhuaman.iteye.com/blog/1105522