@PathVariable 和 @RequestParam区别

@PathVariable 和 @RequestParam 都是用于在 Spring MVC 中处理 HTTP 请求参数的注解，但它们用于不同的场景，并且从请求中提取参数的方式也不同。下面是两者的区别和使用方法。

1. @PathVariable 注解

• 用途：
  @PathVariable 用于将 URL 路径中的某个片段绑定到方法参数上。通常用于 RESTful 风格的 URL 中，通过 URL 模板的方式获取路径参数。

• 用法：
  当你定义一个 RESTful 风格的 URL 需要包含动态部分（例如用户 ID 或资源名称），可以使用 @PathVariable 来绑定这些动态部分到方法的参数。

• 示例：

  @GetMapping("/users/{id}")
  public User getUserById(@PathVariable("id") Long userId) {
      // 使用 userId 处理请求逻辑
      return userService.getUserById(userId);
  }
  

• 解释：

  • 在上面的例子中，{id} 是 URL 路径中的一个变量部分。
  • @PathVariable("id") 将路径中的 {id} 绑定到方法参数 userId 上。当客户端发起请求 /users/123 时，userId 的值为 123。

• 常见场景：
  使用 @PathVariable 通常用于 RESTful 风格的接口，资源的标识符（如用户 ID、产品 ID 等）直接作为路径的一部分。例如：/users/{id}、/products/{productId} 等。

2. @RequestParam 注解

• 用途：
  @RequestParam 用于将 HTTP 请求中的查询参数绑定到方法参数上。它用于从 URL 中获取请求参数（通常是查询字符串参数），如 ?name=John 或 ?id=123。

• 用法：
  如果需要从 URL 中的查询字符串部分获取参数（?param=value 格式），可以使用 @RequestParam。

• 示例：

  @GetMapping("/search")
  public List<User> searchUsers(@RequestParam("name") String name) {
      // 使用 name 参数处理请求逻辑
      return userService.searchUsersByName(name);
  }
  

• 解释：

  • 在上面的例子中，@RequestParam("name") 用于获取请求中的查询参数 name 的值。
  • 当客户端发起请求 /search?name=John 时，name 的值为 John。

• 常见场景：
  使用 @RequestParam 通常用于需要从查询字符串获取参数的场景，例如搜索、筛选或分页请求等。

3. 区别总结

特性	@PathVariable	@RequestParam
用途	从 URL 路径中提取参数	从请求的查询字符串中提取参数
示例 URL	/users/{id}	/search?name=John
示例使用	@GetMapping("/users/{id}")	@GetMapping("/search")
提取位置	路径变量部分（例如 /users/123 中的 123）	查询字符串部分（例如 ?name=John 中的 John）
参数是否必须	默认必须，如果需要可设置 required=false	默认必须，可以设置 required=false
是否支持类型转换	是，支持简单类型转换（例如 String 到 Long）	是，支持简单类型转换（例如 String 到 Integer）

4. 组合使用的场景

在实际开发中，@PathVariable 和 @RequestParam 可以组合使用。例如，一个请求路径包含固定资源的标识符，同时需要查询字符串参数来控制请求的具体行为：

@GetMapping("/users/{id}")
public User getUserByIdAndStatus(@PathVariable("id") Long userId, 
                                 @RequestParam(value = "status", required = false) String status) {
    // 使用 userId 和 status 处理请求逻辑
    return userService.getUserByIdAndStatus(userId, status);
}

• 在这个例子中，@PathVariable("id") 获取 URL 路径中的用户 ID，而 @RequestParam("status") 获取查询参数中的用户状态。
• 请求示例：/users/123?status=active，其中 id 是路径参数，status 是查询字符串参数。

总结

• @PathVariable： 用于从 URL 路径中提取参数，适用于 RESTful 风格的接口。
• @RequestParam： 用于从查询字符串中提取参数，适用于需要通过查询参数进行筛选、搜索或分页等操作的场景。