@PathVariable`

@PathVariable 是 Spring 框架中的一个注解，用于从请求的 URL 路径中提取变量并将其传递给控制器方法的参数。这在 RESTful 风格的 Web 服务中非常常见，通常用于处理路径参数。

使用场景

在 RESTful API 中，我们经常需要在 URL 路径中传递一些参数，例如资源的 ID 或名称。@PathVariable 注解使得我们可以方便地将这些路径中的参数提取出来并传递给控制器的方法。

基本用法

示例 1：简单的 @PathVariable 使用

假设我们有一个 RESTful 服务，需要根据用户 ID 获取用户信息：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    @GetMapping("/users/{id}")
    public String getUserById(@PathVariable("id") String userId) {
        // 处理逻辑，例如从数据库获取用户信息
        return "User ID: " + userId;
    }
}

在这个例子中，当我们访问 /users/123 时，@PathVariable 注解会将路径中的 123 提取出来，并赋值给 getUserById 方法的 userId 参数。

示例 2：省略 @PathVariable 注解中的参数名

如果方法参数名和路径变量名相同，可以省略 @PathVariable 注解中的参数名：

@GetMapping("/users/{id}")
public String getUserById(@PathVariable String id) {
    return "User ID: " + id;
}

多个路径变量

如果 URL 中有多个路径变量，可以使用多个 @PathVariable 注解：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class OrderController {

    @GetMapping("/users/{userId}/orders/{orderId}")
    public String getOrder(@PathVariable("userId") String userId, @PathVariable("orderId") String orderId) {
        return "User ID: " + userId + ", Order ID: " + orderId;
    }
}

当我们访问 /users/123/orders/456 时，@PathVariable 注解会将路径中的 123 提取到 userId 参数，将 456 提取到 orderId 参数。

可选路径变量

如果某些路径变量是可选的，可以使用 required 属性：

@GetMapping("/users/{id}")
public String getUserById(@PathVariable(value = "id", required = false) String userId) {
    if (userId == null) {
        return "User ID not provided";
    }
    return "User ID: " + userId;
}

总结

@PathVariable 注解在 Spring 框架中用于从 URL 路径中提取变量并将其传递给控制器方法的参数，常用于 RESTful 风格的 Web 服务。它使得路径参数的处理变得简单和直观，并且支持多个路径变量和可选路径变量的使用。通过结合 @PathVariable 和其他注解（如 @RequestParam），可以构建功能强大的 RESTful API。