SpringMVC中的session用法及細節記錄

本文轉載自查看原文 2017-04-30 18:06 4988 java/ session/ SessionAttributes/ SpringMVC/ springmvc

前言

初學SpringMVC，最近在給公司做的系統做登錄方面，需要用到session。

在網上找了不少資料，大致提了2點session保存方式：

1、javaWeb工程通用的HttpSession

2、SpringMVC特有的@SessionAttributes

我個人比較關注@SessionAttributes的用法，畢竟現在是在用SpringMVC嘛。但是我看網上那些文章，基本都是只說明了基礎用法，詳細的使用和細節卻基本沒有，我想這是不夠的，所以我自己做了一些測試，然后整理了下代碼做了個demo，記錄並分享下，有什么不足的歡迎提出來討論。

好了，廢話就說到這，下面正戲開始！

結論

嗯，為了給一些不喜歡看代碼的客官省去翻結論的麻煩，我這里就先把我測試后的結論先列一下吧。

1、可以通過SpringMVC特有的ModelMap、Model在Controller中自動保存數據到session，也可以通過傳統的HttpSession等參數保存session數據

2、保存session數據必須使用@SessionAttributes注解，該注解有2種參數聲明方式（value和types），且該注解聲明必須寫在類上，不能在方法上

3、保存的session數據必須與@SessionAttributes注解中的參數列表對應，未被聲明的參數無法保存到session中

4、使用SessionStatus可以清除session中保存的數據，注意是全部清除，無法單獨刪除指定的session數據。同時，清除時有效權限遵循上述第2、3條規則（借用此規則可人為達到刪除指定session數據的效果）

5、通過ModelMap等讀取session中數據時，也有上述的參數權限限制

6、使用ModelMap或Model等保存session數據時，ModelMap必須作為方法參數傳入，在方法中新定義的無效。同時，只要把ModelMap作為參數傳入，即使是被別的方法調用也能起效

7、使用@ResponseBody注解時（一般配合ajax使用），無法保存session數據

8、@SessionAttributes注解可以使用value和types 2種參數列表

9、使用HttpSession的傳統方式操作沒有上述注解及權限等限制，下面有簡單測試，但是不做具體說明

以下還有幾個應該算是常識性的知識點

10、操作session數據可以跨類，與包或者url的路徑等也沒有關系

11、同一個session值操作，后面的值會覆蓋前面的值

測試代碼及簡單說明

開發工具： Spring Tool Suite 。

spring專為SpringMVC搞出來的一款基於Eclipse的IDE開發工具，集成了Maven和Tomcat，最近用下來感覺還不錯的，推薦下。

首先來一個項目結構截圖吧

因為后面的測試中有用到ajax的@ResponseBody注解，所以要在pom.xml文件中配置jar包。

<!-- 使用@ResponseBody注解所需的2個包 -->
<dependency>
    <groupId>org.codehaus.jackson</groupId>
    <artifactId>jackson-core-asl</artifactId>
    <version>1.9.13</version>
</dependency>
<dependency>
    <groupId>org.codehaus.jackson</groupId>
    <artifactId>jackson-mapper-asl</artifactId>
    <version>1.9.13</version>
</dependency>

下面是主要的測試代碼

 1 package test.dmh.session;
 2 
 3 import java.util.Enumeration;
 4 
 5 import javax.servlet.http.HttpSession;
 6 
 7 import org.slf4j.Logger;
 8 import org.slf4j.LoggerFactory;
 9 import org.springframework.stereotype.Controller;
10 import org.springframework.ui.Model;
11 import org.springframework.ui.ModelMap;
12 import org.springframework.web.bind.annotation.RequestMapping;
13 import org.springframework.web.bind.annotation.SessionAttributes;
14 import org.springframework.web.bind.support.SessionStatus;
15 
16 /**
17  * @SessionAttributes 只聲明了參數test1
18  */
19 @Controller
20 @SessionAttributes(value={"test1"})
21 public class HomeController {
22     
23     private static final Logger logger = LoggerFactory.getLogger(HomeController.class);
24     
25     @RequestMapping(value = "/show1")
26     public String show(ModelMap modelMap, HttpSession session) {
27         logger.info("show session");
28         for (Object key : modelMap.keySet()) {
29             Object value = modelMap.get(key);
30             System.out.println(key + " = " + value);
31         }
32         System.out.println("***********************************");
33         Enumeration<String> e = session.getAttributeNames();
34         while (e.hasMoreElements()) {
35             String s = e.nextElement();
36             System.out.println(s + " == " + session.getAttribute(s));
37         }
38         System.out.println("***********************************");
39         return "home";
40     }
41     
42     @RequestMapping("/set1")
43     public String setSession(ModelMap modelMap) {
44         logger.info("set session 1");
45         modelMap.addAttribute("test1", "value 1"); //設置一個在@SessionAttributes中聲明過的參數
46         modelMap.addAttribute("test2", "value 2"); //設置一個未在@SessionAttributes中聲明過的參數
47         return "home";
48     }
49     
50     @RequestMapping("/setM")
51     public String setSessionM(Model model) {
52         logger.info("set session 1");
53         model.addAttribute("test1", "value 1"); //設置一個在@SessionAttributes中聲明過的參數
54         model.addAttribute("test2", "value 2"); //設置一個未在@SessionAttributes中聲明過的參數
55         return "home";
56     }
57     
58     @RequestMapping("/clear1")
59     public String clear(SessionStatus status) {
60         logger.info("clear session 1");
61         status.setComplete();
62         return "home";
63     }
64     
65 }

 1 package test.dmh.session.controller;
 2 
 3 import javax.servlet.http.HttpSession;
 4 
 5 import org.slf4j.Logger;
 6 import org.slf4j.LoggerFactory;
 7 import org.springframework.stereotype.Controller;
 8 import org.springframework.ui.ModelMap;
 9 import org.springframework.web.bind.annotation.RequestMapping;
10 
11 /**
12  *    沒有使用@SessionAttributes注解
13  */
14 @Controller
15 public class IndexController {
16     
17     private static final Logger logger = LoggerFactory.getLogger(IndexController.class);
18     
19     @RequestMapping("/set2")
20     public String setSession(ModelMap modelMap, HttpSession session) {
21         logger.info("set session 2 : without @SessionAttributes");
22         modelMap.addAttribute("test3", "value 3");
23         session.setAttribute("test4", "value 4");
24         return "home";
25     }
26     
27 }

 1 package test.dmh.session.controller;
 2 
 3 import java.util.Enumeration;
 4 import java.util.HashMap;
 5 import java.util.Map;
 6 
 7 import javax.servlet.http.HttpSession;
 8 
 9 import org.slf4j.Logger;
10 import org.slf4j.LoggerFactory;
11 import org.springframework.stereotype.Controller;
12 import org.springframework.ui.ModelMap;
13 import org.springframework.web.bind.annotation.RequestMapping;
14 import org.springframework.web.bind.annotation.ResponseBody;
15 import org.springframework.web.bind.annotation.SessionAttributes;
16 import org.springframework.web.bind.support.SessionStatus;
17 
18 @Controller
19 @SessionAttributes(value={"test5", "index"})
20 public class IndexController2 {
21     
22     private static final Logger logger = LoggerFactory.getLogger(IndexController2.class);
23     
24     @RequestMapping("/set3")
25     public String setSession(ModelMap modelMap, HttpSession session) {
26         logger.info("set session 3");
27         modelMap.addAttribute("test5", "value 5");
28         session.setAttribute("test6", "value 6");
29         
30         ModelMap map = new ModelMap();
31         map.addAttribute("test7", "value 7");
32         
33         this.setValueToSession(modelMap, session, "Hello World");
34         
35         return "home";
36     }
37     
38     @ResponseBody
39     @RequestMapping(value="/login")
40     public Map<String, Object> login(ModelMap modelMap, HttpSession session) {
41         logger.info("login");
42         
43         Map<String, Object> map = new HashMap<String, Object>();
44         
45         map.put("success", true);
46         map.put("info", "登錄成功！");
47         
48         modelMap.addAttribute("testAjax", "test ajax value");
49         session.setAttribute("httpTestAjax", "http test ajax Value");
50         
51         setValueToSession(modelMap, session, "This is Ajax");
52         
53         return map;
54     }
55     
56     private void setValueToSession(ModelMap modelMap, HttpSession session, String value) {
57         logger.info("set session private");
58         modelMap.addAttribute("index", value);
59         session.setAttribute("httpIndex", value);
60     }
61     
62     @RequestMapping("/clear2")
63     public String clear(SessionStatus status) {
64         logger.info("clear session 2");
65         status.setComplete();
66         return "home";
67     }
68     
69     @RequestMapping(value = "/show2")
70     public String show(ModelMap modelMap, HttpSession session) {
71         logger.info("show session");
72         for (Object key : modelMap.keySet()) {
73             Object value = modelMap.get(key);
74             System.out.println(key + " = " + value);
75         }
76         System.out.println("***********************************");
77         Enumeration<String> e = session.getAttributeNames();
78         while (e.hasMoreElements()) {
79             String s = e.nextElement();
80             System.out.println(s + " == " + session.getAttribute(s));
81         }
82         System.out.println("***********************************");
83         return "home";
84     }
85     
86 }

這里如果也是跟我一樣用STS建的項目，默認jsp文件會有配置<%@ page session="false" %>，一定要刪除或者注釋掉。否則無法在頁面上展示session中的數據，當然通過我這邊寫的/show測試直接看后台代碼也是可以的。

 1 <%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
 2 <%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
 3 4 <html>
 5 <head>
 6     <title>Home</title>
 7 </head>
 8 <body>
 9 <h1>
10     Hello world!  
11 </h1>
12 
13 <p>  The test1 is ${sessionScope.test1}. </p>
14 <p>  The test2 is ${sessionScope.test2}. </p>
15 <p>  The test3 is ${sessionScope.test3}. </p>
16 <p>  The test4 is ${sessionScope.test4}. </p>
17 <p>  The test5 is ${sessionScope.test5}. </p>
18 <p>  The test6 is ${sessionScope.test6}. </p>
19 <p>  The test7 is ${sessionScope.test7}. </p>
20 <p>  The index is ${sessionScope.index}. </p>
21 <p>  The httpIndex is ${sessionScope.httpIndex}. </p>
22 
23 <br>
24 <input type="button" value="test" onclick="test();">
25 
26 <script src="resources/js/jquery.min.js"></script>
27 <script type="text/javascript">
28 function test() {
29     $.ajax({
30         type : "POST",
31         url : "login",
32         dataType : "json",
33         success : function(data) {
34             console.log(data);
35             window.open("/session/test", "_self");
36         },
37         error : function() {
38             alert("出錯了！");
39         }
40     });
41 }
42 </script>
43 
44 
45 </body>
46 </html>

另外還有一個特別針對@SessionAttributes參數配置的測試代碼

 1 package test.dmh.session.controller;
 2 
 3 import java.util.Enumeration;
 4 
 5 import javax.servlet.http.HttpSession;
 6 
 7 import org.slf4j.Logger;
 8 import org.slf4j.LoggerFactory;
 9 import org.springframework.stereotype.Controller;
10 import org.springframework.ui.ModelMap;
11 import org.springframework.web.bind.annotation.RequestMapping;
12 import org.springframework.web.bind.annotation.SessionAttributes;
13 import org.springframework.web.bind.support.SessionStatus;
14 
15 @Controller
16 @SessionAttributes(value={"index1", "index2"}, types={String.class, Integer.class})
17 public class IndexController3 {
18     
19     private static final Logger logger = LoggerFactory.getLogger(IndexController3.class);
20     
21     @RequestMapping("/setIndex")
22     public String setSession(ModelMap modelMap) {
23         logger.info("set session index");
24         modelMap.addAttribute("index1", "aaa");
25         modelMap.addAttribute("index2", "bbb");
26         modelMap.addAttribute("index2", "ccc");
27         modelMap.addAttribute("DDD");
28         modelMap.addAttribute("FFF");
29         modelMap.addAttribute(22);
30         
31         return "home";
32     }
33     
34     @RequestMapping(value = "/showIndex")
35     public String show(ModelMap modelMap, HttpSession session) {
36         logger.info("show session");
37         for (Object key : modelMap.keySet()) {
38             Object value = modelMap.get(key);
39             System.out.println(key + " = " + value);
40         }
41         System.out.println("***********************************");
42         Enumeration<String> e = session.getAttributeNames();
43         while (e.hasMoreElements()) {
44             String s = e.nextElement();
45             System.out.println(s + " == " + session.getAttribute(s));
46         }
47         System.out.println("***********************************");
48         return "home";
49     }
50     
51     @RequestMapping("/clearIndex")
52     public String clear(SessionStatus status) {
53         logger.info("clear session index");
54         status.setComplete();
55         return "home";
56     }
57     
58 }