小记javaWeb的web.xml

1. 概念

web.xml文件是servlet规定的启动配置文件，目前主流的javaWeb容器都是基于servlet的，所以理解web.xml文件是必须的必。 web.xml完整的名字叫部署描述文件，当容器启动的时候就会去读取改文件，然后加载相关配置。该文件通常在 /WEB_INF 文件夹下。

tomcat或者jetty在读取web.xml文件时候，会读取<listener>和<context-param>两个节点，然后紧接着创建一个ServletContext(servlet上下文)，这个web项目共享这个上下文。容器创建<listener>中的类实例，创建监听器。

context-param -> listener -> filter -> servlet

2. 标签详解

web.xml文件主要有三部分：xml头，DOCTYPE申明和<web-app>包。

<?xml version="1.0" encoding="UTF-8"?>  
<!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>  
</web-app>

可写成：

<?xml version="1.0" encoding="UTF-8"?>
<web-app 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"
         version="2.5">
</web-app>

这里的xmlns是XHTML namespace的缩写。由于xml允许你自己定义自己的标识，你定义的标识和其他人定义的标识有可能相同，但表示不同的意义。当文件交换或者共享的时候就容易产生错误。为了避免这种错误发生，XML采用名字空间声明，允许你通过一个网址指向来识别你的标识。比方说上面的命名空间就是：http://java.sun.com/xml/ns/javaee.

2.1 icon

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

<icon>
    <small-icon>/images/app_small.gif</small-icon>
    <large-icon>/images/app_large.gif</large-icon>
</icon>

2.2 display-name

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

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

2.3 context-param

声明应用范围内的初始化参数。它用于向 ServletContext提供键值对，即应用程序上下文信息:

<context-param>
    <param-name>ContextParameter</para-name>
    <param-value>test</param-value>
    <description>It is a test parameter.</description>
</context-param>

2.4 context-param

将一个名字与一个实现javaxs.servlet.Filter接口的类相关联:

<filter>
    <filter-name>setCharacterEncoding</filter-name>
    <filter-class>com.myTest.setCharacterEncodingFilter</filter-class>
    <init-param>
        <param-name>encoding</param-name>
        <param-value>UTF-8</param-value>
    </init-param>
</filter>

2.5 listener 监听器

listener元素用来定义Listener接口,它的主要子元素为<listener-class>
<listen-class>Listener的类名称</listener-class>
定义Listener的类名称:

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

2.6 servlet

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

<servlet-name></servlet-name> 指定servlet的名称
<servlet-class></servlet-class> 指定servlet的类名称
<jsp-file></jsp-file> 指定web站台中的某个JSP网页的完整路径
<init-param></init-param> 用来定义参数，可有多个init-param。在servlet类中通过getInitParamenter(String name)方法访问初始化参数
<load-on-startup></load-on-startup>指定当Web应用启动时，装载Servlet的次序。当值为正数或零时：Servlet容器先加载数值小的servlet，再依次加载其他数值大的servlet。当值为负或未定义：Servlet容器将在Web客户首次访问这个servlet时加载它。
<servlet-mapping></servlet-mapping> 用来定义servlet所对应的URL，包含两个子元素
<servlet-name></servlet-name> 指定servlet的名称
<url-pattern></url-pattern> 指定servlet所对应的URL:

<!-- 基本配置 -->
<servlet>
    <servlet-name>snoop</servlet-name>
    <servlet-class>SnoopServlet</servlet-class>
</servlet>
<servlet-mapping>
    <servlet-name>snoop</servlet-name>
    <url-pattern>/snoop</url-pattern>
</servlet-mapping>
<!-- 高级配置 -->
<servlet>
    <servlet-name>snoop</servlet-name>
    <servlet-class>SnoopServlet</servlet-class>
    <init-param>
        <param-name>foo</param-name>
        <param-value>bar</param-value>
    </init-param>
    <run-as>
        <description>Security role for anonymous access</description>
        <role-name>tomcat</role-name>
    </run-as>
</servlet>
<servlet-mapping>
    <servlet-name>snoop</servlet-name>
    <url-pattern>/snoop</url-pattern>
</servlet-mapping>

3. Mapping规则

当一个请求到达servlet容器时，容器先将请求的url减除当前上下文的路径作为servlet的映射url，比如我访问的是http://localhost/AAA/bbb.html，我的应用上下文是AAA，容器会将http://localhost/AAA去掉，剩下的/bbb.html部分拿来做servlet的映射匹配。这个映射匹配过程是有顺序的，而且当有一个servlet匹配成功以后，就不会去理会剩下的servlet了。

其匹配规则和顺序如下:

1. 精确路径匹配。例子：比如servletA 的url-pattern为 /AAA，servletB的url-pattern为 /* ，这个时候，如果我访问的url为http://localhost/AAA ，这个时候容器就会先 进行精确路径匹配，发现/AAA正好被servletA精确匹配，那么就去调用servletA，也不会去理会其他的servlet了。

2. 最长路径匹配。例子：servletA的url-pattern为/AAA/，而servletB的url-pattern为/AAA/a/，此时访问http://localhost/AAA/a时，容器会选择路径最长的servlet来匹配，也就是这里的servletB。

3. 扩展匹配，如果url最后一段包含扩展，容器将会根据扩展选择合适的servlet。例子：servletA的url-pattern：*.action

   以”/’开头和以”/”结尾的是用来做路径映射的。以前缀”.”开头的是用来做扩展映射的。所以，为什么定义”/*.action”这样一个看起来很正常的匹配会错？因为这个匹配即属于路径映射，也属于扩展映射，导致容器无法判断。

3.散记录：

springMVC接收前端参数的方式：

1. 使用HttpServletRequest方式获取，这种方法最为原始的一种方式，但这种方式有个弊端：参数比较多的时候，取参数的代码非常冗长。

public String login(HttpServletRequest request){  
    String name = request.getParameter("name")  
    String pass = request.getParameter("pass")  
    String author = request.getParameter("author")  
      ... ...
} 

2. 使用@RequestParam注解，同样面临一个问题就是取参数不方便
3. springMVC支持将前端提交的表单自动映射到一个具体的类上。假设前端表单：

<form action="******" method="post">  
    id:<input type="text" name="id">  
    name:<input type="text" name="name">  
    age:<input type="text" name="age">  
    province:<input type="text" name="address.province">  
    city:<input type="city" name="address.city">  
    <input type="submit" value="submit">  
</form>  

定义Student类和Address类，springMVC会帮我们自定完成参数填充。

public class Student { 

    private String id;  
    private String name;  
    private String age;  
    private Address address;  
      
    public String getId() {  
        return id;  
    }  
    public void setId(String id) {  
        this.id = id;  
    }  
    public String getName() {  
        return name;  
    }  
    public void setName(String name) {  
        this.name = name;  
    }  
    public String getAge() {  
        return age;  
    }  
    public void setAge(String age) {  
        this.age = age;  
    }  
    public Address getAddress() {  
        return address;  
    }  
    public void setAddress(Address address) {  
        this.address = address;  
    }  
    @Override  
    public String toString() {  
        return "Student [id=" + id + ", name=" + name + ", age=" + age  
                + ", address=" + address + "]";  
    } 
}  

public class Address {  
  
    private String province;  
    private String city;  
    public String getProvince() {  
        return province;  
    }  
    public void setProvince(String province) {  
        this.province = province;  
    }  
    public String getCity() {  
        return city;  
    }  
    public void setCity(String city) {  
        this.city = city;  
    }  
    @Override  
    public String toString() {  
        return "Address [province=" + province + ", city=" + city + "]";  
    }  
}