ToB企服应用市场:ToB评测及商务社交产业平台

标题: @PathVariable和@RequestParam的区别？思维导图 代码示例（java 架构） [打印本页]

---

作者: 民工心事    时间: 2024-12-28 11:01
标题: @PathVariable和@RequestParam的区别？思维导图 代码示例（java 架构）
@PathVariable 和 @RequestParam 的区别

在Spring MVC中，@PathVariable 和 @RequestParam 是用于将请求参数绑定到控制器方法参数上的两个重要注解。它们的重要区别在于如何从HTTP请求中提取数据以及适用的场景不同。
1. @PathVariable

• 作用：
  
  
  
  • 用于从URI模板中提取路径变量，并将其绑定到方法参数上。
    
  • 常用于RESTful风格的API计划，此中资源标识符（如ID）是URL的一部分。
    
  
  
• 特点：
  
  
  
  • 路径中的占位符必须与方法参数名匹配或通过name属性指定。
    
  • 如果路径中没有提供相应的值，则会抛出非常（除非设置了默认值或允许为空）。
    
  • 支持正则表达式来定义更复杂的匹配规则。
    
  
  
• 示例用途：
  
  
  
  • 获取特定用户的详情：/users/{id} 中的 {id} 就是一个路径变量。
    
  
  

2. @RequestParam

• 作用：
  
  
  
  • 用于从查询字符串或表单提交的数据中获取请求参数，并将其绑定到方法参数上。
    
  • 适用于GET请求的查询参数、POST请求的表单字段等非路径部分的数据。
    
  
  
• 特点：
  
  
  
  • 参数名称可以通过name或value属性指定，默认情况下使用方法参数名。
    
  • 可以设置是否为必需参数（required属性），并且可以提供默认值（defaultValue属性）。
    
  • 对于多值参数（例如复选框），可以接收数组或聚集类型作为参数。
    
  
  
• 示例用途：
  
  
  
  • 搜索功能中的关键词参数：/search?query=keyword 中的 query 是一个请求参数。
    
  
  

思维导图结构

• @PathVariable
  
  
  
  • 作用
    
    
    
    • 提取路径变量
      
    • RESTful API计划
      
    
    
  • 特点
    
    
    
    • 必须匹配路径中的占位符
      
    • 不提供时会抛出非常
      
    • 支持正则表达式
      
    
    
  • 适用场景
    
    
    
    • 获取特定资源信息
      
    
    
  
  
• @RequestParam
  
  
  
  • 作用
    
    
    
    • 获取查询字符串或表单参数
      
    • 非路径部分的数据
      
    
    
  • 特点
    
    
    
    • 参数名称可自定义
      
    • 可选参数和默认值支持
      
    • 多值参数处置惩罚
      
    
    
  • 适用场景
    
    
    
    • 搜索、过滤等功能
      
    
    
  
  
• 对比
  
  
  
  • 泉源
    
    
    
    • @PathVariable: URI路径
      
    • @RequestParam: 查询字符串或表单数据
      
    
    
  • 须要性
    
    
    
    • @PathVariable: 通常必需，不提供则报错
      
    • @RequestParam: 可配置是否必需及默认值
      
    
    
  • 灵活性
    
    
    
    • @PathVariable: 固定位置
      
    • @RequestParam: 更灵活，可以有多个类似名称的参数
      
    
    
  
  

代码示例

使用 @PathVariable 的示例

1. import org.springframework.web.bind.annotation.*;
3. @RestController
4. @RequestMapping("/api/users")
5. public class UserController {
7.     @GetMapping("/{id}")
8.     public String getUserById(@PathVariable Long id) {
9.         // 根据用户ID查找并返回用户信息
10.         return "User details for ID: " + id;
11.     }
12. }

复制代码

在这个例子中，getUserById() 方法通过 @PathVariable 注解从路径 /api/users/{id} 中提取用户ID，并将其传递给方法参数 id。
使用 @RequestParam 的示例

1. import org.springframework.web.bind.annotation.*;
3. @RestController
4. @RequestMapping("/api/search")
5. public class SearchController {
7.     @GetMapping
8.     public String searchUsers(@RequestParam(name = "query", required = false, defaultValue = "all") String query) {
9.         // 根据查询参数搜索用户
10.         return "Search results for: " + query;
11.     }
13.     @PostMapping
14.     public String addUser(@RequestParam("username") String username, @RequestParam("email") String email) {
15.         // 添加新用户，这里假设是从表单提交的数据
16.         return "Added user with username: " + username + " and email: " + email;
17.     }
18. }

复制代码

这段代码展示了如何使用 @RequestParam 来处置惩罚查询字符串中的参数（/api/search?query=keyword）以及表单提交的数据（POST请求）。注意，searchUsers() 方法中的 query 参数是可选的，并且有一个默认值；而 addUser() 方法则需要用户提供 username 和 email 参数。
总结

@PathVariable 和 @RequestParam 各自适用于不同的场景：前者重要用于RESTful风格的路由计划，后者则适合处置惩罚查询参数或表单提交的数据。明白这两个注解的区别可以资助开辟者更好地计划和实现Web应用程序的功能，确保精确的参数绑定和请求处置惩罚逻辑。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

---

欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/)

Powered by Discuz! X3.4