前言
初學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包。
|
1
2
3
4
5
6
7
8
9
10
11
|
<!-- 使用@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
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
package test.dmh.session;import java.util.Enumeration;import javax.servlet.http.HttpSession;import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.stereotype.Controller;import org.springframework.ui.Model;import org.springframework.ui.ModelMap;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.SessionAttributes;import org.springframework.web.bind.support.SessionStatus;/** * @SessionAttributes 只聲明了參數test1 */@Controller@SessionAttributes(value={"test1"})public class HomeController { private static final Logger logger = LoggerFactory.getLogger(HomeController.class); @RequestMapping(value = "/show1") public String show(ModelMap modelMap, HttpSession session) { logger.info("show session"); for (Object key : modelMap.keySet()) { Object value = modelMap.get(key); System.out.println(key + " = " + value); } System.out.println("***********************************"); Enumeration<String> e = session.getAttributeNames(); while (e.hasMoreElements()) { String s = e.nextElement(); System.out.println(s + " == " + session.getAttribute(s)); } System.out.println("***********************************"); return "home"; } @RequestMapping("/set1") public String setSession(ModelMap modelMap) { logger.info("set session 1"); modelMap.addAttribute("test1", "value 1"); //設置一個在@SessionAttributes中聲明過的參數 modelMap.addAttribute("test2", "value 2"); //設置一個未在@SessionAttributes中聲明過的參數 return "home"; } @RequestMapping("/setM") public String setSessionM(Model model) { logger.info("set session 1"); model.addAttribute("test1", "value 1"); //設置一個在@SessionAttributes中聲明過的參數 model.addAttribute("test2", "value 2"); //設置一個未在@SessionAttributes中聲明過的參數 return "home"; } @RequestMapping("/clear1") public String clear(SessionStatus status) { logger.info("clear session 1"); status.setComplete(); return "home"; } } |
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
|
package test.dmh.session.controller;import javax.servlet.http.HttpSession;import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.stereotype.Controller;import org.springframework.ui.ModelMap;import org.springframework.web.bind.annotation.RequestMapping;/** * 沒有使用@SessionAttributes注解 */@Controllerpublic class IndexController { private static final Logger logger = LoggerFactory.getLogger(IndexController.class); @RequestMapping("/set2") public String setSession(ModelMap modelMap, HttpSession session) { logger.info("set session 2 : without @SessionAttributes"); modelMap.addAttribute("test3", "value 3"); session.setAttribute("test4", "value 4"); return "home"; } } |
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
package test.dmh.session.controller;import java.util.Enumeration;import java.util.HashMap;import java.util.Map;import javax.servlet.http.HttpSession;import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.stereotype.Controller;import org.springframework.ui.ModelMap;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.ResponseBody;import org.springframework.web.bind.annotation.SessionAttributes;import org.springframework.web.bind.support.SessionStatus;@Controller@SessionAttributes(value={"test5", "index"})public class IndexController2 { private static final Logger logger = LoggerFactory.getLogger(IndexController2.class); @RequestMapping("/set3") public String setSession(ModelMap modelMap, HttpSession session) { logger.info("set session 3"); modelMap.addAttribute("test5", "value 5"); session.setAttribute("test6", "value 6"); ModelMap map = new ModelMap(); map.addAttribute("test7", "value 7"); this.setValueToSession(modelMap, session, "Hello World"); return "home"; } @ResponseBody @RequestMapping(value="/login") public Map<String, Object> login(ModelMap modelMap, HttpSession session) { logger.info("login"); Map<String, Object> map = new HashMap<String, Object>(); map.put("success", true); map.put("info", "登錄成功！"); modelMap.addAttribute("testAjax", "test ajax value"); session.setAttribute("httpTestAjax", "http test ajax Value"); setValueToSession(modelMap, session, "This is Ajax"); return map; } private void setValueToSession(ModelMap modelMap, HttpSession session, String value) { logger.info("set session private"); modelMap.addAttribute("index", value); session.setAttribute("httpIndex", value); } @RequestMapping("/clear2") public String clear(SessionStatus status) { logger.info("clear session 2"); status.setComplete(); return "home"; } @RequestMapping(value = "/show2") public String show(ModelMap modelMap, HttpSession session) { logger.info("show session"); for (Object key : modelMap.keySet()) { Object value = modelMap.get(key); System.out.println(key + " = " + value); } System.out.println("***********************************"); Enumeration<String> e = session.getAttributeNames(); while (e.hasMoreElements()) { String s = e.nextElement(); System.out.println(s + " == " + session.getAttribute(s)); } System.out.println("***********************************"); return "home"; } } |
這里如果也是跟我一樣用STS建的項目，默認jsp文件會有配置<%@ page session="false" %>，一定要刪除或者注釋掉。否則無法在頁面上展示session中的數據，當然通過我這邊寫的/show測試直接看后臺代碼也是可以的。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
|
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>4 <html><head> <title>Home</title></head><body><h1> Hello world! </h1><p> The test1 is ${sessionScope.test1}. </p><p> The test2 is ${sessionScope.test2}. </p><p> The test3 is ${sessionScope.test3}. </p><p> The test4 is ${sessionScope.test4}. </p><p> The test5 is ${sessionScope.test5}. </p><p> The test6 is ${sessionScope.test6}. </p><p> The test7 is ${sessionScope.test7}. </p><p> The index is ${sessionScope.index}. </p><p> The httpIndex is ${sessionScope.httpIndex}. </p><br><input type="button" value="test" onclick="test();"><script src="resources/js/jquery.min.js"></script><script type="text/javascript">function test() { $.ajax({ type : "POST", url : "login", dataType : "json", success : function(data) { console.log(data); window.open("/session/test", "_self"); }, error : function() { alert("出錯了！"); } });}</script></body></html> |
另外還有一個特別針對@SessionAttributes參數配置的測試代碼
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
package test.dmh.session.controller;import java.util.Enumeration;import javax.servlet.http.HttpSession;import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.stereotype.Controller;import org.springframework.ui.ModelMap;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.SessionAttributes;import org.springframework.web.bind.support.SessionStatus;@Controller@SessionAttributes(value={"index1", "index2"}, types={String.class, Integer.class})public class IndexController3 { private static final Logger logger = LoggerFactory.getLogger(IndexController3.class); @RequestMapping("/setIndex") public String setSession(ModelMap modelMap) { logger.info("set session index"); modelMap.addAttribute("index1", "aaa"); modelMap.addAttribute("index2", "bbb"); modelMap.addAttribute("index2", "ccc"); modelMap.addAttribute("DDD"); modelMap.addAttribute("FFF"); modelMap.addAttribute(22); return "home"; } @RequestMapping(value = "/showIndex") public String show(ModelMap modelMap, HttpSession session) { logger.info("show session"); for (Object key : modelMap.keySet()) { Object value = modelMap.get(key); System.out.println(key + " = " + value); } System.out.println("***********************************"); Enumeration<String> e = session.getAttributeNames(); while (e.hasMoreElements()) { String s = e.nextElement(); System.out.println(s + " == " + session.getAttribute(s)); } System.out.println("***********************************"); return "home"; } @RequestMapping("/clearIndex") public String clear(SessionStatus status) { logger.info("clear session index"); status.setComplete(); return "home"; } } |
測試過程簡單說明：
因為參數比較多，所以我也是懶得想名字，序列化的test1、2、3過去了。
測試的時候就是在瀏覽器上輸入網址：http://localhost:8080/session/show1
然后把后綴show1改成別的，比如set1, set2以及clear1, clear2這些，具體的請看我代碼中的@RequestMapping配置。
每次輸入set1,set2這些以后，需要輸入show1,show2來通過控制臺查看session中的內容，當然直接在瀏覽器上看顯示信息也是可以的。
這邊我再說一下主要的幾個結論：
1、使用ModelMap自動保存數據到session必須配置@SessionAttributes注解
2、使用@SessionAttributes注解只能聲明在類上，聲明以后，該類中的方法操作session數據只能對@SessionAttributes中配置的參數起作用，包括保存、清除和讀取。
最后還有針對@SessionAttributes中的參數配置得出的幾點結論：
1、配置參數提供value和types，存放的都是數組類型。（只有1個參數時不需要寫成數組形式，比如@SessionAttributes(value="test1", types=Integer.class)）
2、使用value配置參數類似于Map的鍵值對中的key
3、實用types配置參數后，后臺保存的key就是它的類型，個人感覺只有在保存自定義類對象的時候有些用處，比如types=User.class，一般的常用類對象如String等我覺得還是用value的鍵值對比較好。當然，具體情況還是要具體分析的。
以上這篇淺談SpringMVC中的session用法及細節記錄就是小編分享給大家的全部內容了，希望能給大家一個參考，也希望大家多多支持服務器之家。
