java web项目的web.xml详解_有web.xml的项目-优快云博客

本文详细解析了Java Web项目的web.xml配置文件，包括站点描述、环境参数、过滤器、监听器、Servlet映射、Session配置、MIME映射、欢迎文件、错误处理、JSP配置和资源引用等关键元素，适用于Spring MVC、SSH架构等不同场景的配置需求。

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

java web项目的web.xml详解

注：本文参考了网上的其它作者文章，具体是参考来源已经忘记，只是本篇文章存放在电脑很久了，现在放上来分享给大家，知识重在分享，我想有参考原作者部分，作者也会谅解。如有问题请多多指教！

1 常规配置

　　此处参照希赛博客：

　　每一个站的WEB-INF 下都有一个web.xml 的设定文件，它提供了我们站台的配置设定.

　　web.xml 定义：

Ø 站台的名称和说明。

Ø 针对环境参数(Context)做初始化工作。

Ø Servlet 的名称和映射。

Ø Session 的设定。

Ø Tag library 的对映。

Ø JSP 网页设定。

Ø Mime Type 处理。

Ø 错误处理。

Ø 利用JDNI 取得站台资源。

1.1 web.xml中的schema以及站点描述

　　要了解web.xml 的设定值，必须了解它的schema, 从web.xml 中知道它的schema 是由Sum Microsystems 公司定制的，如果你想更为详细的了解它，可以到网页，那里有更为详细的介绍。这里我介绍我们平常见得最都的.

< xml version="1.0" encoding="ISO-8859-1" >

　　<web-app xmlns:xsi=""
　 xmlns="" xmlns:web=""
　 xsi:schemaLocation=""
　 version="2.5">

　　<web-app>

这是一般在写XML 时所做的声明, 定义了XML 的版本，编码格式, 还有重要的指明schema 的来源, 为：

<description> 站台描述</discription>：对站台做出描述.
<display-name> 站台名称</display-name>：定义站台的名称

<icon>

<small-icon>/ 路径/smallicon.gif</small-icon>

<large-icon>/ 路径/largeicon-jpg</large-icon>

</icon>

<icon>：

icon元素包含small-icon 和large-icon 两个子元素. 用来指定web 站台中小图标和大图标的路径.

<small-icon>/ 路径/smallicon.gif</small-icon>
small-icon 元素应指向web 站台中某个小图标的路径, 大小为16 X 16pixel, 但是图象文件必须为GIF 或JPEG 格式, 扩展名必须为:.gif 或.jpg.

<large-icon>/ 路径/largeicon-jpg</large-icon>
large-icon 元素应指向web 站台中某个大图标路径, 大小为32 X 32pixel, 但是图象文件必须为GIF 或JPEG 的格式, 扩展名必须为; gif或jpg.

　　范例:

<display-name>Develop Example</display-name>
<description>JSP 2.0 Tech Book's Examples</description>
<icon>
　 <small-icon>/images/small.gif</small-icon>
　 <large-icon>/images/large.gir</large-icon>
</icon>

1.2 <distributable>

distributable 元素为空标签, 它的存在与否可以指定站台是否可分布式处理. 如果web.xml 中出现这个元素, 则代表站台在开发时已经被设计为能在多个JSP Container 之间分散执行.

1.3 <context-param>

1.3.1 context-param配置元素说明

context-param 元素用来设定web 站台的环境参数(context),它包含两个子元素:
param-name 和param-value.
<param-name> 参数名称</param-name>:设定Context 名称
<param-value> 值</param-value>:设定Context 名称的值
范例:

<context-param>
　 <param-name>param_name</param-name>
　 <param-value>param_value</param-value>
</context-param>

此所设定的参数, 在JSP 网页中可以使用下列方法来取得:

${initParam.param_name}

若在Servlet 可以使用下列方法来获得:

String param_name=getServletContext().getInitParamter("param_name");

1.3.2 <context-param>标签的作用

1.启动一个WEB项目的时候,容器(如:Tomcat)会去读它的配置文件web.xml.读两个节点: <listener></listener> 和<context-param></context-param>
2.紧接着,容器创建一个ServletContext(上下文),这个WEB项目所有部分都将共享这个上下文.
3.容器将<context-param></context-param>转化为键值对,并交给ServletContext.
4.容器创建<listener></listener>中的类实例,即创建监听.
5.在监听中会有contextInitialized(ServletContextEvent args)初始化方法,在这个方法中获得
ServletContext = ServletContextEvent.getServletContext();
context-param的值 = ServletContext.getInitParameter("context-param的键");
6.得到这个context-param的值之后,你就可以做一些操作了.注意,这个时候你的WEB项目还没有完全启动完成.这个动作会比所有的Servlet都要早.
换句话说,这个时候,你对<context-param>中的键值做的操作,将在你的WEB项目完全启动之前被执行.
7.举例.你可能想在项目启动之前就打开数据库.
那么这里就可以在<context-param>中设置数据库的连接方式,在监听类中初始化数据库的连接.
8.这个监听是自己写的一个类,除了初始化方法,它还有销毁方法.用于关闭应用前释放资源.比如说数据库连接的关闭.
9.... 以上资料来自<<Head First Servlet&JSP>>

1.4 <filter>

filter 元素用来声明filter 的相关设定。filter 元素除了下面介绍的的子元素之外, 还包括<servlet> 介绍过的<icon>,<display-name>
,<description>,<init-param>, 其用途一样.
<filter-name>Filter 的名称</filter-name>：定义Filter 的名称.
<filter-class>Filter 的类名称</filter-class>：定义Filter 的类名称. 例如:com.foo.hello

　　范例:

<filter>
<filter-name>setCharacterEncoding</filter-name>
<filter-class>coreservlet.javaworld.CH11.SetCharacterEncodingFilter</filter-class>
<init-param>
　　 <param-name>encoding</param-name>
　　 <param-value>GB2312</param-value>
</init-param>
</filter>

1.5 <filter-mapping>

filter-mapping元素的两个主要子元素filter-name 和url-pattern. 用来定义Filter 所对应的URL.
<filter-name>Filter 的名称</filter-name>：定义Filter 的名称.
<url-pattern>URL</url-pattern>：Filter 所对应的RUL.

例如:<url-pattern>/Filter/Hello</url-pattern>

<servlet-name>Servlet 的名称<servlet-name>：定义servlet 的名称.
<dispatcher>REQUEST|INCLUDE|FORWARD|ERROR</disaptcher>
设定Filter 对应的请求方式, 有RQUEST,INCLUDE,FORWAR,ERROR 四种, 默认为REQUEST.
</filter-mapping>
范例:

<filter-mapping>
　 <filter-name>GZIPEncoding</filter-name>
　 <url-pattern>/*</url-pattern>
</filter-mapping>

1.6 <listener>

listener元素用来定义Listener 接口, 它的主要子元素为<listener-class>
<listen-class>Listener 的类名称</listener-class>：定义Listener 的类名称. 例如:com.foo.hello
<listener>
范例:

<listener>
<listener-class>coreservlet.javaworld.CH11.ContenxtListener</listener-class>
</listener>

1.7 <servlet-mapping>

servlet-mapping 元素包含两个子元素servlet-name和url-pattern. 用来定义servlet 所对应URL.
<servlet-name>Servlet 的名称</servlet-name>：定义Servlet 的名称.
<url-pattern>Servlet URL</url-pattern>：定义Servlet 所对应的RUL.

例如:<url-pattern>/Servlet/Hello</url-pattern>

范例:

<servlet-mapping>
　 <servlet-name>LoginChecker</servlet-name>
　 <url-pattern>/LoginChecker</url-pattern>
</servlet-mapping>

1.8 <session-cofing>

session-config 包含一个子元素session-timeout.定义web 站台中的session 参数.
<session-timeout> 分钟</session-timeout>
定义这个web 站台所有session 的有效期限. 单位为分钟.
范例:

<session-config>
　 <session-timeout>20</session-timeout>
</session-config>

1.9 <mime-mapping>

mime-mapping包含两个子元素extension 和mime-type. 定义某一个扩展名和某一MIME Type 做对映.
<extension> 扩展名名称</extension>：扩展名称
<mime-type>MIME 格式</mime-type>：MIME 格式.
范例:

<mime-mapping>
　 <extension>doc</extension>
　 <mime-type>application/vnd.ms-word</mime-type>
</mime-mapping>
<mime-mapping>
　 <extension>xls</extension>
　 <mime-type>application/vnd.ms-excel</mime-type>
</mime-mapping>
<mime-mapping>
　 <extension>ppt</extesnion>
　 <mime-type>application/vnd.ms-powerpoint</mime-type>
</mime-mapping>

　　说明：<mime-mapping> 主要是用在下载的地方，如果你的web 项目没有下载这个模块,<mime-mapping> 可以不用配置的，

　　如果有下载的模块，但是没有配置，那么别人点下载的时候，会打开一个新窗口，而且多数情况下是乱码。有该配置后，就可以用迅雷，flashGet 等来下载，也可以目标另存为来下载文件，

1.10 <welcome-file-list>

welcome-file-list 包含一个子元素welcome-file.用来定义首页列单.
<welcome-file> 用来指定首页文件名称</welcome-flie>
welcome-file 用来指定首页文件名称. 我们可以用<welcome-file> 指定几个首页, 而服务器会依照设定的顺序来找首页.
范例:

<welcome-file-list>
<welcome-file>index.jsp</welcome-file>
<welcome-file>index.htm</welcome-file>
</welcome-file-list>

1.11 <error-page>

error-page 元素包含三个子元素error-code,exception-type和location. 将错误代码(Error Code) 或异常(Exception) 的种类对应到web 站台资源路径.
<error-code> 错误代码</error-code>：HTTP Error code, 例如: 404
<exception-type>Exception</exception-type>：一个完整名称的Java 异常类型
<location>/ 路径</location>：在web 站台内的相关资源路径
范例:

<error-page>
　 <error-code>404</error-code>
　 <location>/error404.jsp</location>
</error-page>
<error-page>
　 <exception-type>java.lang.Exception</exception-type>
　 <location>/except.jsp</location>
</error-page>

1.12 <jsp-config>

jsp-config 元素主要用来设定JSP 的相关配置,<jsp:config>包括<taglib> 和<jsp-property-group> 两个子元素. 其中<taglib>元素在JSP 1.2 时就已经存在了; 而<jsp-property-group>是JSP 2.0 新增的元素.

1.12.1 <taglib>

taglib 元素包含两个子元素taglib-uri 和taglib-location.用来设定JSP 网页用到的Tag Library 路径.
<taglib-uri>URI</taglib-uri>
　 taglib-uri 定义TLD 文件的URI,JSP 网页的taglib 指令可以经由这个URI 存取到TLD 文件.
<taglib-location>/WEB-INF/lib/xxx.tld</taglib-laction>：TLD 文件对应Web 站台的存放位置.
</taglib>

1.12.2 <jsp-property-group>

jsp-property-group 元素包含8 个元素, 分别为:
<description>Description</descrition>：此设定的说明

<display-name>Name</display-name>：此设定的名称

<url-pattern>URL</url-pattern>:设定值所影响的范围, 如:/CH2 或者/*.jsp

<el-ignored>true|false</el-ignored>:若为true, 表示不支持EL 语法.

<scripting-invalid>true|false</scripting-invalid>:若为true 表示不支持<%scription%>语法.

<page-encoding>encoding</page-encoding>:设定JSP 网页的编码

<include-prelude>.jspf</include-prelude>:设置JSP 网页的抬头, 扩展名为.jspf

<include-coda>.jspf</include-coda>:设置JSP 网页的结尾, 扩展名为.jspf
范例:

<jsp-config>
<taglib>
　 <taglib-uri>Taglib</taglib-uri>
　 <taglib-location>/WEB-INF/tlds/MyTaglib.tld</taglib-location>
</taglib>
<jsp-property-group>
　 <description>
　　 Special property group for JSP Configuration JSP example.
　 </description>
　 <display-name>JSPConfiguration</display-name>
　 <uri-pattern>/*</uri-pattern>
　 <el-ignored>true</el-ignored>
　 <page-encoding>GB2312</page-encoding>
　 <scripting-inivalid>true</scripting-inivalid>
　 ............
</jsp-property-group>
</jsp-config>

1.13 <resource-ref>

resource-ref 元素包括五个子元素description,res-ref-name,res-type,res-auth,res-sharing-scope. 利用JNDI 取得站台可利用资源.
<description> 说明</description>:资源说明

<rec-ref-name> 资源名称</rec-ref-name>:资源名称

<res-type> 资源种类</res-type>:资源种类

<res-auth>Application|Container</res-auth>:资源由Application或Container 来许可

<res-sharing-scope>Shareable|Unshareable</res-sharing-scope>:资源是否可以共享. 默认值为Shareable
范例:

<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>
　 <res-auth>Container</res-auth>
</resource-ref>

　　这些都是些比较常用的

2 Spring MVC + freemarker 的web.xml 的完整配置：

<web-app xmlns:xsi=""
　 xmlns="" xmlns:web=""
　 xsi:schemaLocation=""
　 version="2.5">

　　
<display-name>AAAA Web Application</display-name>

　　<context-param>
　<param-name>contextConfigLocation</param-name>
　<param-value>
　 classpath*:applicationContext-dao.xml
　 classpath*:applicationContext-datasource.xml
　 classpath:applicationContext-resources.xml
　 classpath*:applicationContext-service.xml
　 /WEB-INF/applicationContext-filter.xml
　 /WEB-INF/applicationContext-security.xml
　　　 </param-value>
</context-param>

　　<context-param>
　<param-name>webAppRootKey</param-name>　
　<param-value>AAAA_web.root</param-value>　
</context-param>　

　　<context-param>
　<param-name>log4jConfigLocation</param-name>
　<param-value>classpath:log4j.properties</param-value>
</context-param>

　　<filter>
　<filter-name>encodingFilter</filter-name>
　<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
　<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>encodingFilter</filter-name>
　<url-pattern>/*</url-pattern>
</filter-mapping>



<listener>
　<listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
</listener>

　　<listener>
　<listener-class>
　　　　　 org.springframework.web.util.IntrospectorCleanupListener</listener-class>
</listener>

　　<listener>
　<listener-class>org.springframeworntext.ContextLoaderListener</listener-class>
</listener>

　　<servlet>
　<servlet-name>dispatcher</servlet-name>
　<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
　<load-on-startup>1</load-on-startup>
</servlet>

　　<servlet-mapping>
　<servlet-name>dispatcher</servlet-name>
　<url-pattern>*.html</url-pattern>
　<url-pattern>*.shtml</url-pattern>
　<url-pattern>/track/*</url-pattern>
</servlet-mapping>

　　
<filter>
　<filter-name>springSecurityFilterChain</filter-name>
　<filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
</filter>

　　<filter-mapping>
　<filter-name>springSecurityFilterChain</filter-name>
　<url-pattern>*.shtml</url-pattern>
</filter-mapping>

　　<session-config>
　<session-timeout>30</session-timeout>
</session-config>

　　<error-page>
　<error-code>500</error-code>
　<location>/500.html</location>
</error-page>
<error-page>
　<error-code>403</error-code>
　<location>/403.html</location>
</error-page>
</web-app>

3 SSH 架构，加了spring ，加了freemarker的web.xml 配置：

< xml version="1.0" encoding="UTF-8" >
<web-app id="WebApp_ID" version="2.5"
xmlns=""
xmlns:xsi="" xsi:schemaLocation="" xmlns:web="">

<display-name> 网创运营平台</display-name>
<context-param>

<param-name>contextConfigLocation</param-name>
<param-value>classpath:applicationContext.xml</param-value>
</context-param>

<filter>
　 <filter-name>encodingFilter</filter-name>
　 <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
　 <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>encodingFilter</filter-name>
　 <url-pattern>/*</url-pattern>
</filter-mapping>

<filter>
<filter-name>hibernateFilter</filter-name>
<filter-class>org.springframework.orm.hibernate3.support.OpenSessionInViewFilter</filter-class>
<init-param>
　 <param-name>singleSession</param-name>
　 <param-value>true</param-value>
</init-param>
</filter>

<filter>
<filter-name>AuthFilter</filter-name>
<filter-class>cn.com.ecenter.system.interceptors.AuthFilter</filter-class>
</filter>
<filter>
<filter-name>osivFilter</filter-name>
<filter-class>cn.com.ecenter.system.util.OpenSessionInViewFilter</filter-class>
<init-param>
　 <param-name>singleSession</param-name>
　 <param-value>true</param-value>
</init-param>
</filter>

<filter>
<filter-name>struts2</filter-name>
<filter-class>org.apache.struts2.dispatcher.FilterDispatcher</filter-class>
<init-param>
　 <param-name>actionPackages</param-name>
　 <param-value>cn.com.ecenter.dragonclaws.action</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>hibernateFilter</filter-name>
<url-pattern>*.action</url-pattern>
</filter-mapping>
<filter-mapping>
<filter-name>hibernateFilter</filter-name>
<url-pattern>*.jsp</url-pattern>
</filter-mapping>

<filter-mapping>
<filter-name>hibernateFilter</filter-name>
<url-pattern>*.shtml</url-pattern>
</filter-mapping>

<filter-mapping>
<filter-name>AuthFilter</filter-name>
<url-pattern>*.action</url-pattern>
</filter-mapping>

<filter-mapping>
<filter-name>AuthFilter</filter-name>
<url-pattern>*.shtml</url-pattern>
</filter-mapping>

<filter-mapping>
<filter-name>AuthFilter</filter-name>
<url-pattern>/pages/*</url-pattern>
</filter-mapping>

　 <filter-mapping>
<filter-name>AuthFilter</filter-name>
<url-pattern>/views/*</url-pattern>
</filter-mapping>

<filter-mapping>
<filter-name>osivFilter</filter-name>
<url-pattern>/system/*</url-pattern>
</filter-mapping>
<filter-mapping>
<filter-name>struts2</filter-name>
<url-pattern>*.action</url-pattern>
</filter-mapping>
<filter-mapping>
<filter-name>struts2</filter-name>
<url-pattern>*.jsp</url-pattern>
</filter-mapping>


<listener>
<listener-class>org.springframeworntext.ContextLoaderListener</listener-class>
</listener>

<listener>
<listener-class>cn.com.ecenter.dragonclaws.web.WebContextListerner</listener-class>
</listener>


<servlet>
　 <servlet-name>dispatcher</servlet-name>
　 <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
　 <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
　 <servlet-name>dispatcher</servlet-name>
　 <url-pattern>*.shtml</url-pattern>
　 <url-pattern>/track/*</url-pattern>
</servlet-mapping>

<servlet>
<display-name>ElFinderServlet</display-name>
<servlet-name>ElFinderServlet</servlet-name>
<servlet-class>cn.com.ecenter.elfinder.ElFinderServlet</servlet-class>
</servlet>
　 <servlet>
<servlet-name>ShowImageServlet</servlet-name>
　 <servlet-class>cn.com.ecenter.dragonclaws.util.ShowImageServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>ElFinderServlet</servlet-name>
<url-pattern>/ElFinderServlet</url-pattern>
</servlet-mapping>
<servlet-mapping>
　 <servlet-name>ShowImageServlet</servlet-name>
　 <url-pattern>/ShowImageServlet</url-pattern>
</servlet-mapping>


　 <servlet>
　　　　 <servlet-name>DisplayChart</servlet-name>
　　　　 <servlet-class>org.jfree.chart.servlet.DisplayChart</servlet-class>
</servlet>
<servlet-mapping>
　　　　 <servlet-name>DisplayChart</servlet-name>
　　　　 <url-pattern>/DisplayChart</url-pattern>
</servlet-mapping>

<session-config>
<session-timeout>1200</session-timeout>
</session-config>

<welcome-file-list>
<welcome-file>index.jsp</welcome-file>
</welcome-file-list>
<login-config>
<auth-method>BASIC</auth-method>
</login-config>
</web-app>