@SessionAttributes 和 @SessionAttribute的差別

@SessionAttributes 和 @SessionAttribute的差別

Spring MVC中有兩個長得非常像的注解：@SessionAttributes 和 @SessionAttribute。

我們先看下@SessionAttributes的定義：

@SessionAttributes用于在請求之間的HTTP Servlet會話中存儲model屬性。 它是類型級别的注解，用于聲明特定控制器使用的會話屬性。 這通常列出應透明地存儲在會話中以供後續通路請求的模型屬性的名稱或模型屬性的類型。

舉個例子：

@SessionAttributes("user")
public class LoginController {

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

我們可以看到@SessionAttributes是類注解，他用來在session中存儲model。 如上面的例子，我們定義了一個名為“User”的model并把它存儲在Session中。

我們再看一下@SessionAttribute的定義：

如果您需要通路全局存在（例如，在控制器外部（例如，通過過濾器）管理）并且可能存在或可能不存在的預先存在的會話屬性，則可以在方法參數上使用@SessionAttribute注釋，例如 以下示例顯示：

@Controller
@RequestMapping("/user")
public class UserController {

   /*
    * Get user from session attribute
    */
   @GetMapping("/info")
   public String userInfo(@SessionAttribute("user") User user) {

      System.out.println("Email: " + user.getEmail());
      System.out.println("First Name: " + user.getFname());

      return "user";
   }
}
           

@SessionAttribute隻是擷取存儲在session中的屬性。如果要設定（添加删除）session的屬性，則要考慮将org.springframework.web.context.request.WebRequest或javax.servlet.http.HttpSession注入到控制器方法中。

@SessionAttributes中綁定的model可以通過如下幾個途徑擷取：

• 在視圖中通過request.getAttribute或session.getAttribute擷取
• 在後面請求傳回的視圖中通過session.getAttribute或者從model中擷取
• 自動将參數設定到後面請求所對應處理器的Model類型參數或者有@ModelAttribute注釋的參數裡面。

@SessionAttributes使用者後可以調用SessionStatus.setComplete來清除，這個方法隻是清除SessionAttribute裡的參數，而不會應用Session中的參數。

@Controller
@SessionAttributes("pet") 
public class EditPetForm {

    // ...

    @PostMapping("/pets/{id}")
    public String handle(Pet pet, BindingResult errors, SessionStatus status) {
        if (errors.hasErrors) {
            // ...
        }
            status.setComplete(); 
            // ...
        }
    }
}
           

總結一下：

@SessionAttributes 是将model設定到session中去。

@SessionAttribute 是從session擷取之前設定到session中的資料。

更多教程請參考 flydean的部落格