URL @PathVariable 變量的匹配原理分析

Posted on by

URL @PathVariable 變量匹配原理

url 中帶有變量的匹配原理

在設置url的路徑中我們可能使用變量來提高路徑的靈活性，如

@RequestMapping(value="/{str}/qian",method=RequestMethod.GET) @ResponseBody public String qianStr(@PathVariable String str){ return "qianStr:"+str; }

然後在輸入 http://localhost:8080/zhende/qian 路徑的時候就可以匹配上 qianStr 方法，但是卻一直沒有細想過具體是怎麼實現這個匹配的。

開始預測是通過正則表達式來匹配路徑就行，但問題是我輸入的是 /zhende/qian 怎麼匹配到 /{str}/qian 呢，還是想不通，所以通過寫個demo 調試來看怎麼匹配的，過程如下：

Demo

使用springboot 來寫個簡單的web

package com.example.demo;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller()
@RequestMapping("/get")
public class TestController {
    @RequestMapping(value="/li", method = RequestMethod.GET)
    @ResponseBody
    public String test(){
        return "test";
    }
    @RequestMapping(value="/{str}",method=RequestMethod.GET)
    @ResponseBody
    public String li(@PathVariable String str){
        return "li:"+str;
    }
    @RequestMapping(value="/qian/{str}",method=RequestMethod.GET)
    @ResponseBody
    public String qianStr(@PathVariable String str){
        return "qianStr:"+str;
    }
    @RequestMapping(value="/{str}/qian",method=RequestMethod.GET)
    @ResponseBody
    public String strQian(@PathVariable String str){
        return "strQian:"+str;
    }
}

上邊寫啦好幾個路徑以便我們更好的比對匹配過程。

調試如下

啟動服務後輸入如下路徑：

在這裡插入圖片描述

在這裡插入圖片描述

可以看到 左邊的調用棧中 有 DispatcherServlet 分派調用過來的，所以查看DispatcherServlet 關聯代碼 由mappedHandler處理的所以在DispatcherServlet 中加入斷點再次調試。

在這裡插入圖片描述

進入方法中

在這裡插入圖片描述

發現handlerMappings 有5中處理類型，進入 mapping.getHandler(request) 方法查看具體的執行過程

在這裡插入圖片描述

SimpleUrlHandlerMapping 中獲取的handler 為空，繼續嘗試第二個handlermapping 類型，

在這裡插入圖片描述

這個方法會將 request中的請求路徑和服務中存在的mappings 做匹配，也就是正式的路徑匹配過程。繼續進入方法，

在這裡插入圖片描述 在這裡插入圖片描述

由PatternsRequestCondition 來處理 服務中的pattern和請求lookupPath的匹配，路徑相同就直接返回該pattern，不相同則通過 AntPathMatcher 來繼續處理路徑匹配，

在這裡插入圖片描述

將服務中的pattern 分詞，然後和請求的path 做匹配，發現/test/li 和/get/zhende/qian 匹配失敗，然後繼續下一個pattern 的匹配，在面對分詞後的{str}的匹配時，會將{str} 轉成 (.*)進行正則匹配，即完成url路徑中變量的匹配

在這裡插入圖片描述

找到路徑後獲取相應的handlermethod，然後執行對應的目標路徑方法

在這裡插入圖片描述

在這裡插入圖片描述

總結

URL @PathVariable 變量的匹配是由PatternsRequestCondition 來完成的，具體的是由 AntPathMatcher 來處理，項目啟動後會將提供的url 放入容器handlerMappings 中，當請求過來時會將請求path 和handlerMappings 中的pattern 逐一匹配，由匹配時會將路徑先分詞，有{str}變量的轉成 (.*) 再匹配，匹配完成後調用相應的handlermethod執行方法，進入目標方法。

備註

遺留問題，當項目中有多個路徑可以匹配會怎麼執行？為什麼一開始的DispatcherServlet 中會有5中類型的handlerMappings？

@PathVariable

@PathVariable 映射 URL 綁定的占位符

帶占位符的 URL 是 Spring3.0 新增的功能，該功能在SpringMVC 向 REST 目標挺進發展過程中具有裡程碑的意義

通過 @PathVariable 可以將 URL 中占位符參數綁定到控制器處理方法的入參中：URL 中的 {xxx} 占位符可以通過@PathVariable(“xxx“) 綁定到操作方法的入參中。

實例：

SpringMVCTest.java

//@PathVariable可以用來映射URL中的占位符到目標方法的參數中
@RequestMapping("/testPathVariable/{id}")
    public String testPathVariable(@PathVariable("id") Integer id)
    {
        System.out.println("testPathVariable:"+id);
        return SUCCESS;
    }

index.jsp

<a href="springmvc/testPathVariable/1" rel="external nofollow" >testPathVariable</a>

REST

  • REST：即 Representational State Transfer。（資源）表現層狀態轉化。是目前最流行的一種互聯網軟件架構。它結構清晰、符合標準、易於理解、擴展方便，所以正得到越來越多網站的采用
  • 資源（Resources）：網絡上的一個實體，或者說是網絡上的一個具體信息。它可以是一段文本、一張圖片、一首歌曲、一種服務，總之就是一個具體的存在。可以用一個URI（統一資源定位符）指向它，每種資源對應一個特定的 URI 。要獲取這個資源，訪問它的URI就可以，因此 URI 即為每一個資源的獨一無二的識別符。
  • 表現層（Representation）：把資源具體呈現出來的形式，叫做它的表現層（Representation）。比如，文本可以用 txt 格式表現，也可以用 HTML 格式、XML 格式、JSON 格式表現，甚至可以采用二進制格式。
  • 狀態轉化（State Transfer）：每發出一個請求，就代表瞭客戶端和服務器的一次交互過程。HTTP協議，是一個無狀態協議，即所有的狀態都保存在服務器端。因此，如果客戶端想要操作服務器，必須通過某種手段，讓服務器端發生“狀態轉化”（State Transfer）。而這種轉化是建立在表現層之上的，所以就是 “表現層狀態轉化”。具體說，就是 HTTP 協議裡面，四個表示操作方式的動詞：GET、POST、PUT、DELETE。它們分別對應四種基本操作：GET 用來獲取資源，POST 用來新建資源，PUT 用來更新資源，DELETE 用來刪除資源。

示例：

  • - /order/1 HTTP GET ：得到 id = 1 的 order
  • - /order/1 HTTP DELETE：刪除 id = 1的 order
  • - /order/1 HTTP PUT：更新id = 1的 order
  • - /order HTTP POST：新增 order

HiddenHttpMethodFilter：瀏覽器 form 表單隻支持 GET與 POST 請求，而DELETE、PUT 等 method 並不支持，Spring3.0 添加瞭一個過濾器，可以將這些請求轉換為標準的 http 方法，使得支持 GET、POST、PUT 與DELETE 請求。

在web.xml中配置HiddenHttpMethodFilter

web.xml

 <!--
     配置org.springframework.web.filter.HiddenHttpMethodFilter:可以把POST請求轉換成DELETE或者POST請求
      -->
   <filter>
      <filter-name>HiddenHttpMethodFilter</filter-name>
      <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
   </filter>   
   <filter-mapping>
      <filter-name>HiddenHttpMethodFilter</filter-name>
      <url-pattern>/*</url-pattern>
   </filter-mapping>

在SpringMVCTest中測試相應的方法

SpringMVCTest.java

/*
     * 如何發送PUT和DELETE請求
     * 1.需要配置HiddenHttpMethodFilter
     * 2.需要發送POST請求
     * 3.需要發送POST請求時攜帶一個name="_method"的隱藏域，value值為DELETE或者PUT
     * 
     * 在springmvc框架中通過@PathVariable註解來獲取id值
     * */
    //get請求
    @RequestMapping(value="/testRest/{id}",method=RequestMethod.GET)
    public String testRest(@PathVariable Integer id)
    {
        System.out.println("testRest Get"+id);
        return SUCCESS;
    }
    //post請求
    @RequestMapping(value="/testRest",method=RequestMethod.POST)
    public String testRest()
    {
        System.out.println("testRest POST");
        return SUCCESS;
    }
    //delete請求
    @RequestMapping(value="/testRest/{id}",method=RequestMethod.DELETE)
    public String testRestDelete(@PathVariable Integer id)
    {
        System.out.println("testRest DELETE"+id);
        return SUCCESS;
    }
    //delete請求
    @RequestMapping(value="/testRest/{id}",method=RequestMethod.PUT)
    public String testRestPut(@PathVariable Integer id)
    {
        System.out.println("testRest PUT"+id);
        return SUCCESS;
    }

index.jsp中的寫法

index.jsp

<a href="springmvc/testRest/1" rel="external nofollow" >Test Rest Get</a><br/>
<form action="springmvc/testRest" method="post">
<input type="submit" value="TestRest Post"/>
</form><br/>
<form action="springmvc/testRest/1" method="post">
<input type="hidden" name="_method" value="DELETE"/>
<input type="submit" value="TestRest DELETE"/>
</form><br/>
<form action="springmvc/testRest/1" method="post">
<input type="hidden" name="_method" value="PUT"/>
<input type="submit" value="TestRest PUT"/>
</form><br/>

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：