web.xml解析

时间:2023-03-09 12:48:51
web.xml解析

常用元素及含义


<!-- standalone 定义了外部定义的 DTD 文件的存在性,有效值是 yes和 no -->
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- web-app是部署描述符的根元素,其它元素都要写在<web-app></web-app>之间 -->
<web-app xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
version="2.4"
xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"> <!-- 在开发中以上部分基本都是一样的,不需要我们过多的关注 --> <!-- 定义了web应用的名称 -->
<display-name>test-web</display-name>
<!-- 声明web应用的描述信息 -->
<description>test-web application</description> <!-- 过滤器,一个filter对应一个filter-mapping,二者的顺序不能颠倒,并且filter-name一致 -->
<filter>
<filter-name>CharacterEncodingFilter</filter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
<!-- 只针对这个filter的参数 -->
<init-param>
<param-name>encoding</param-name>
<param-value>UTF-8</param-value>
</init-param>
<init-param>
<param-name>forceEncoding</param-name>
<param-value>true</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>CharacterEncodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping> <!-- web应用整个生命周期都存在的参数名和值,类似于全局变量,参数名唯一 -->
<context-param>
<param-name>defaultHtmlEscape</param-name>
<param-value>true</param-value>
</context-param> <!-- 监听器,指出事件监听程序类 -->
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener> <!-- servlet配置,下面有详细解释 -->
<servlet>
<servlet-name>test-web</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/config.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>test-web</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping> <!-- 会话超时配置(单位为分钟),超时后服务器将次session销毁 -->
<session-config>
<session-timeout>10</session-timeout>
</session-config> <!--在返回特定HTTP状态代码时,或者特定类型的异常被抛出时,能够制定将要显示的页面-->
<error-page>
<!-- 通过异常类型显示对应内容,location可以配置路由或者页面-->
<exception-type>java.lang.Exception</exception-type>
<location>/exceptionServlet</location>
</error-page> <error-page>
<!-- 通过出错码显示对应内容 -->
<error-code>404</error-code>
<location>/notFound.jsp</location>
</error-page>
</web-app>

servlet配置详解


    <servlet>
<servlet-name>servlet名称</servlet-name>
<servlet-class>servlet类全路径(包名.类名)</servlet-class>
<init-param>
<param-name>参数</param-name>
<param-value>参数值</param-value>
</init-param>
<load-on-startup>加载优先级</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>servlet名称</servlet-name>
<url-pattern>访问路径</url-pattern>
</servlet-mapping>

其中,<load-on-startup>必须是整数;如果是小于0或者不存在,这个servlet只有被选择的时候才会被加载;如果大于等于0,容器在启动web应用时就被加载;数值越小servlet的越先被加载;值相同时,容器自行选择顺序加载。  

<context-param>和<init-param>区别


<context-param>配置在web.xml的<web-app>标签中,类似于全局变量,servlet随时都能访问它,存放在servletContext对象中(即application对象); 通过getServletContext().getInitParameter("contextParam")的方式获取。

<init-param>是针对于filter/servlet等而言的参数,用来初始化当前的Servlet的,属于当前Servlet的配置,因此存放在servletConfig对象中; 通过getServletConfig().getInitParameter("initParam")的方式获取。

元素加载过程


当我们去启动一个WEB项目时,容器包括(JBoss、Tomcat等)首先会读取项目web.xml配置文件里的配置,当这一步骤没有出错并且完成之后,项目才能正常地被启动起来。
启动WEB项目的时候,容器首先会去它的配置文件web.xml读取两个节点: <listener></listener>和<context-param></context-param>,
紧接着,容器创建一个ServletContext(application),这个WEB项目所有部分都将共享这个上下文。