Spring MVC 中的 `@PathVariable` 注解有什么作用？

推荐答案

@PathVariable 注解用于将 URL 中的占位符参数绑定到控制器方法的参数上。它通常用于 RESTful Web 服务中，从 URL 中提取变量值并传递给方法。

例如：

@GetMapping("/users/{id}")
public String getUser(@PathVariable("id") Long userId) {
    // 使用 userId 进行业务逻辑处理
    return "user";
}

在这个例子中，URL 中的 {id} 占位符会被映射到 userId 参数上。

本题详细解读

1. @PathVariable 的基本用法

@PathVariable 注解用于从 URL 中提取变量值，并将其绑定到控制器方法的参数上。它通常与 @RequestMapping 或其变体（如 @GetMapping、@PostMapping 等）一起使用。

2. 参数绑定

@PathVariable 可以绑定到简单类型（如 String、int、Long 等）或复杂类型（如自定义对象）。如果 URL 中的占位符名称与方法参数名称一致，可以省略注解中的值。

例如：

@GetMapping("/users/{userId}")
public String getUser(@PathVariable Long userId) {
    // 使用 userId 进行业务逻辑处理
    return "user";
}

在这个例子中，@PathVariable 注解会自动将 {userId} 的值绑定到 userId 参数上。

3. 多个 @PathVariable 的使用

可以在一个方法中使用多个 @PathVariable 注解，以从 URL 中提取多个变量。

例如：

@GetMapping("/users/{userId}/orders/{orderId}")
public String getOrder(@PathVariable Long userId, @PathVariable Long orderId) {
    // 使用 userId 和 orderId 进行业务逻辑处理
    return "order";
}

4. 可选路径变量

从 Spring 4.3 开始，@PathVariable 支持可选路径变量。可以通过设置 required = false 来使路径变量变为可选。

例如：

@GetMapping("/users/{userId}")
public String getUser(@PathVariable(required = false) Long userId) {
    if (userId == null) {
        return "allUsers";
    }
    return "user";
}

5. 正则表达式匹配

@PathVariable 还支持使用正则表达式来限制路径变量的格式。

例如：

@GetMapping("/users/{userId:\\d+}")
public String getUser(@PathVariable Long userId) {
    // 使用 userId 进行业务逻辑处理
    return "user";
}

在这个例子中，{userId:\\d+} 表示 userId 必须是一个或多个数字。

6. 与 @RequestParam 的区别

@PathVariable 用于从 URL 路径中提取变量，而 @RequestParam 用于从查询参数中提取变量。两者的使用场景不同，@PathVariable 更适合 RESTful 风格的 URL 设计。