servlet的url-pattern匹配規則詳細描述

luwanglin發表於2020-09-29
Servlet

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/

注意：路徑和副檔名匹配無法同時設定，比如下面的三個都是非法的，如果設定，啟動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。

七、補充

web.xml中url-pattern /和/*之間的區別

  1. 配置springMVC中的DispatcherServlet時
<servlet-mapping>
    <servlet-name>spring</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>
  1. 配置過濾器時
<filter-mapping>
    <filter-name>encodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

1.servlet的<url-pattern>/</url-pattern> 不會攔截*.jsp，也就不會進入spring的DispatcherServlet類。

2.filter的<url-pattern>/*</url-pattern>會攔截，就是說所有的這個專案的請求都會被捕捉，過濾。

注：為避免靜態資源被攔截需要在spring.xml檔案中配置<mvc:resources location="/images/" mapping="/images/**"/>。

關於web.xml的url對映:

<url-pattern>/</url-pattern> 會匹配到/login這樣的路徑型url，不會匹配到模式為*.jsp這樣的字尾型url

<url-pattern>/*</url-pattern> 會匹配所有url：路徑型的和字尾型的url(包括/login,*.jsp,*.js和*.html等)

案列分析springmvc中dispatcherServlet配置/和/*的區別：

  1. 首先/這個是表示預設的路徑，及表示：當沒有找到可以匹配的URL就用這個URL去匹配。
  2. 在springmvc中可以配置多個DispatcherServlet，比如： 配置多個DispatcherServlet有/和/*，先匹配的是/*這個
  3. 當配置相同的情況下：
    • /：使用/配置路徑，直接訪問到jsp，不經springDispatcherServlet
    • /*：配置/*路徑，不能訪問到多檢視的jsp

比如：

當我在客戶端呼叫URL：/user/list然後返回user.jsp檢視，

  • 當配置的是/：DispathcherServlet拿到這個請求然後返回對應的controller，然後依據Dispather Type為Forward型別轉發到user.jsp檢視，即就是請求user.jsp檢視(/user/user.jsp)，此時Dispather沒有截/user/user.jsp，因為此時你配置的是預設的/，就順利的交給ModleAndView去處理顯示了。
  • 當配置的是/*：DispathcherServlet拿到這個請求然後返回對應的controller，然後通過Dispather Type通過Forward轉發到user.jsp檢視，即就是請求user.jsp檢視(/user/user.jsp)，此時Dispather已經截/user/user.jsp，Dispatcher會把他當作Controller去匹配，沒有匹配到就會報404錯誤。

注：在配置檢視的時候儘量用/這種方式。

參考文獻

相關文章