Spring MVC 操作會話屬性詳解（@SessionAttributes 與 @SessionAttribute）

---

1. 核心注解對比

注解	作用范圍	功能
@SessionAttributes	類級別	聲明控制器中需要持久化的模型屬性（存入 HttpSession）
@SessionAttribute	方法參數/返回值	顯式綁定方法參數或返回值到 HttpSession（已棄用，推薦使用 @SessionAttributes）

---

2. @SessionAttributes 詳解

作用：在控制器類上標注，聲明哪些模型屬性需要被保存到會話中，跨請求共享。

---

2.1 基本用法

@Controller
@SessionAttributes({ "user", "cart" }) // 保存名為 "user" 和 "cart" 的屬性
public class UserController {// 方法中添加到 Model 的屬性會被自動保存到會話
}

---

2.2 參數選項

屬性	作用
value	指定要持久化的模型屬性名稱（字符串數組）
types	指定要持久化的屬性類型（Class 對象數組），滿足類型即會被保存

示例：按類型保存所有 Cart 類型的屬性：

@SessionAttributes(types = { Cart.class })

---

2.3 生命周期管理

• 添加屬性：通過 Model 接口添加到模型：

  @GetMapping("/login")
  public String login(@ModelAttribute User user, Model model) {model.addAttribute("user", user); // 自動持久化到會話return "redirect:/home";
  }
  

• 移除屬性：通過 SessionStatus 接口：

  @PostMapping("/logout")
  public String logout(SessionStatus status) {status.setComplete(); // 清除所有 @SessionAttributes 標記的屬性return "redirect:/login";
  }
  

---

3. @SessionAttribute 詳解

作用：直接從 HttpSession 獲取屬性作為方法參數（已棄用，建議改用 @SessionAttributes）。

---

3.1 基本用法

@GetMapping("/profile")
public String showProfile(@SessionAttribute("user") User user, // 直接從會話獲取 "user" 屬性Model model
) {model.addAttribute("user", user);return "profile";
}

---

3.2 注意事項

• 已棄用：Spring 官方推薦通過 @SessionAttributes 管理會話屬性，而非直接使用 @SessionAttribute。
• 替代方案：通過 @Autowired 注入 HttpSession 對象：

  @Autowired
  private HttpSession session;@GetMapping("/cart")
  public String getCart() {Cart cart = (Cart) session.getAttribute("cart");// ...
  }
  

---

4. 完整代碼示例

---

4.1 使用 @SessionAttributes 的控制器

@Controller
@SessionAttributes("user") // 持久化 "user" 屬性
public class UserController {@GetMapping("/login")public String loginPage() {return "login";}@PostMapping("/login")public String loginSubmit(@ModelAttribute User user,Model model) {model.addAttribute("user", user); // 自動保存到會話return "redirect:/home";}@GetMapping("/home")public String home(@ModelAttribute("user") User user, // 從會話獲取Model model) {model.addAttribute("user", user); // 保持會話屬性return "home";}@GetMapping("/logout")public String logout(SessionStatus status) {status.setComplete(); // 清除 "user" 屬性return "redirect:/login";}
}

---

4.2 使用 HttpSession 直接操作

@Controller
public class CartController {@Autowiredprivate HttpSession session;@GetMapping("/addToCart/{productId}")public String addToCart(@PathVariable String productId) {Cart cart = (Cart) session.getAttribute("cart");if (cart == null) {cart = new Cart();session.setAttribute("cart", cart); // 手動保存}cart.addProduct(productId);return "redirect:/cart";}
}

---

5. 對比表格：@SessionAttributes 與 @SessionAttribute

對比項	@SessionAttributes	@SessionAttribute
作用范圍	類級別（聲明持久化規則）	方法參數/返回值（直接綁定）
推薦程度	推薦（符合 Spring MVC 設計模式）	已棄用（建議改用 @SessionAttributes）
生命周期管理	自動管理（通過 Model 和 SessionStatus）	需手動操作會話（不推薦直接使用）
靈活性	支持按名稱或類型持久化	僅支持按名稱獲取參數

---

6. 常見問題

---

Q1：如何清除單個 @SessionAttributes 屬性？

A：通過 SessionStatus 的 setComplete() 會清除所有標記的屬性。若需清除單個屬性，需直接操作 HttpSession：

session.removeAttribute("user");

Q2：如何避免會話屬性內存泄漏？

A：

1. 在用戶退出時顯式清除屬性（如調用 logout 方法）。
2. 配置 HttpSession 的超時時間（web.xml 或 Spring Security）。
3. 對敏感數據及時清理。

Q3：@SessionAttributes 是否支持類型匹配？

A：是的，通過 types 參數指定類型，例如：

@SessionAttributes(types = { Cart.class, User.class })

Q4：能否在 RESTful API 中使用會話屬性？

A：可以，但需注意：

• REST 通常要求無狀態，會話屬性可能破壞這一原則。
• 若需跨請求共享數據，建議改用 Token 或數據庫存儲。

---

7. 總結

• 推薦實踐：
  1. 使用 @SessionAttributes 聲明需要持久化的模型屬性，通過 Model 接口操作。
  2. 避免直接使用 @SessionAttribute（已棄用），改用 HttpSession 或 @SessionAttributes。
  3. 對會話屬性的生命周期進行嚴格管理，避免內存泄漏。

通過合理使用會話屬性，可以實現用戶狀態的跨請求保持（如登錄狀態、購物車），但需權衡會話存儲的性能和安全性。