Java @PathVariable获取路径参数

@PathVariable 是 Spring MVC 中用于从 URL 路径中提取变量的注解。它通常用于 RESTful API 中，将 URL 中的动态部分绑定到控制器方法的参数上。以下是 @PathVariable 的详细介绍：

1. 基本用法

@PathVariable 可以将 URL 路径中的变量绑定到方法参数上。

java 复制代码

@GetMapping("/user/{id}")
public String getUser(@PathVariable Long id) {
    return "User ID: " + id;
}

在这个例子中，{id} 是 URL 路径中的占位符，@PathVariable 将其值绑定到 id 参数上。例如，访问 /user/123 时，id 的值将是 123。

2. 指定路径变量名称

默认情况下，@PathVariable 会使用方法参数的名称作为路径变量的名称。如果路径变量的名称与方法参数的名称不同，可以使用 value 属性指定。

java 复制代码

@GetMapping("/user/{userId}")
public String getUser(@PathVariable("userId") Long id) {
    return "User ID: " + id;
}

在这个例子中，URL 路径中的变量名称是 userId，而方法参数名称是 id。

3. 多个路径变量

可以在一个 URL 路径中使用多个占位符，并在方法中绑定多个 @PathVariable 参数。

java 复制代码

@GetMapping("/user/{id}/post/{postId}")
public String getUserPost(@PathVariable Long id, @PathVariable Long postId) {
    return "User ID: " + id + ", Post ID: " + postId;
}

在这个例子中，URL 路径中有两个占位符：{id} 和 {postId}。访问 /user/123/post/456 时，id 的值将是 123，postId 的值将是 456。

4. 可选路径变量

从 Spring 4.3.3 开始，@PathVariable 支持可选路径变量。可以通过 required 属性将路径变量设置为非必填。

java 复制代码

@GetMapping("/user/{id}")
public String getUser(@PathVariable(required = false) Long id) {
    if (id == null) {
        return "User ID not provided";
    }
    return "User ID: " + id;
}

在这个例子中，如果 URL 中没有提供 id，id 的值将是 null。

5. 正则表达式匹配

可以在 URL 路径中使用正则表达式来限制路径变量的格式。

java 复制代码

@GetMapping("/user/{id:\\d+}")
public String getUser(@PathVariable Long id) {
    return "User ID: " + id;
}

在这个例子中，{id:\\d+} 表示 id 必须是一个或多个数字。如果 URL 中的 id 不是数字，Spring 会返回 404 错误。

6. 绑定到复杂对象

@PathVariable 通常用于绑定简单类型的参数（如 String、Long 等），但也可以通过自定义的 Converter 或 Formatter 绑定到复杂对象。

示例：绑定到自定义对象

java 复制代码

public class User {
    private Long id;
    private String name;
    // getters and setters
}

@GetMapping("/user/{id}/{name}")
public String getUser(@PathVariable Long id, @PathVariable String name) {
    User user = new User();
    user.setId(id);
    user.setName(name);
    return "User: " + user.getId() + ", " + user.getName();
}

在这个例子中，id 和 name 分别绑定到 User 对象的属性上。

7. 使用场景

@PathVariable 适用于以下场景：

RESTful API 中从 URL 路径中提取变量。
动态生成 URL 路径。
处理层次化资源（如 /user/{id}/post/{postId}）。

8. 示例代码

以下是一个完整的示例，展示了 @PathVariable 的各种用法：

java 复制代码

@RestController
public class UserController {

    @GetMapping("/user/{id}")
    public String getUser(@PathVariable Long id) {
        return "User ID: " + id;
    }

    @GetMapping("/user/{id}/post/{postId}")
    public String getUserPost(@PathVariable Long id, @PathVariable Long postId) {
        return "User ID: " + id + ", Post ID: " + postId;
    }

    @GetMapping("/user/{id:\\d+}")
    public String getUserWithRegex(@PathVariable Long id) {
        return "User ID (digits only): " + id;
    }

    @GetMapping("/user/{id}/{name}")
    public String getUserWithName(@PathVariable Long id, @PathVariable String name) {
        return "User ID: " + id + ", Name: " + name;
    }
}

请求示例

获取用户信息：
- URL: GET /user/123
- 响应：User ID: 123
获取用户的帖子：
- URL: GET /user/123/post/456
- 响应：User ID: 123, Post ID: 456
使用正则表达式匹配：
- URL: GET /user/123
- 响应：User ID (digits only): 123
- 如果 URL 是 GET /user/abc，Spring 会返回 404 错误。
获取用户信息（带名称）：
- URL: GET /user/123/John
- 响应：User ID: 123, Name: John

9. 注意事项

路径变量名称 ：确保路径变量名称与方法参数名称一致，或使用 value 属性显式指定。
正则表达式：使用正则表达式时，确保模式与路径变量的格式匹配。
可选路径变量：在 Spring 4.3.3 及以上版本中支持。

总结

@PathVariable 是 Spring MVC 中用于从 URL 路径中提取变量的注解，非常适合用于 RESTful API 的开发。它支持绑定简单类型、多个变量、正则表达式匹配以及可选路径变量，能够灵活处理各种 URL 路径场景。