当前位置：首页 > article >正文

pring MVC 中的 `@RequestParam` 注解

article 2025/2/8 15:57:21

前言

在Spring MVC中，@RequestParam 注解用于将请求参数（无论是GET请求中的查询参数还是POST请求中的表单数据）绑定到控制器方法的参数上。它提供了一种简单而有效的方式来获取并处理这些参数。

1. 基础用途

@RequestParam 最常见的用途是从HTTP请求中提取参数，并将其映射到控制器方法的参数上。以下是一个简单的例子：

@GetMapping("/user")
public String getUser(@RequestParam("id") Long userId) {
    // 使用userId执行业务逻辑
    return "user";
}

在这个例子中，RequestParam 注解的 value 属性指定了请求参数的名称（这里是 "id"），而 userId 参数则接收该请求参数的值。

2. 获取多个请求参数

您可以同时从请求中获取多个参数：

@GetMapping("/user")
public String getUser(@RequestParam("id") Long userId, @RequestParam("name") String userName) {
    // 使用userId和userName执行业务逻辑
    return "user";
}

3. 设置默认值

当您希望为某些参数设置一个默认值时，可以使用 defaultValue 属性：

注意是字符串类型的

@GetMapping("/user")
public String getUser(@RequestParam(value="id", defaultValue="1") Long userId) {
    // 如果没有传递'id'参数，则使用默认值1
    return "user";
}

4. 必需与非必需参数

必需参数：默认情况下，@RequestParam 标记的参数是必需的。如果缺少了必需参数，将会抛出异常。
非必需参数：可以通过设置 required=false 来指定参数不是必需的。如果未提供这样的参数，它的值将是 null 或者其类型的默认值（对于基本数据类型）。

@GetMapping("/user")
public String getUser(@RequestParam(value="id", required=false) Long userId) {
    // 如果没有提供'id'参数，userId将会是null
    return "user";
}

5. 处理数组或列表形式的参数

有时，您的请求参数可能是一个包含多个值的数组或列表。在这种情况下，您可以这样接收这些参数：

@GetMapping("/users")
public String findUsers(@RequestParam List<String> names) {
    // 处理名字列表
    return "user list";
}

或者

@GetMapping("/users")
public String findUsers(@RequestParam String[] names) {
    // 处理名字数组
    return "user list";
}

6. 高级用法与注意事项

复杂场景下的应用：在处理嵌套对象或JSON格式的数据时，@RequestParam 可能不太适用。此时可以考虑使用 @RequestBody 注解来直接映射请求体到对象。
常见问题及解决方法：
- 类型转换失败：确保传递给 @RequestParam 的参数类型能够正确转换。例如，尝试将字符串转换为整数时，如果字符串格式不正确，会导致错误。
- 参数缺失或错误命名：确保请求中提供的参数名称与控制器方法中使用的名称相匹配，并根据需要设置 required 和 defaultValue 属性。