webxml详解

web.xml 详解

一、web.xml 简介

在 java 工程中，web.xml 用来初始化工程配置信息，比如说 welcome 页面，filter，listener，servlet，servlet-mapping，启动加载级别等等。每一个 xml 文件都有定义格式规范的 schema 文件，web.xml 所对应的 xml Schema 文件中定义了多少种标签元素，web.xml 中就可以出现它所定义的标签元素，也就具备哪些特定的功能。web.xml 的模式文件是由 Sun 公司定义的，每个 web.xml 文件的根元素为 <web-app> 中，必须标明这个 web.xml 使用的是哪个模式文件。

web.xml 的根元素定义如下所示:

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

二、web.xml 标签介绍

下面就来介绍一下 web.xml 中常用的标签及其功能：

1. description：项目描述

2. display-name：项目名称

3. icon：web 图标

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

<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>

4. context-param：初始化参数

元素含有一对参数名和参数值，用作应用的 servlet 上下文初始化参数。参数名在整个 Web 应用中必须是惟一的。包含两个子元素 param-name 和 param-value

<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");

5. filter：过滤器

指定 Web 容器中的过滤器，请求和响应对象被 servlet 处理之前或之后，可以使用过滤器对这两个对象进行操作。包含子元素：

• init-param：与 context-param 元素具有相同的作用
• filter-name：用来定义过滤器的名称，该名称在整个应用中都必须是惟一的
• filter-class：指定过滤器类的完全限定的名称

6. filter-mapping：映射 filter

和 filter 一起使用，指定过滤器被映射到一个 servlet 或一个 URL 模式。和 filter 必须具有相同的名称。过滤是按照部署描述符的 filter-mapping 元素出现的顺序执行的。包含子元素：

• filter-name：定义 filter 名称
• url-pattern：filter 所对应的 url
• servlet-name：定义 filter 的名称
• dispatcher：定 Filter 对应的请求方式，有 RQUEST,INCLUDE,FORWAR,ERROR 四种，默认为 REQUEST

    <filter>
        <filter-name>struts2</filter-name>
        <filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>struts2</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

7. servlet：处理请求响应

用于处理及响应客户端的需求，动态生成 web 内容。

8. srvlet-mapping：映射 servlet

用来定义 servlet 所对应 URL，和 servlet 必须具有相同的名称。

<servlet>
  <servlet-name>ServletName</servlet-name>   
  <servlet-class>xxxpackage.xxxServlet</servlet-class>   <!--Servlet 的类 -->
  <init-param>                                     <!-- 初始化一个变量，可看成全局变量，可省略 -->
    <param-name> 参数名称 </param-name>              <!-- 变量名称 -->
    <param-value> 参数值 </param-value>              <!-- 变量值 -->
  </init-param>
</servlet>
<servlet-mapping>
  <servlet-name>ServletName</servlet-name>               
  <url-pattern>/aaa/xxx</url-pattern>                   <!-- 映射的 url 路径 -->
</servlet-mapping>

9. listener：监听器

可以收到事件什么时候发生以及用什么作为响应的通知

<listener>
    <listener-class>com.foo.hello</listener-class>
</listener>

10. welcome-file-list：首页

包含一个子元素 welcome-file，用来定义首页，服务器会依照设定的顺序来找首页

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

11. error-page：错误网页

将错误代码 (Error Code) 或异常 (Exception) 的种类对应到 web 应用资源路径

<error-page>
   <error-code>404</error-code> <!-- http 错误码 -->
   <location>/error404.jsp</location> <!-- 在 web 应用内的相关资源路径 -->
</error-page>
<error-page>
   <exception-type>java.lang.Exception</exception-type> <!-- 一个完整名称的 Java 异常类型 -->
   <location>/except.jsp</location>
</error-page>

参考：

https://blog.csdn.net/m751075…