在Spring Controller中将数据缓存到session

Servlet方案

在Controller的方法的参数列表中，添加一个javax.servlet.http.HttpSession类型的形参。spring mvc会 自动把当前session对象注入这个参数，此后可以使用setAttribute(String key, Object value)将数据缓存到session，使用removeAttribute( String key)将指定的数据从session缓存中移除。

 package cn.sinobest.jzpt.demo.login.web;
 import javax.servlet.http.HttpSession;
 import org.springframework.stereotype.Controller;
 import org.springframework.ui.Model;
 import org.springframework.web.bind.annotation.RequestMapping;
 /**
  * 登陆相关Controller.<br>
  * H - HttpSession.
  * @author lijinlong
  *
  */
 @Controller
 @RequestMapping("demo/h_login")
 public class HLoginController {

     @RequestMapping("/login")
     public String login(Model model, String username, HttpSession session) {
         Logger.logger.debug("in HLoginController.login...");
         String currUsername = session.getAttribute("username") == null ? null
                 : session.getAttribute("username").toString();
             // 尝试从session中获取username数据。

         boolean usernameIsNull = username == null || username.isEmpty();
         boolean currunIsNull = currUsername == null || currUsername.isEmpty();
         if (usernameIsNull && currunIsNull) {
             return View.VIEW_LOGIN;
         }

         if (!usernameIsNull) {
             session.setAttribute("username", username);
                 // 将username缓存到session中。
         }
         return View.VIEW_LOGOUT;
     }

     /**
      * 注销.
      * @param model
      * @param session
      * @return
      */
     @RequestMapping("/logout")
     public String logout(Model model, HttpSession session) {
         Logger.logger.debug("in HLoginController.logout...");
         session.removeAttribute("username");
             // 将username从session中移除。
         return View.VIEW_LOGIN;
     }
 }

LoginController.java

Spring方案

spring mvc提供了内嵌的支持方案：

1. 将数据缓存到session
   对Controller使用org.springframework.web.bind.annotation.SessionAttributes注解，可以将指定名称 或者 类型的数据，在model.addAttribute( String key,  Object value)时，缓存到session中。
2. 清除session中的数据
   调用org.springframework.web.bind.support.SessionStatus实例的setComplete()，在方法的参数列表中声明SessionStatus类型的参数，会被自动注入。

 package cn.sinobest.jzpt.demo.login.web;
 import org.springframework.stereotype.Controller;
 import org.springframework.ui.Model;
 import org.springframework.web.bind.annotation.ModelAttribute;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.SessionAttributes;
 import org.springframework.web.bind.support.SessionStatus;
 /**
  * 登陆相关Controller.<br>
  * S - Spring Session.
  * @author lijinlong
  *
  */
 @Controller
 @RequestMapping("demo/s_login")
 @SessionAttributes("username") // 指定了key为username的数据，会被放入session中。
 public class SLoginController {
     @RequestMapping("/login")
     public String login(Model model, String username) {
         Logger.logger.debug("in SLoginController.login...");
         String currUsername = model.asMap().get("username") == null ? null
                 : model.asMap().get("username").toString();
             // 尝试从session中获取username（spring mvc会自动把session中的数据装载到model中）。

         boolean usernameIsNull = username == null || username.isEmpty();
         boolean currunIsNull = currUsername == null || currUsername.isEmpty();
         if (usernameIsNull && currunIsNull) {
             return View.VIEW_LOGIN;
         }

         if (!usernameIsNull) {
             model.addAttribute("username", username);
                 // username会被放入session中（key和@SessionAttributes的参数匹配）。
         }
         return View.VIEW_LOGOUT;
     }

     @RequestMapping("/logout")
     public String logout(SessionStatus status,
             @ModelAttribute("username") String currUsername) {
         Logger.logger.debug("in SLoginController.logout...");
         Logger.logger.debug("current user is:" + currUsername);
         status.setComplete();
             // 清除session中的attribute
         return View.VIEW_LOGIN;
     }
 }

LoginController

SessionAttributes的使用方法

• 匹配单一的key
   @SessionAttributes("username") // 匹配key=username的数据
• 匹配key数组
   @SessionAttributes({"username", "password"}) // 匹配key=username或者password的数据

• 匹配单一类
   @SessionAttributes(types=String.class) // 匹配String类型的数据

• 匹配类数组
   @SessionAttributes(types={String.class, List.class}) // 匹配String类型或List类型的数据
• 混合匹配
   @SessionAttributes(value={"username", "password"}, types={String.class, List.class})

ModelAttribute

使用ModelAttribute，可以自动将session中指定的参数注入到方法的形参；但是如果session中没有指定的参数，会抛出异常：
org.springframework.web.HttpSessionRequiredException: Session attribute 'username' required - not found in session

Model中的数据

Spring 会把Session中的数据装载到Model中，所以使用model.asMap().get("username")可以获取 session中的数据。返回页面前，spring会把Model中的数据放入requestScope，所以在页面可以使 用${requestScope.username}来获取数据。