web.xml详解-优快云博客

本文链接：https://blog.youkuaiyun.com/Martin_chen2/article/details/80135876

#一、web.xml文件的作用
每个javaEE工程中都有web.xml文件，那么它的作用是什么呢？它是每个web.xml工程都必须的吗？

一个web中可以没有web.xml文件，也就是说，web.xml文件并不是web工程必须的。 web.xml文件是用来初始化配置信息：比如Welcome页面、servlet、servlet-mapping、filter、listener、启动加载级别等。当你的web工程没用到这些时，你可以不用web.xml文件来配置你的Application。

每个xml文件都有定义它书写规则的Schema文件，也就是说javaEE的定义web.xml所对应的xml Schema文件中定义了多少种标签元素，web.xml中就可以出现它所定义的标签元素，也就具备哪些特定的功能。web.xml的模式文件是由Sun 公司定义的，每个web.xml文件的根元素为<web-app>中，必须标明这个web.xml使用的是哪个模式文件。如：

		<?xml version="1.0" encoding="UTF-8"?> 
		<web-app version="2.5" 
		xmlns="http://java.sun.com/xml/ns/javaee" 
		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
		xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
		http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"> 
		</web-app>

web.xml的模式文件中定义的标签并不是定死的，模式文件也是可以改变的，一般来说，随着web.mxl模式文件的版本升级，里面定义的功能会越来越复杂，标签元素的种类肯定也会越来越多，但有些不是很常用的，我们只需记住一些常用的并知道怎么配置就可以了。

#二、常用标签元素及功能
下面列出web.xml我们常用的一些标签元素及其功能：
##1. 指定欢迎页面 :

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

PS：指定了2个欢迎页面，显示时按顺序从第一个找起，如果第一个存在，就显示第一个，后面的不起作用。如果第一个不存在，就找第二个，以此类推。

访问一个网站时，默认看到的第一个页面就叫欢迎页，一般情况下是由首页来充当欢迎页的。一般情况下，我们会在web.xml中指定欢迎页。但 web.xml并不是一个Web的必要文件，没有web.xml，网站仍然是可以正常工作的。只不过网站的功能复杂起来后，web.xml的确有非常大用处，所以，默认创建的动态web工程在WEB-INF文件夹下面都有一个web.xml文件。
##2. 命名与定制URL:
我们可以为Servlet和JSP文件命名并定制URL,其中定制URL是依赖命名的，命名必须在定制URL前。下面拿serlet来举例：

为Servlet命名：

		<servlet> 
		    <servlet-name>servlet1</servlet-name> 
		    <servlet-class>org.whatisjava.TestServlet</servlet-class> 
		</servlet>

为Servlet定制URL

		<servlet-mapping> 
			<servlet-name>servlet1</servlet-name> 
		    <url-pattern>*.do</url-pattern> 
		</servlet-mapping>

##3. 定制初始化参数:
可以定制servlet、JSP、Context的初始化参数，然后可以再servlet、JSP、Context中获取这些参数值。

下面用servlet来举例：

		<servlet> 
		    <servlet-name>servlet1</servlet-name> 
		    <servlet-class>org.whatisjava.TestServlet</servlet-class> 
		    <init-param> 
		          <param-name>userName</param-name> 
		          <param-value>Daniel</param-value> 
		    </init-param> 
		    <init-param> 
		          <param-name>E-mail</param-name> 
		          <param-value>125485762@qq.com</param-value> 
		    </init-param> 
		</servlet>

经过上面的配置，在servlet中能够调用getServletConfig().getInitParameter(“param1”)获得参数名对应的值。

##4. 指定错误处理页面:
可以通过“异常类型”或“错误码”来指定错误处理页面

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

##5. 设置过滤器：
比如设置一个编码过滤器，过滤所有资源

		<filter> 
		    <filter-name>XXXCharaSetFilter</filter-name> 
		    <filter-class>net.test.CharSetFilter</filter-class> 
		</filter> 
		<filter-mapping> 
		    <filter-name>XXXCharaSetFilter</filter-name> 
		    <url-pattern>/*</url-pattern> 
		</filter-mapping>

##6. 设置监听器：

		<listener> 
			<listener-class>net.test.XXXLisenet</listener-class> 
		</listener>

##7. 设置会话(Session)过期时间:
其中时间以分钟为单位，假如设置60分钟超时：

		<session-config> 
			<session-timeout>60</session-timeout> 
		</session-config>

除了这些标签元素之外，还可以往web.xml中添加很多标签元素，由于不常用省略。
#三、web.xml配置文件常用元素及其意义预览

	  <web-app>
 
       <!--定义了WEB应用的名字-->
       <display-name></display-name>
  
       <!--声明WEB应用的描述信息-->
       <description></description>
  
       <!--context-param元素声明应用范围内的初始化参数-->
       <context-param></context-param>
 
       <!--过滤器元素将一个名字与一个实现javax.servlet.Filter接口的类相关联-->
       <filter></filter>

       <!--一旦命名了一个过滤器，就要利用filter-mapping元素把它与一个或多个servlet或JSP页面相关联-->
       <filter-mapping></filter-mapping>
 
       <!--servlet API的版本2.3增加了对事件监听程序的支持，事件监听程序在建立、修改和删除会话或servlet环境时得到通知。
          Listener元素指出事件监听程序类-->
       <listener></listener>
 
       <!--在向servlet或JSP页面制定初始化参数或定制URL时，必须首先命名servlet或JSP页面。
          Servlet元素就是用来完成此项任务的-->
       <servlet></servlet>
 
       <!--服务器一般为servlet提供一个缺省的URL：http://host/webAppPrefix/servlet/ServletName。
          但是，常常会更改这个URL，以便servlet可以访问初始化参数或更容易地处理相对URL。
          在更改缺省URL时，使用servlet-mapping元素-->
       <servlet-mapping></servlet-mapping>
 
       <!--如果某个会话在一定时间内未被访问，服务器可以抛弃它以节省内存。可通过使用HttpSession的
          setMaxInactiveInterval方法明确设置单个会话对象的超时值，或者可利用session-config元素制定缺省超时值-->
       <session-config></session-config>
 
       <!--如果Web应用具有想到特殊的文件，希望能保证给他们分配特定的MIME类型，则mime-mapping元素提供这种保证-->
       <mime-mapping></mime-mapping>
 
       <!--指示服务器在收到引用一个目录名而不是文件名的URL时，使用哪个文件-->
       <welcome-file-list></welcome-file-list>
 
       <!--在返回特定HTTP状态代码时，或者特定类型的异常被抛出时，能够制定将要显示的页面-->
       <error-page></error-page>
 
       <!--对标记库描述符文件（Tag Libraryu Descriptor file）指定别名。此功能使你能够更改TLD文件的位置，
          而不用编辑使用这些文件的JSP页面-->
       <taglib></taglib>
 
       <!--声明与资源相关的一个管理对象-->
       <resource-env-ref></resource-env-ref>
 
       <!--声明一个资源工厂使用的外部资源-->
       <resource-ref></resource-ref>
 
       <!--制定应该保护的URL。它与login-config元素联合使用-->
       <security-constraint></security-constraint>
 
       <!--指定服务器应该怎样给试图访问受保护页面的用户授权。它与sercurity-constraint元素联合使用-->
       <login-config></login-config>
 
       <!--给出安全角色的一个列表，这些角色将出现在servlet元素内的security-role-ref元素的role-name子元素中。
          分别地声明角色可使高级IDE处理安全信息更为容易-->
       <security-role></security-role>
 
       <!--声明Web应用的环境项-->
       <env-entry></env-entry>
  
       <!--声明一个EJB的主目录的引用-->
       <ejb-ref></ejb-ref>
 
       <!--声明一个EJB的本地主目录的应用-->
       <ejb-local-ref></ejb-local-ref>
 
	 </web-app>