web.xml 配置详解 -优快云博客

本文链接：https://blog.youkuaiyun.com/canfly20008/article/details/83634752

本文详细解析了Web.xml文件中的加载顺序，包括context-param、listener、filter和servlet的加载顺序，以及filter和servlet内部的调用顺序，并介绍了Web.xml各元素的配置方法。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

在项目中总会遇到一些关于加载的优先级问题，近期也同样遇到过类似的，所以自己查找资料总结了下，下面有些是转载其他人的，毕竟人家写的不错，自己也就不重复造轮子了，只是略加点了自己的修饰。

首先可以肯定的是，加载顺序与它们在 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文件详解

 
   001Web.xml常用元素     

   002<web-app>     

   003<display-name></display-name>定义了WEB应用的名字     

   004<description></description> 声明WEB应用的描述信息     

   005    

   006<context-param></context-param> context-param元素声明应用范围内的初始化参数。     

   007<filter></filter> 过滤器元素将一个名字与一个实现javax.servlet.Filter接口的类相关联。     

   008<filter-mapping></filter-mapping> 一旦命名了一个过滤器，就要利用filter-mapping元素把它与一个或多个servlet或JSP页面相关联。     

   009<listener></listener>servlet API的版本2.3增加了对事件监听程序的支持，事件监听程序在建立、修改和删除会话或servlet环境时得到通知。     

   010                     Listener元素指出事件监听程序类。     

   011<servlet></servlet> 在向servlet或JSP页面制定初始化参数或定制URL时，必须首先命名servlet或JSP页面。Servlet元素就是用来完成此项任务的。     

   012<servlet-mapping></servlet-mapping> 服务器一般为servlet提供一个缺省的URL：http://host/webAppPrefix/servlet/ServletName。     

   013              但是，常常会更改这个URL，以便servlet可以访问初始化参数或更容易地处理相对URL。在更改缺省URL时，使用servlet-mapping元素。     

   014    

   015<session-config></session-config> 如果某个会话在一定时间内未被访问，服务器可以抛弃它以节省内存。     

   016          可通过使用HttpSession的setMaxInactiveInterval方法明确设置单个会话对象的超时值，或者可利用session-config元素制定缺省超时值。     

   017    

   018<mime-mapping></mime-mapping>如果Web应用具有想到特殊的文件，希望能保证给他们分配特定的MIME类型，则mime-mapping元素提供这种保证。     

   019<welcome-file-list></welcome-file-list> 指示服务器在收到引用一个目录名而不是文件名的URL时，使用哪个文件。     

   020<error-page></error-page> 在返回特定HTTP状态代码时，或者特定类型的异常被抛出时，能够制定将要显示的页面。     

   021<taglib></taglib> 对标记库描述符文件（Tag Libraryu Descriptor file）指定别名。此功能使你能够更改TLD文件的位置，     

   022                  而不用编辑使用这些文件的JSP页面。     

   023<resource-env-ref></resource-env-ref>声明与资源相关的一个管理对象。     

   024<resource-ref></resource-ref> 声明一个资源工厂使用的外部资源。     

   025<security-constraint></security-constraint> 制定应该保护的URL。它与login-config元素联合使用     

   026<login-config></login-config> 指定服务器应该怎样给试图访问受保护页面的用户授权。它与sercurity-constraint元素联合使用。     

   027<security-role></security-role>给出安全角色的一个列表，这些角色将出现在servlet元素内的security-role-ref元素     

   028                   的role-name子元素中。分别地声明角色可使高级IDE处理安全信息更为容易。     

   029<env-entry></env-entry>声明Web应用的环境项。     

   030<ejb-ref></ejb-ref>声明一个EJB的主目录的引用。     

   031< ejb-local-ref></ ejb-local-ref>声明一个EJB的本地主目录的应用。     

   032</web-app>     

   033    

   034    

   035相应元素配置     

   036    

   0371、Web应用图标：指出IDE和GUI工具用来表示Web应用的大图标和小图标     

   038<icon>     

   039<small-icon>/images/app_small.gif</small-icon>     

   040<large-icon>/images/app_large.gif</large-icon>     

   041</icon>     

   0422、Web 应用名称：提供GUI工具可能会用来标记这个特定的Web应用的一个名称     

   043<display-name>Tomcat Example</display-name>     

   0443、Web 应用描述： 给出于此相关的说明性文本     

   045<disciption>Tomcat Example servlets and JSP pages.</disciption>     

   0464、上下文参数：声明应用范围内的初始化参数。     

   047  <context-param>     

   048    <param-name>ContextParameter</para-name>     

   049    <param-value>test</param-value>     

   050    <description>It is a test parameter.</description>     

   051  </context-param>     

   052  在servlet里面可以通过getServletContext().getInitParameter("context/param")得到     

   053    

   0545、过滤器配置：将一个名字与一个实现javaxs.servlet.Filter接口的类相关联。     

   055  <filter>     

   056        <filter-name>setCharacterEncoding</filter-name>     

   057        <filter-class>com.myTest.setCharacterEncodingFilter</filter-class>     

   058        <init-param>     

   059            <param-name>encoding</param-name>     

   060            <param-value>GB2312</param-value>     

   061        </init-param>     

   062  </filter>     

   063  <filter-mapping>     

   064        <filter-name>setCharacterEncoding</filter-name>     

   065        <url-pattern>/*</url-pattern>     

   066  </filter-mapping>     

   0676、监听器配置     

   068  <listener>     

   069      <listerner-class>listener.SessionListener</listener-class>     

   070  </listener>     

   0717、Servlet配置     

   072   基本配置     

   073   <servlet>     

   074      <servlet-name>snoop</servlet-name>     

   075      <servlet-class>SnoopServlet</servlet-class>     

   076   </servlet>     

   077   <servlet-mapping>     

   078      <servlet-name>snoop</servlet-name>     

   079      <url-pattern>/snoop</url-pattern>     

   080   </servlet-mapping>     

   081   高级配置     

   082   <servlet>     

   083      <servlet-name>snoop</servlet-name>     

   084      <servlet-class>SnoopServlet</servlet-class>     

   085      <init-param>     

   086         <param-name>foo</param-name>     

   087         <param-value>bar</param-value>     

   088      </init-param>     

   089      <run-as>     

   090         <description>Security role for anonymous access</description>     

   091         <role-name>tomcat</role-name>     

   092      </run-as>     

   093   </servlet>     

   094   <servlet-mapping>     

   095      <servlet-name>snoop</servlet-name>     

   096      <url-pattern>/snoop</url-pattern>     

   097   </servlet-mapping>     

   098   元素说明     

   099     <servlet></servlet> 用来声明一个servlet的数据，主要有以下子元素：     

   100     <servlet-name></servlet-name> 指定servlet的名称     

   101     <servlet-class></servlet-class> 指定servlet的类名称     

   102     <jsp-file></jsp-file> 指定web站台中的某个JSP网页的完整路径     

   103     <init-param></init-param> 用来定义参数，可有多个init-param。在servlet类中通过getInitParamenter(String name)方法访问初始化参数     

   104     <load-on-startup></load-on-startup>指定当Web应用启动时，装载Servlet的次序。     

   105                                 当值为正数或零时：Servlet容器先加载数值小的servlet，再依次加载其他数值大的servlet.     

   106                                 当值为负或未定义：Servlet容器将在Web客户首次访问这个servlet时加载它     

   107     <servlet-mapping></servlet-mapping> 用来定义servlet所对应的URL，包含两个子元素     

   108       <servlet-name></servlet-name> 指定servlet的名称     

   109       <url-pattern></url-pattern> 指定servlet所对应的URL     

   1108、会话超时配置（单位为分钟）     

   111   <session-config>     

   112      <session-timeout>120</session-timeout>     

   113   </session-config>     

   1149、MIME类型配置     

   115   <mime-mapping>     

   116      <extension>htm</extension>     

   117      <mime-type>text/html</mime-type>     

   118   </mime-mapping>     

   11910、指定欢迎文件页配置     

   120   <welcome-file-list>     

   121      <welcome-file>index.jsp</welcome-file>     

   122      <welcome-file>index.html</welcome-file>     

   123      <welcome-file>index.htm</welcome-file>     

   124   </welcome-file-list>     

   12511、配置错误页面     

   126  一、 通过错误码来配置error-page     

   127   <error-page>     

   128      <error-code>404</error-code>     

   129      <location>/NotFound.jsp</location>     

   130   </error-page>     

   131  上面配置了当系统发生404错误时，跳转到错误处理页面NotFound.jsp。     

   132二、通过异常的类型配置error-page     

   133   <error-page>     

   134       <exception-type>java.lang.NullException</exception-type>     

   135       <location>/error.jsp</location>     

   136   </error-page>     

   137  上面配置了当系统发生java.lang.NullException（即空指针异常）时，跳转到错误处理页面error.jsp     

   13812、TLD配置     

   139   <taglib>     

   140       <taglib-uri>http://jakarta.apache.org/tomcat/debug-taglib</taglib-uri>     

   141       <taglib-location>/WEB-INF/jsp/debug-taglib.tld</taglib-location>     

   142   </taglib>     

   143   如果MyEclipse一直在报错,应该把<taglib> 放到 <jsp-config>中     

   144   <jsp-config>     

   145      <taglib>     

   146          <taglib-uri>http://jakarta.apache.org/tomcat/debug-taglib</taglib-uri>     

   147          <taglib-location>/WEB-INF/pager-taglib.tld</taglib-location>     

   148      </taglib>     

   149   </jsp-config>     

   15013、资源管理对象配置     

   151   <resource-env-ref>     

   152       <resource-env-ref-name>jms/StockQueue</resource-env-ref-name>     

   153   </resource-env-ref>     

   15414、资源工厂配置     

   155   <resource-ref>     

   156       <res-ref-name>mail/Session</res-ref-name>     

   157       <res-type>javax.mail.Session</res-type>     

   158       <res-auth>Container</res-auth>     

   159   </resource-ref>     

   160   配置数据库连接池就可在此配置：     

   161   <resource-ref>     

   162       <description>JNDI JDBC DataSource of shop</description>     

   163       <res-ref-name>jdbc/sample_db</res-ref-name>     

   164