重识web.xml

2022-01-22 00:20:28

一、重要概念

前提：

deployDemo/WEB-INF/classes/moreservlets

  • deployDemo：deployDemo目录
  • moreservlets：程序包
  • xml文件格式：
<?xml version="1.0" encoding="ISO-8859-1"?>  
<!DOCTYPE web-app   
PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"   
"http://java.sun.com/dtd/web-app_2_3.dtd">  
<web-app>  
<!-- … -->  
<servlet>  
    <servlet-name>Test</servlet-name>  
    <servlet-class>moreservlets.TestServlet</servlet-class>  
</servlet> 
<servlet-mapping>  
    <servlet-name>Test</servlet-name>  
    <url-pattern>/UrlTest</url-pattern>  
</servlet-mapping>   
<!-- … -->  
</web-app>

1、定义头和根元素

部署描述符文件就像所有XML文件一样，必须以一个XML头开始。
这个头声明可以使用的XML版本并给出文件的字符编码。

重识web.xml

DOCTYPE声明必须立即出现在此头之后(较新的版本后DOCTYPE可以省略)。这个声明告诉服务器适用的servlet规范的版本（如2.2或2.3）并指定管理此文件其余部分内容的语法的DTD(Document Type Definition，文档类型定义)。
所有部署描述符文件的顶层（根）元素为web-app。请注意，XML元素不像HTML，他们是大小写敏感的。因此，web-App和WEB-APP都是不合法的，web-app必须用小写。

2、缺省URL

大多数服务器具有一个缺省的serlvet URL：
http://host/webAppPrefix/servlet/packageName.ServletName
//缺省URL格式

3、分配名称

#Xml代码  
<servlet>    
    <servlet-name>Test</servlet-name>  
    <servlet-class>moreservlets.TestServlet</servlet-class>  
</servlet>

4、定制的URL

//注释：servlet-name需要与<servlet>中的servlet-name相同
#Xml代码  
<servlet-mapping>  
    <servlet-name>Test</servlet-name>  
    <url-pattern>/UrlTest</url-pattern>  
</servlet-mapping>

5、初始化参数

初始化参数只在通过它们的注册名或与它们注册名相关的定制URL模式访问Servlet时可以使用。

Xml代码
<servlet>  
    <servlet-name>InitTest</servlet-name>  
    <servlet-class>moreservlets.InitServlet</servlet-class>  
       <init-param>  
            <param-name>firstName</param-name>  
            <param-value>Larry</param-value>  
        </init-param>  
        <init-param>  
            <param-name>emailAddress</param-name>  
            <param-value>Ellison@Microsoft.com</param-value>  
        </init-param>  
</servlet>

获取初始化参数并使用：

Java代码
package moreservlets;   
  
import java.io.*;   
import javax.servlet.*;   
import javax.servlet.http.*;   
  
public class InitServlet extends HttpServlet {   
    private String firstName, emailAddress;   
  
    public void init() {   
        ServletConfig config = getServletConfig();   
        firstName = config.getInitParameter("firstName");   
        emailAddress = config.getInitParameter("emailAddress");   
    }   
  
    public void doGet(HttpServletRequest request,HttpServletResponse response)throws ServletException, IOException {   
        response.setContentType("text/html");   
        PrintWriter out = response.getWriter();   
        String uri = request.getRequestURI();   
        out.println(ServletUtilities.headWithTitle("Init Servlet") +"<BODY BGCOLOR=\"#FDF5E6\">\n" +"<H2>Init Parameters:</H2>\n" +"<UL>\n" +"<LI>First name: " + firstName + "\n" +"<LI>Email address: " + emailAddress + "\n" +"</UL>\n" + "</BODY></HTML>");   
    }   
}

初始化参数只在通过它们的注册名或与它们注册名相关的定制URL模式访问Servlet时可以使用。
因此，在这个例子中，firstName 和 emailAddress初始化参数将能够在使用URL http://host/webAppPrefix/servlet/InitTest 时可用（定制的URL），但在使用URL http://host/webAppPrefix/servlet/myPackage.InitServlet 时不能使用（缺省URL）。

提供应用范围内的初始化参数：
在某些情形下，希望提供可由任意servlet或JSP页面借助ServletContext的getInitParameter方法读取的系统范围内的初始化参数。
可利用context-param元素声明这些系统范围内的初始化值。context-param元素应该包含param-name、param-value以及可选的description子元素，如下所示：

Xml代码
<context-param>  
    <param-name>support-email</param-name>  
    <param-value>blackhole@mycompany.com</param-value>  
</context-param>

为了保证可移植性，web.xml内的元素必须以正确的次序声明。但这里应该注意，context-param元素必须出现任意与文档有关的元素（icon、display-name或description）之后及filter、filter-mapping、listener或 servlet元素之前。

6、服务器启动时装载servlet

假如servlet或JSP页面有一个要花很长时间执行的init （servlet）或jspInit（JSP）方法。我们可利用servlet的load-on- startup元素规定服务器在第一次启动时装载servlet。下面是一个例子。

Xml代码
<servlet>  
    <servlet-name> … </servlet-name>  
    <servlet-class> … </servlet-class> <!-- Or jsp-file -->  
<load-on-startup/>  
</servlet>

也可以为此元素体提供一个整数而不是使用一个空的load-on-startup。想法是服务器应该在装载较大数目的servlet或JSP页面之前装载较少数目的servlet或JSP页面（也就是设置加载次序）。例如，下面的servlet项将指示服务器首先装载和初始化SearchServlet，然后装载和初始化由位于Web应用的result目录中的index.jsp文件产生的 servlet。

Xml代码
<servlet>  
    <servlet-name>Search</servlet-name>  
    <servlet-class>myPackage.SearchServlet</servlet-class> <!-- Or jsp-file -->  
        <load-on-startup>1</load-on-startup>  
/servlet>  
<servlet>  
        <servlet-name>Results</servlet-name>  
        <servlet-class>/results/index.jsp</servlet-class> <!-- Or jsp-file -->  
        <load-on-startup>2</load-on-startup>  
</servlet>

7、过滤器

servlet版本2.3引入了过滤器的概念。

过滤器可截取和修改进入一个servlet或JSP页面的请求或从一个servlet或JSP页面发出的响应。

在执行一个servlet或JSP页面之前，必须执行第一个相关的过滤器的doFilter方法。在该过滤器对其FilterChain对象调用doFilter时，执行链中的下一个过滤器。如果没有其他过滤器，servlet或JSP页面被执行。

过滤器具有对到来的ServletRequest对象的全部访问权，因此，它们可以查看客户机名、查找到来的cookie等。

为了访问servlet或JSP页面的输出，过滤器可将响应对象包裹在一个替身对象（stand-in object）中，比方说把输出累加到一个缓冲区。在调用FilterChain对象的doFilter方法之后，过滤器可检查缓冲区，如有必要，就对它进行修改，然后传送到客户机。

过滤器实例：

程序清单5-11 ReportFilter.java

Java代码
package moreservlets;   
  
import java.io.*;   
import javax.servlet.*;   
import javax.servlet.http.*;   
import java.util.*;   
  
public class ReportFilter implements Filter {   
    public void doFilter(ServletRequest request,ServletResponse response,FilterChain chain)throws ServletException, IOException {   
        HttpServletRequest req = (HttpServletRequest)request;   
        System.out.println(req.getRemoteHost() +" tried to access " +req.getRequestURL() +" on " + new Date() + ".");   
        chain.doFilter(request,response);   
    }   
  
    public void init(FilterConfig config)throws ServletException {}   
  
    public void destroy() {}   
}

一旦建立了一个过滤器，可以在web.xml中利用filter元素以及filter-name（任意名称）、file-class（完全限定的类名）和（可选的）init-params子元素声明它。
请注意，元素在web.xml的web-app元素中出现的次序不是任意的；允许服务器（但不是必需的）强制所需的次序，并且实际中有些服务器也是这样做的。但这里要注意，所有filter元素必须出现在任意filter-mapping元素之前， filter-mapping元素又必须出现在所有servlet或servlet-mapping元素之前。

给定上述的ReportFilter类，可在web.xml中作出下面的filter声明。它把名称Reporter与实际的类ReportFilter（位于moreservlets程序包中）相关联。

Xml代码
<filter>  
    <filter-name>Reporter</filter-name>  
    <filter-class>moresevlets.ReportFilter</filter-class>  
</filter>

一旦命名了一个过滤器，可利用filter-mapping元素把它与一个或多个servlet或JSP页面相关联。关于此项工作有两种选择。
首先，可使用filter-name和servlet-name子元素把此过滤器与一个特定的servlet名（此servlet名必须稍后在相同的 web.xml文件中使用servlet元素声明）关联。
例如，下面的程序片断指示系统只要利用一个定制的URL访问名为SomeServletName 的servlet或JSP页面，就运行名为Reporter的过滤器。

Xml代码
<filter-mapping>  
    <filter-name>Reporter</filter-name>  
    <servlet-name>SomeServletName</servlet-name>  
</filter-mapping>

其次，可利用filter-name和url-pattern子元素将过滤器与一组servlet、JSP页面或静态内容相关联。
例如，相面的程序片段指示系统只要访问Web应用中的任意URL，就运行名为Reporter的过滤器。

Xml代码
<filter-mapping>  
    <filter-name>Reporter</filter-name>  
    <url-pattern>/*</url-pattern>  
</filter-mapping>

完整实例：

Xml代码
<?xml version="1.0" encoding="ISO-8859-1"?>  
<!DOCTYPE web-app   
PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"   
"http://java.sun.com/dtd/web-app_2_3.dtd">  
<web-app>  
    <filter>  
        <filter-name>Reporter</filter-name>  
        <filter-class>moresevlets.ReportFilter</filter-class>  
    </filter>  
    <!-- ... -->  
    <filter-mapping>  
        <filter-name>Reporter</filter-name>  
        <servlet-name>PageName</servlet-name>  
    </filter-mapping>  
<!-- ... -->  
    <servlet>  
        <servlet-name>PageName</servlet-name>  
        <jsp-file>/RealPage.jsp</jsp-file>  
    </servlet>  
<!-- ... -->  
    <servlet-mapping>  
        <servlet-name> PageName </servlet-name>  
        <url-pattern>/UrlTest2/*</url-pattern>  
        </servlet-mapping>  
<!-- ... -->  
</web-app>

8、指定欢迎页

假如用户提供了一个像http: //host/webAppPrefix/directoryName/ 这样的包含一个目录名但没有包含文件名的URL，会发生什么事情呢？

Welcome-file-list 元素及其辅助的welcome-file元素解决了这个模糊的问题。
例如，下面的web.xml项指出，如果一个URL给出一个目录名但未给出文件名，服务器应该首先试用index.jsp，然后再试用index.html。如果两者都没有找到，则结果有赖于所用的服务器（如一个目录列表）。

Xml代码
<welcome-file-list>  
    <welcome-file>index.jsp</welcome-file>  
    <welcome-file>index.html</welcome-file>  
</welcome-file-list>

原博客：
https://www.cnblogs.com/chinafine/archive/2010/09/02/1815980.html
该篇博客是本人进行学习时的一个总结记录

重识web.xml

上一篇：树莓派安装Tomcat


下一篇：3月编程语言排行及程序员工资，快看看你在哪个等级？