servlet的url-pattern匹配規則詳細描述
一、概述
在利用servlet或Filter進行url請求的匹配時,很關鍵的一點就是匹配規則,但servlet容器中的匹配規則既不是簡單的通配,也不是正則表達式,而是由自己的規則,比較容易混淆。本文來詳細舉例介紹下。下面的說明都是在tomcat服務器中得到驗證的。
先介紹一下匹配的概念,上例子代碼。在一個app(如名字為myapp)的web.xml文件中,有如下信息:
<servlet> <servlet-name>MyServlet</servlet-name> <servlet-class>com.nau.MyServlet</servlet-class> </servlet> <servlet-mapping> <servlet-name>MyServlet</servlet-name> <url-pattern>xxxxxx</url-pattern> <url-pattern>yyyyyyy</url-pattern> </servlet-mapping>
上面的配置信息,其中<servlet>標簽首先配置聲明一個servlet,包括servlet的名字和對應的java類名。
其中<servlet-mapping>標簽聲明了與該servlet相應的匹配規則,每個<url-pattern>標簽代表1個匹配規則。
當瀏覽器發起一個url請求後,該請求發送到servlet容器的時候,容器先會將請求的url減去當前應用上下文的路徑作為servlet的映射url,比如url是http://10.43.11.143/myapp/kata/detail.html,其應用上下文是myapp,容器會將http://10.43.11.143/myapp去掉,剩下的/kata/detail.html部分拿來做servlet的映射匹配。這個映射匹配過程是有優先順序的(具體的優先順序規則後面介紹),而且當有一個servlet匹配成功以後,就不會去理會剩下的servlet了。
註意Filter的匹配規則與servlet一樣,但對於filter,不會像servlet那樣只匹配一個servlet,因為filter的集合是一個鏈,所以只會有處理的順序不同,而不會出現只選擇一個filter。Filter的處理順序和filter-mapping在web.xml中定義的順序相同。
下面我們詳細介紹各種匹配規則
二、精確匹配
<url-pattern>中配置的項必須與url完全精確匹配。
如配置信息如下:
<servlet-mapping> <servlet-name>MyServlet</servlet-name> <url-pattern>/kata/detail.html</url-pattern> <url-pattern>/demo.html</url-pattern> <url-pattern>/table</url-pattern> </servlet-mapping>
當在瀏覽器中輸入如下幾種url時,都會被匹配到該servlet
http://10.43.11.143/myapp/kata/detail.html
http://10.43.11.143/myapp/demo.html
http://10.43.11.143/myapp/table
註意:
http://10.43.11.143/myapp/table/ 是非法的url,不會被當作http://10.43.11.143/myapp/table識別
另外上述url後面可以跟任意的查詢條件,都會被匹配,如
http://10.43.11.143/myapp/table?hello 這個請求就會被匹配到MyServlet。
三、擴展名匹配
如果匹配規則如下
<servlet-mapping> <servlet-name>MyServlet</servlet-name> <url-pattern>*.jsp</url-pattern> </servlet-mapping>
則任何擴展名為jsp(文件名和路徑任意)的url請求都會匹配,比如下面的url都會被匹配
http://10.43.11.143/myapp/demo.jsp
http://10.43.11.143/myapp/test.jsp
四、路徑匹配
如果匹配規則如下
<servlet-mapping> <servlet-name>MyServlet</servlet-name> <url-pattern>/kata/*</url-pattern> </servlet-mapping>
則請求的ulr只要前面(myapp之後)的路徑是/kata,而後面的路徑可以任意。比如下面的url都會被匹配。
http://10.43.11.143/myapp/kata/demo.html
http://10.43.11.143/myapp/kata/test.jsp
http://10.43.11.143/myapp/kata/test/detail.html
http://10.43.11.143/myapp/kata/action
http://10.43.11.143/myapp/kata/action/
註意:路徑和擴展名匹配無法同時設置,比如下面的三個<url-pattern>都是非法的,如果設置,啟動tomcat服務器會報錯。
<url-pattern>/kata/*.jsp</url-pattern>
<url-pattern>/*.jsp</url-pattern>
<url-pattern>he*.jsp</url-pattern>
另外註意:<url-pattern>/aa/*/bb</url-pattern>
這個是精確匹配,url必須是 /aa/*/bb,這裏的*不是通配的含義
五、匹配任意的url
如果<url-pattern>配置成如下兩種的任意一種
<url-pattern>/</url-pattern>
<url-pattern>/*</url-pattern>
則所有的url都可以被匹配上。其中/*是路徑匹配,只是路徑就是/。
六、優先順序
當一個url與多個servlet的匹配規則可以匹配時,則按照 “ 精確路徑 > 最長路徑>擴展名”這樣的優先級匹配到對應的servlet。舉例如下:
例1:比如servletA 的url-pattern為 /test,servletB的url-pattern為 /* ,這個時候,如果我訪問的url為http://localhost/test ,這個時候容器就會先進行精確路徑匹配,發現/test正好被servletA精確匹配,那麽就去調用servletA,不會去管servletB。
例2:比如servletA的url-pattern為/test/*,而servletB的url-pattern為/test/a/*,此時訪問http://localhost/test/a時,容器會選擇路徑最長的servlet來匹配,也就是這裏的servletB。
例3: 比如servletA的url-pattern:*.action ,servletB的url-pattern為 /* ,這個時候,如果我訪問的url為http://localhost/test.action,這個時候容器就會優先進行路徑匹配,而不是去匹配擴展名,這樣就去調用servletB。
註意:
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> <!-- The mappings for the JSP servlet --> <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
- “/*”和“/”均會攔截靜態資源的加載,需要特別註意
四、舉例
映射的URL | 對應的Servlet |
/hello | servlet1 |
/bbs/admin/* | servlet2 |
/bbs/* | servlet3 |
*.jsp | servlet4 |
/ | servlet5 |
實際請求映射的結果
去掉上下文路徑的剩余路徑 |
處理請求的Servlet |
/hello |
servlet1 |
/bbs/admin/login |
servlet2 |
/bbs/admin/index.jsp |
servlet2 |
/bbs/display |
servlet3 |
/bbs/index.jsp |
servlet3 |
/bbs |
servlet3 |
/index.jsp |
servler4 |
/hello/index.jsp |
servlet4 |
/hello/index.html |
servlet5 |
/news |
servlet5 |
本文我們詳細介紹了servlet的匹配規則。總的來說就是分為精確、路徑和擴展名三種匹配方式,並且介紹了優先級。
本文轉自:https://www.cnblogs.com/51kata/p/5152400.html
servlet的url-pattern匹配規則詳細描述