Servlet规范之URL映射

待我称王封你为后i 2022-07-24 09:16 237阅读 0赞

## 映射请求到Servlet ##

|-- Context Path --|-- Servlet Path -|--Path Info--|
    http://www.myserver.com     /mywebapp        /helloServlet      /hello
                            |-------- Request URI  ----------------------------|

引导servlet服务请求的请求路径由许多重要部分组成。以下元素从请求URI路径得到，并通过request对象公开：  
\- Context Path：与ServletContext相关联的路径前缀是这个servlet的一部分。如果这个上下文是基于Web服务器的URL命名空间基础上的“默认”上下文，那么这个路径将是一个空字符串。否则，如果上下文不是基于服务器的命名空间，那么这个路径以/字符开始，但不以/字符结束。  
\- Servlet Path：路径部分直接与激活请求的映射对应。这个路径以“/”字符开头，如果请求与“/ \*”或“”模式匹配，在这种情况下，它是一个空字符串。  
\- PathInfo：请求路径的一部分，不属于Context Path或Servlet Path。如果没有额外的路径，它要么是null，要么是以’/’开头的字符串。  
使用HttpServletRequest接口中的下面方法来访问这些信息：  
\- getContextPath  
\- getServletPath  
\- getPathInfo  
重要的是要注意，除了请求URI和路径部分的URL编码差异外，下面的等式永远为真：  
**requestURI = contextPath + servletPath + pathInfo**

在web.xml中设置下述的Servlet映射规则

<table> 
 <thead> 
  <tr> 
   <th>Context Path</th> 
   <th>/catalog</th> 
   <th>Servlet</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Servlet Mapping</td> 
   <td>Pattern: /lawn/*</td> 
   <td>LawnServlet</td> 
  </tr> 
  <tr> 
   <td>Servlet Mapping</td> 
   <td>Pattern: /garden/*</td> 
   <td>GardenServlet</td> 
  </tr> 
  <tr> 
   <td>Servlet Mapping</td> 
   <td>Pattern: *.jsp</td> 
   <td>JSPServlet</td> 
  </tr> 
 </tbody> 
</table>

得到的结果为

<table> 
 <thead> 
  <tr> 
   <th>请求路径</th> 
   <th>ContextPath</th> 
   <th>ServletPath</th> 
   <th>PathInfo</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>/catalog/lawn/index.html</td> 
   <td>/catalog</td> 
   <td>/lawn</td> 
   <td>/index.html</td> 
  </tr> 
  <tr> 
   <td>/catalog/garden/implements/</td> 
   <td>/catalog</td> 
   <td>/garden</td> 
   <td>/implements/</td> 
  </tr> 
  <tr> 
   <td>/catalog/help/feedback.jsp</td> 
   <td>/catalog</td> 
   <td>/help/feedback.jsp</td> 
   <td>null</td> 
  </tr> 
 </tbody> 
</table>

### servlet容器的url-pattern映射规范 ###

在web应用部署描述符中，以下语法用于定义映射：  
\- 以‘/’字符开始、以‘/\*’后缀结尾的字符串用于**路径匹配**。  
\- 以‘\*.’开始的字符串用于**扩展名映射**。  
\- 只包含“/”字符的字符串用于**default servlet**映射。  
\- 其他字符串仅用于精确匹配。

**如果一个url-pattern设定的映射即属于路径映射，也属于扩展映射（如：`/*.action`），导致容器无法判断，那么部署将报错。**

### default Servlet（缺省Servlet）详解 ###

*  web.xml中如果某个Servlet的映射路径仅仅为一个正斜杠（/），那么这个Servlet就成为当前Web应用程序的缺省Servlet。
 *  凡是在web.xml文件中找不到匹配的`<servlet-mapping>`元素的URL，它们的访问请求都将交给缺省Servlet处理，也就是说，缺省Servlet用于处理所有其他Servlet都不处理的访问请求。
 *  如果在web.xml中未设置一个default Servlet的时候，容器会设置一个容器自带的Servlet。
    
     *  tomcat容器中会默认注册了一个名称为`org.apache.catalina.servlets.DefaultServlet`的Servlet
     *  当访问Tomcat服务器中的某个静态HTML文件和图片时，实际上是在访问这个缺省Servlet，由DefaultServlet类寻找，当寻找到了请求的html或图片时，则返回资源，如果没有寻找到则报出404错误。

### servlet容器对url的匹配过程 ###

在收到客户端请求时，web容器确定转发到哪一个Web应用。选择的Web应用必须具有最长的上下文路径匹配请求URL的开始。当映射到Servlet时，URL匹配的一部分是上下文。  
Web容器接下来必须用下面描述的路径匹配步骤找出servlet来处理请求。  
用于映射到Servlet的路径是请求对象的请求URL减去上下文和路径参数部分。下面的URL路径映射规则按顺序使用。使用第一个匹配成功的且不会进一步尝试匹配：  
\- 容器将尝试找到一个请求路径到servlet路径的**精确路径匹配**。成功匹配则选择该servlet。  
\- 容器将递归地尝试**最长路径匹配**。这是通过一次一个目录的遍历路径树完成的，使用‘/’字符作为路径分隔符。最长匹配确定选择的servlet。  
\- 如果URL最后一部分包含一个扩展名（如 .jsp），servlet容器尝试**扩展匹配**，将视图匹配为扩展名处理请求的Servlet。扩展名定义在最后一部分的最后一个‘.’字符之后。  
\- 如果前三个规则都没有产生一个servlet匹配，容器将试图为请求资源提供相关的内容。如果应用中定义了一个“default”servlet，它将被使用。许多容器提供了一种隐式的default servlet用于提供内容。  
**容器使用*区分大小写字符串*比较匹配。**

示例映射集合

<table> 
 <thead> 
  <tr> 
   <th>Path Pattern</th> 
   <th>Servlet</th> 
   <th>匹配模式</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>/foo/bar/*</td> 
   <td>servlet1</td> 
   <td>最长路径匹配</td> 
  </tr> 
  <tr> 
   <td>/baz/*</td> 
   <td>servlet2</td> 
   <td>最长路径匹配</td> 
  </tr> 
  <tr> 
   <td>/catalog</td> 
   <td>servlet3</td> 
   <td>精确路径匹配</td> 
  </tr> 
  <tr> 
   <td>*.bop</td> 
   <td>servlet4</td> 
   <td>扩展匹配</td> 
  </tr> 
 </tbody> 
</table>

注意，精确路径匹配是全字符串匹配，最长路径匹配是带正则表达式的字符串匹配。  
将产生以下结果：

<table> 
 <thead> 
  <tr> 
   <th>Incoming Path</th> 
   <th>Servlet Handling Request</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>/foo/bar/index.html</td> 
   <td>servlet1</td> 
  </tr> 
  <tr> 
   <td>/foo/bar/index.bop</td> 
   <td>servlet1</td> 
  </tr> 
  <tr> 
   <td>/baz</td> 
   <td>servlet2</td> 
  </tr> 
  <tr> 
   <td>/baz/index.html</td> 
   <td>servlet2</td> 
  </tr> 
  <tr> 
   <td>/catalog</td> 
   <td>servlet3</td> 
  </tr> 
  <tr> 
   <td>/catalog/index.html</td> 
   <td>“default” servlet</td> 
  </tr> 
  <tr> 
   <td>/catalog/racecar.bop</td> 
   <td>servlet4</td> 
  </tr> 
  <tr> 
   <td>/index.bop</td> 
   <td>servlet4</td> 
  </tr> 
 </tbody> 
</table>

注意，在/catalog/index.html和/catalog/racecar.bop的情况下，不使用映射到“/catalog”的servlet，因为不是精确匹配的。