【知识总结】@RequestParam和@ModelAttribute对比、区别、使用建议

Fivk

2023 年 12 月 05 日

1084 次浏览

暂无评论

1433字数

代码笔记

`@RequestParam`和`@ModelAttribute`都是Spring框架中用于处理请求参数的注解，但在具体的使用场景和功能上有一些区别。

## @RequestParam

`@RequestParam`注解用于从请求中获取单个或多个参数值。它主要用于将请求参数绑定到方法的参数上。该注解可以指定参数的名称、是否必需以及默认值。以下是`@RequestParam`的一些特点：

- 可以用在Controller的方法参数上，用于获取请求参数的值。
- 默认情况下，请求参数与方法参数同名进行绑定，可以通过`name`属性指定参数名。
- 可以通过`required`属性指定参数是否是必需的，默认为`true`。
- 可以通过`defaultValue`属性指定参数的默认值，在请求中没有提供该参数时会使用默认值。

示例代码如下：

```java
@GetMapping("/user")
public String getUser(@RequestParam("id") int userId) {
    // 处理业务逻辑
}
```

## @ModelAttribute

`@ModelAttribute`注解也用于从请求中获取参数值，但它更加强大，可以将请求中的多个参数绑定到一个对象上。该注解可以对类级别和方法级别进行标记，有以下特点：

- 类级别的`@ModelAttribute`注解用于在请求处理方法执行之前创建模型对象，并将其添加到模型中。
- 方法级别的`@ModelAttribute`注解用于将请求参数绑定到方法的参数或方法返回的模型属性上。
- 使用`@ModelAttribute`时，Spring会根据参数名称或属性名称自动进行绑定，也可以通过`name`属性指定参数名。

示例代码如下：

```java
@Controller
@RequestMapping("/users")
@SessionAttributes("user")
public class UserController {

@ModelAttribute("user")
    public User getUser(@RequestParam("id") int userId) {
        // 从数据库中获取用户信息
        User user = userService.getUserById(userId);
        return user;
    }

@GetMapping("/{id}")
    public String getUserPage(@ModelAttribute("user") User user) {
        // 显示用户信息页面
        return "user";
    }
}
```

使用建议：

- 当需要获取单个请求参数时，通常使用`@RequestParam`注解。
- 当需要将多个请求参数绑定到一个对象上时，使用`@ModelAttribute`注解更加方便。
- 可以同时使用`@RequestParam`和`@ModelAttribute`来完成不同的任务，根据具体需求选择最合适的注解。

最后修改：2023 年 12 月 05 日