SpringMVC中的session用法及细节记录 – Rebuilding127

前言

初学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 }

 

测试过程简单说明:

因为参数比较多,所以我也是懒得想名字,序列化的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的键值对比较好。当然,具体情况还是要具体分析的。

 

最后,感谢下在查找资料过程中我认为比较有用的博主提供的博文资料,有兴趣的同学也可以去看看。

Spring MVC中Session的正确用法之我见

Spring MVC @SessionAttributes注解

 


 

以上文章为本人根据官方及他人资料总结原创,仅供学习交流使用,代码实测可用。

 



You must enable javascript to see captcha here!

Copyright © All Rights Reserved · Green Hope Theme by Sivan & schiy · Proudly powered by WordPress

无觅相关文章插件,快速提升流量