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

推荐答案

@SessionAttribute 注解用于将模型属性存储在 HTTP 会话中，以便在多个请求之间共享数据。它通常用于在控制器方法之间传递数据，特别是在处理多步骤表单或需要在多个请求中保持状态的场景中。

本题详细解读

1. @SessionAttribute 的基本用法

@SessionAttribute 注解可以用于控制器类或方法上。当用于控制器类时，它会将该类中所有方法共享的模型属性存储在会话中。当用于方法时，它只会将该方法中的特定模型属性存储在会话中。

// www.javascriptcn.com code example
@Controller
@SessionAttributes("user")
public class UserController {

    @ModelAttribute("user")
    public User getUser() {
        return new User();
    }

    @PostMapping("/register")
    public String register(@ModelAttribute("user") User user) {
        // 处理注册逻辑
        return "redirect:/confirm";
    }

    @GetMapping("/confirm")
    public String confirm(@ModelAttribute("user") User user, Model model) {
        model.addAttribute("user", user);
        return "confirm";
    }
}

在上面的例子中，@SessionAttributes("user") 注解将 user 属性存储在会话中，使得在 /register 和 /confirm 请求之间可以共享 user 对象。

2. @SessionAttribute 与 @ModelAttribute 的区别

• @ModelAttribute 用于将请求参数绑定到模型属性，并且该属性仅在当前请求中有效。
• @SessionAttribute 用于将模型属性存储在会话中，使得该属性可以在多个请求之间共享。

3. @SessionAttribute 的清除

默认情况下，@SessionAttribute 存储的属性会一直存在于会话中，直到会话结束。如果需要手动清除这些属性，可以使用 SessionStatus 对象的 setComplete() 方法。

@PostMapping("/complete")
public String complete(SessionStatus sessionStatus) {
    sessionStatus.setComplete();
    return "redirect:/home";
}

在这个例子中，调用 sessionStatus.setComplete() 会清除所有通过 @SessionAttributes 存储在会话中的属性。

4. 使用场景

@SessionAttribute 通常用于以下场景：

• 多步骤表单处理：在多个请求中保持表单数据。
• 购物车功能：在用户浏览商品时保持购物车状态。
• 用户会话管理：在用户登录后保持用户信息。

通过合理使用 @SessionAttribute，可以有效地管理跨请求的数据共享和状态保持。