關於web.xml配置中<url-pattern>的路徑匹配問題

本文簡單描述一下Web.xml中url模式匹配問題。

web.xml中url模式匹配規則

 首先需要明確幾容易混淆的規則:

  1. servlet容器中的匹配規則既不是簡單的通配,也不是正則表達式,而是特定的規則。所以不要用通配符或者正則表達式的匹配規則來看待servlet的url-pattern。
  2. Servlet 2.5開始,一個servlet可以使用多個url-pattern規則,<servlet-mapping>標籤聲明瞭與該servlet相應的匹配規則,每個<url-pattern>標籤代表1個匹配規則;/<url-pattern>/<servlet-mapping>
  3. 當servlet容器接收到瀏覽器發起的一個url請求後,容器會用url減去當前應用的上下文路徑,以剩餘的字符串作為servlet映射,假如url是http://localhost:8080/appDemo/index.html,其應用上下文是appDemo,容器會將http://localhost:8080/appDemo去掉,用剩下的/index.html部分拿來做servlet的映射匹配
  4. url-pattern映射匹配過程是有優先順序的
  5. 而且當有一個servlet匹配成功以後,就不會去理會剩下的servlet了。

一、4種匹配規則

1 精確匹配

  <url-pattern>中配置的項必須與url完全精確匹配。/<url-pattern>

<servlet-mapping>
<servlet-name>MyServlet/<servlet-name>
<url-pattern>/user/users.html/<url-pattern>
<url-pattern>/index.html/<url-pattern>
<url-pattern>/user/addUser.action/<url-pattern>
/<servlet-mapping>

  當在瀏覽器中輸入如下幾種url時,都會被匹配到該servlet
  http://localhost:8080/webDemo/user/users.html
  http://localhost:8080/webDemo/index.html
  http://localhost:8080/webDemo/user/addUser.action

  

  注意:

  http://localhost:8080/webDemo/user/addUser/ 是非法的url,不會被當作http://localhost:8080/appDemo/user/addUser識別

  另外上述url後面可以跟任意的查詢條件,都會被匹配,如

  http://localhost:8080/webDemo/user/addUser?username=Tom&age=23 會被匹配到MyServlet。

2 路徑匹配

  以“/”字符開頭,並以“/*”結尾的字符串用於路徑匹配

  

<servlet-mapping>
<servlet-name>MyServlet/<servlet-name>
<url-pattern>/user/*/<url-pattern>
/<servlet-mapping>

  路徑以/user/開始,後面的路徑可以任意。比如下面的url都會被匹配。


  http://localhost:8080/webDemo/user/users.html
  http://localhost:8080/webDemo/user/addUser.action
  http://localhost:8080/webDemo/user/updateUser.actionl

3 擴展名匹配

  以“*.”開頭的字符串被用於擴展名匹配

<servlet-mapping>
<servlet-name>MyServlet/<servlet-name>
<url-pattern>*.jsp/<url-pattern>
<url-pattern>*.action/<url-pattern>
/<servlet-mapping>

  則任何擴展名為jsp或action的url請求都會匹配,比如下面的url都會被匹配
  http://localhost:8080/webDemo/user/users.jsp
  http://localhost:8080/webDemo/toHome.action

4 缺省匹配

  

<servlet-mapping>
<servlet-name>MyServlet/<servlet-name>
<url-pattern>//<url-pattern>
/<servlet-mapping>

二、匹配順序

  1. 精確匹配,servlet-mapping1:<url-pattern>/user/users.html/<url-pattern>,servlet-mapping2:<url-pattern>/*/<url-pattern>。當一個請求http://localhost:8080/appDemo/user/users.html來的時候,servlet-mapping1匹配到,不再用servlet-mapping2匹配
  2. 路徑匹配,先最長路徑匹配,再最短路徑匹配servlet-mapping1:<url-pattern>/user/*/<url-pattern>,servlet-mapping2:<url-pattern>/*/<url-pattern>。當一個請求http://localhost:8080/appDemo/user/users.html來的時候,servlet-mapping1匹配到,不再用servlet-mapping2匹配
  3. 擴展名匹配,servlet-mapping1:<url-pattern>/user/*/<url-pattern>,servlet-mapping2:<url-pattern>*.action/<url-pattern>。當一個請求http://localhost:8080/appDemo/user/addUser.action來的時候,servlet-mapping1匹配到,不再用servlet-mapping2匹配
  4. 缺省匹配,以上都找不到servlet,就用默認的servlet,配置為<url-pattern>//<url-pattern>

三、需要注意的問題

1 路徑匹配和擴展名匹配無法同時設置

  匹配方法只有三種,要麼是路徑匹配(以“/”字符開頭,並以“/*”結尾),要麼是擴展名匹配(以“*.”開頭),要麼是精確匹配,三種匹配方法不能進行組合,不要想當然使用通配符或正則規則。

  如<url-pattern>/user/*.action/<url-pattern>是非法的

  另外注意:<url-pattern>/aa/*/bb/<url-pattern>是精確匹配,合法,這裡的*不是通配的含義

2 "/*"和"/"含義並不相同

  • “/*”屬於路徑匹配,並且可以匹配所有request,由於路徑匹配的優先級僅次於精確匹配,所以“/*”會覆蓋所有的擴展名匹配,很多404錯誤均由此引起,所以這是一種特別惡劣的匹配模式,一般只用於filter的url-pattern
  • “/”是servlet中特殊的匹配模式,切該模式有且僅有一個實例,優先級最低,不會覆蓋其他任何url-pattern,只是會替換servlet容器的內建default servlet ,該模式同樣會匹配所有request。
  • 配置“/”後,一種可能的現象是myServlet會攔截諸如http://localhost:8080/appDemo/user/addUser.action、http://localhost:8080/appDemo/user/updateUser的格式的請求,但是並不會攔截http://localhost:8080/appDemo/user/users.jsp、http://localhost:8080/appDemo/index.jsp,這是應為servlet容器有內置的“*.jsp”匹配器,而擴展名匹配的優先級高於缺省匹配,所以才會有上述現象。

  Tomcat在%CATALINA_HOME%\\conf\\web.xml文件中配置了默認的Servlet,配置代碼如下

  

<servlet>
<servlet-name>default/<servlet-name>
<servlet-class>org.apache.catalina.servlets.DefaultServlet/<servlet-class>
<init-param>
<param-name>debug/<param-name>
<param-value>0/<param-value>
/<init-param>
<init-param>
<param-name>listings/<param-name>
<param-value>false/<param-value>
/<init-param>
<load-on-startup>1/<load-on-startup>
/<servlet>
<servlet>
<servlet-name>jsp/<servlet-name>
<servlet-class>org.apache.jasper.servlet.JspServlet/<servlet-class>
<init-param>
<param-name>fork/<param-name>
<param-value>false/<param-value>
/<init-param>
<init-param>
<param-name>xpoweredBy/<param-name>
<param-value>false/<param-value>
/<init-param>
<load-on-startup>3/<load-on-startup>

/<servlet>
<servlet-mapping>
<servlet-name>default/<servlet-name>
<url-pattern>//<url-pattern>
/<servlet-mapping>


<servlet-mapping>
<servlet-name>jsp/<servlet-name>
<url-pattern>*.jsp/<url-pattern>
<url-pattern>*.jspx/<url-pattern>
/<servlet-mapping>
  • 可以閱讀http://stackoverflow.com/questions/4140448/difference-between-and-in-servlet-mapping-url-pattern
  • “/*”和“/”均會攔截靜態資源的加載,需要特別注意

四、舉例

關於web.xml配置中<url-pattern>的路徑匹配問題

路徑映射示例

而實際請求映射的結果:

關於web.xml配置中<url-pattern>的路徑匹配問題

映射路徑關係

以上,記錄以備查。


分享到:


相關文章: