@PathVariable详情及用法解析

本文介绍SpringMVC框架中使用@PathVariable实现URL参数绑定,以及如何通过配置HiddenHttpMethodFilter支持RESTful架构下的PUT和DELETE请求。深入探讨了RESTful设计原则,包括资源、表现层和状态转化的概念。

@PathVariable 映射 URL 绑定的占位符

  • 带占位符的 URL 是 Spring3.0 新增的功能,该功能在SpringMVC 向 REST 目标挺进发展过程中具有里程碑的意义
  • 通过 @PathVariable 可以将 URL 中占位符参数绑定到控制器处理方法的入参中:URL 中的 {xxx} 占位符可以通过@PathVariable(“xxx“) 绑定到操作方法的入参中。

实例: 
SpringMVCTest.java

 
  1. //@PathVariable可以用来映射URL中的占位符到目标方法的参数中

  2. @RequestMapping("/testPathVariable/{id}")

  3. public String testPathVariable(@PathVariable("id") Integer id)

  4. {

  5. System.out.println("testPathVariable:"+id);

  6. return SUCCESS;

  7. }

index.jsp

<a href="springmvc/testPathVariable/1">testPathVariable</a>

3.2REST

  • 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 请求。

3.2.1在web.xml中配置HiddenHttpMethodFilter

web.xml

 
  1. <!--

  2. 配置org.springframework.web.filter.HiddenHttpMethodFilter:可以把POST请求转换成DELETE或者POST请求

  3. -->

  4.  
  5. <filter>

  6. <filter-name>HiddenHttpMethodFilter</filter-name>

  7. <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>

  8. </filter>

  9.  
  10. <filter-mapping>

  11. <filter-name>HiddenHttpMethodFilter</filter-name>

  12. <url-pattern>/*</url-pattern>

  13. </filter-mapping>

3.2.2在SpringMVCTest中测试相应的方法

SpringMVCTest.java

 
  1. /*

  2. * 如何发送PUT和DELETE请求

  3. * 1.需要配置HiddenHttpMethodFilter

  4. * 2.需要发送POST请求

  5. * 3.需要发送POST请求时携带一个name="_method"的隐藏域,value值为DELETE或者PUT

  6. *

  7. * 在springmvc框架中通过@PathVariable注解来获取id值

  8. * */

  9. //get请求

  10. @RequestMapping(value="/testRest/{id}",method=RequestMethod.GET)

  11. public String testRest(@PathVariable Integer id)

  12. {

  13. System.out.println("testRest Get"+id);

  14. return SUCCESS;

  15. }

  16.  
  17. //post请求

  18. @RequestMapping(value="/testRest",method=RequestMethod.POST)

  19. public String testRest()

  20. {

  21. System.out.println("testRest POST");

  22. return SUCCESS;

  23. }

  24.  
  25. //delete请求

  26. @RequestMapping(value="/testRest/{id}",method=RequestMethod.DELETE)

  27. public String testRestDelete(@PathVariable Integer id)

  28. {

  29. System.out.println("testRest DELETE"+id);

  30. return SUCCESS;

  31. }

  32.  
  33. //修改请求

  34. @RequestMapping(value="/testRest/{id}",method=RequestMethod.PUT)

  35. public String testRestPut(@PathVariable Integer id)

  36. {

  37. System.out.println("testRest PUT"+id);

  38. return SUCCESS;

  39. }

3.2.3index.jsp中的写法

index.jsp

 
  1. <a href="springmvc/testRest/1">Test Rest Get</a><br/>

  2. <form action="springmvc/testRest" method="post">

  3. <input type="submit" value="TestRest Post"/>

  4. </form><br/>

  5. <form action="springmvc/testRest/1" method="post">

  6. <input type="hidden" name="_method" value="DELETE"/>

  7. <input type="submit" value="TestRest DELETE"/>

  8. </form><br/>

  9. <form action="springmvc/testRest/1" method="post">

  10. <input type="hidden" name="_method" value="PUT"/>

  11. <input type="submit" value="TestRest PUT"/>

  12. </form><br/>

### @PathVariable 注解的参数解析源码分析 在 Spring MVC 中,`@PathVariable` 注解用于从 URL 路径中提取模板变量,使得控制器方法能够轻松地获取这些变量值并绑定到方法参数上。其底层实现依赖于 Spring MVC 的 URL 匹配机制和参数解析策略。 #### URL 模板变量的提取与存储 Spring MVC 在处理请求时,首先会根据请求的 URL 与控制器方法中定义的路径模式进行匹配。在匹配过程中,`RequestMappingInfoHandlerMapping` 类负责提取 URL 中的模板变量。具体来说,`getPathMatcher().extractUriTemplateVariables()` 方法会将匹配的路径模式与实际请求路径进行比较,并提取出路径变量的键值对。这些变量随后被解码,并存储在请求属性中,键为 `HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE`,值为 `decodedUriTemplateVariables`。这一过程确保了路径变量可以在后续的参数解析中被访问[^3]。 #### `@PathVariable` 注解的解析机制 在控制器方法执行时,Spring MVC 会使用 `PathVariableMethodArgumentResolver` 来解析带有 `@PathVariable` 注解的方法参数。该解析器会从请求属性中获取之前存储的路径变量映射,并根据注解中的 `name` 或 `value` 属性查找对应的变量值。如果找到了匹配的变量值,则将其转换为方法参数的类型;如果没有找到匹配的变量值且 `required` 属性为 `true`,则抛出 `MissingServletRequestParameterException` 异常。通过这种方式,`@PathVariable` 注解能够有效地将 URL 路径中的变量绑定到控制器方法的参数上[^2]。 #### `@PathVariable` 注解的可选参数处理 Spring MVC 还支持将 `@PathVariable` 注解的参数设置为可选。通过设置 `required = false`,可以允许某些路径变量在 URL 中不存在。例如,在定义路径模式时,可以通过提供多个路径选项(如 `value = {"/article", "/article/{articleId}"}`)来允许匹配不同的 URL 模式。此时,`@PathVariable` 注解的方法参数将根据 URL 的实际匹配情况返回 `null` 或具体的值。这种机制为处理可选路径变量提供了灵活性,使得控制器方法可以适应不同的 URL 结构[^4]。 #### 示例代码 以下是一个使用 `@PathVariable` 注解的控制器方法示例: ```java @RestController @RequestMapping("/users") public class UserController { @GetMapping("/{id}") public ResponseEntity<String> getUserById(@PathVariable Long id) { return ResponseEntity.ok("User ID: " + id); } @GetMapping({"/article", "/article/{articleId}"}) public ResponseEntity<String> handleArticle(@PathVariable(required = false) Integer articleId) { if (articleId == null) { return ResponseEntity.ok("No article ID provided"); } else { return ResponseEntity.ok("Article ID: " + articleId); } } } ``` 在上述代码中,`@PathVariable` 注解用于从 URL 路径中提取 `id` 和 `articleId` 参数。第一个方法 `getUserById` 仅处理包含 `id` 参数的 URL,而第二个方法 `handleArticle` 可以处理两种 URL 模式:`/article` 和 `/article/123`,其中 `articleId` 是可选的。 ###
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值