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

目录

• URL @PathVariable 变量匹配原理
• url 中带有变量的匹配原理
• Demo
• 调试如下
• 总结
• 备注
• @PathVariable
• @PathVariable 映射 URL 绑定的占位符
• REST

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/>

以上为个人经验，希望能给大家一个参考，也希望大家多多支持自由互联。