spring session和Redis数据库实现单点登录功能

概述

本文主要介绍利用spring session和Redis数据库实现单点登录功能。介绍了Spring session 的使用，包括从jar 包的导入，redis 数据库的配置，spring session配置文件的编写，到最后单点登录功能的实现。

实现过程

在Web项目开发中，会话管理是一个很重要的部分，用于存储与用户相关的数据。通常是由符合session规范的容器来负责存储管理，也就是一旦容器关闭，重启会导致会话失效。因此打造一个高可用性的系统，必须将session管理从容器中独立出来。而spring-session就提供了这样一个功能，可以理解spring-session是替换了Servlet那一套会话管理，既不依赖容器，又不需要改动代码，并且是用了spring-data-redis那一套连接池。在一个maven工程中实现session共享，主要有以下几个步骤（当然，前提是项目要使用Spring Framework）。

导入相关jar包

[html]  view plain  copy

1. <!-- https://mvnrepository.com/artifact/org.springframework.session/spring-session -->  
2. <dependency>  
3.     <groupId>org.springframework.session</groupId>  
4.     <artifactId>spring-session</artifactId>  
5.     <version>1.2.0.RELEASE</version>  
6. </dependency>  
7. <!-- https://mvnrepository.com/artifact/com.orange.redis-embedded/embedded-redis -->  
8. <dependency>  
9.     <groupId>com.orange.redis-embedded</groupId>  
10.     <artifactId>embedded-redis</artifactId>  
11.     <version>0.6</version>  
12. </dependency>  
13. <!-- https://mvnrepository.com/artifact/org.springframework.session/spring-session-data-redis -->  
14. <dependency>  
15.     <groupId>org.springframework.session</groupId>  
16.     <artifactId>spring-session-data-redis</artifactId>  
17.     <version>1.2.1.RELEASE</version>  
18. </dependency>  
19. <!-- https://mvnrepository.com/artifact/redis.clients/jedis -->  
20. <dependency>  
21.     <groupId>redis.clients</groupId>  
22.     <artifactId>jedis</artifactId>  
23.     <version>2.8.1</version>  
24. </dependency>  

配置redis的连接池

确定好redis的ip和端口，然后在spring配置文件中引入

//hspaddress.properties

hsp.redis.host=localhost
hsp.redis.port=6379
hsp.redis.db=10

//spring-mvc.xml

<context:property-placeholder location="classpath:hspaddress.properties" ignore-unresolvable="true"/>

 配置spring-session（将session存储到redis数据库中）

分别在两个工程中添加spring-session.xml配置文件,因为配置文件的目的就是为了能够将session信息存储到redis,所有，配置文件都是一样的。

[html]  view plain  copy

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <beans xmlns="http://www.springframework.org/schema/beans"  
3.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"  
4.     xmlns:context="http://www.springframework.org/schema/context"  
5.     xmlns:mvc="http://www.springframework.org/schema/mvc"  
6.     xsi:schemaLocation="http://www.springframework.org/schema/beans  
7.                         http://www.springframework.org/schema/beans/spring-beans-3.1.xsd  
8.                         http://www.springframework.org/schema/context  
9.                         http://www.springframework.org/schema/context/spring-context-3.1.xsd  
10.                         http://www.springframework.org/schema/mvc  
11.                         http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd">  
12.     <context:annotation-config />  
13.     <!-- 引入配置文件 -->  
14.     <bean id="propertyConfigurer"  
15.         class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">  
16.         <property name="location" value="classpath:hspaddress.properties" />  
17.     </bean>  
18.     <bean id="redisHttpSessionConfiguration"  
19.         class="org.springframework.session.data.redis.config.annotation.web.http.RedisHttpSessionConfiguration">  
20.         <property name="maxInactiveIntervalInSeconds" value="3600" />  
21.     </bean>  
22.     <bean id="poolConfig" class="redis.clients.jedis.JedisPoolConfig" />  
23.     <bean id="jedisConnectionFactory"  
24.         class="org.springframework.data.redis.connection.jedis.JedisConnectionFactory">  
25.         <property name="port" value="${hsp.redis.port}" />  
26.         <property name="hostName" value="${hsp.redis.host}" />  
27.         <property name="database" value="${hsp.redis.db}" />  
28.     </bean>  
29.     <bean id="redisTemplate" class="org.springframework.data.redis.core.RedisTemplate">  
30.         <property name="connectionFactory" ref="jedisConnectionFactory"></property>  
31.         <property name="keySerializer">  
32.             <bean  
33.                 class="org.springframework.data.redis.serializer.StringRedisSerializer" />  
34.         </property>  
35.         <property name="valueSerializer">  
36.             <bean  
37.                 class="org.springframework.data.redis.serializer.StringRedisSerializer" />  
38.         </property>  
39.         <property name="hashKeySerializer">  
40.             <bean  
41.                 class="org.springframework.data.redis.serializer.StringRedisSerializer" />  
42.         </property>  
43.         <property name="hashValueSerializer">  
44.             <bean  
45.                 class="org.springframework.data.redis.serializer.StringRedisSerializer" />  
46.         </property>  
47.     </bean>  
48.     <bean id="defaultCookieSerializer"  
49.         class="org.springframework.session.web.http.DefaultCookieSerializer">  
50.         <property name="cookieName" value="HSP_SESSION_ID" />  
51.         <property name="cookiePath" value="/" />  
52.     </bean>  
53.     <bean id="cookieHttpSessionStrategy"  
54.         class="org.springframework.session.web.http.CookieHttpSessionStrategy">  
55.         <property name="cookieSerializer" ref="defaultCookieSerializer" />  
56.     </bean>  
57. </beans>  

在web.xml文件中添加一个session代理filter，这个filter要放在所有的filter链最前面

[html]  view plain  copy

1. <filter>  
2.     <filter-name>springSessionRepositoryFilter</filter-name>  
3.     <filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>  
4. </filter>  
5. <filter-mapping>  
6.     <filter-name>springSessionRepositoryFilter</filter-name>  
7.     <url-pattern>/*</url-pattern>  
8. </filter-mapping>  

测试

1、   到了这里，spring-session 配置已经基本完成。下面我们在controller中对用户登录进行验证，并且在用户session信息不存在的时候，将用户信息保存进session中，关键代码如下：

[java]  view plain  copy

1. @RequestMapping("/loginAuth")  
2. public String login(HttpServletRequest request, HttpServletResponse response,  
3.         @RequestParam Map<String, Object> params, Model model) throws UnsupportedEncodingException {  
4.     if (request.getSession().getAttribute("username") != null) {  
5.         logger.info("用户名：" + request.getSession().getAttribute("username").toString());  
6.         String userName = request.getSession().getAttribute("username").toString();  
7.         Map<String, String> user = UserUtils.getUserHap(userName);  
8.         if (user == null) {  
9.             request.setAttribute("info", "会话已失效,请重新登陆!");  
10.             logger.info(request.getAttribute("info"));  
11.             return "/login";  
12.         }  
13.         return "redirect:/";  
14.     }  
15.   
16.     if (params.get("userOid") == null || params.get("password") == null) {  
17.         return "/login";  
18.     }  
19.   
20.     String userName = params.get("userOid") == "" ? "" : params.get("userOid").toString();  
21.     String password = params.get("password") == "" ? "" : params.get("password").toString();  
22.     String url = params.get("url") == "" ? "" : params.get("url").toString();  
23.     logger.info("login params: " + params);  
24.     HttpSession session = request.getSession(false);  
25.     Map<String, String> user = UserUtils.getUserHap(userName);  
26.     logger.info(user);  
27.   
28.     if (UserUtils.authenticatePasswordHap(password, user.get("PASSWORD_ENCRYPTED"))) {  
29.         logger.info("验证通过");  
30.         session.setAttribute("userId", Long.valueOf(user.get("USER_ID")));  
31.         session.setAttribute("username", user.get("USER_NAME"));  
32.         session.setAttribute("userName", user.get("USER_NAME"));   
33.         session.setAttribute("displayName", user.get("USER_NAME"));  
34.         session.setAttribute("locale", "zh_CN");  
35.         long roleId = getUserRoleId(Long.valueOf(user.get("USER_ID")));  
36.         session.setAttribute("roleId", roleId);  
37.         session.setAttribute("timeZone", "GMT+0800");  
38.         if (request.getParameter("url") != null && !request.getParameter("url").isEmpty()  
39.                 && !"null".equals(request.getParameter("url"))) {  
40.             url = java.net.URLDecoder.decode(request.getParameter("url"), "utf-8");  
41.             System.out.println(url);  
42.             return "redirect:" + url;  
43.         }  
44.         return "dashborad";  
45.     } else {  
46.         logger.info("验证不通过");  
47.         if (userName == "" && password == "") {  
48.             request.setAttribute("info", "请输入用户名或密码!");  
49.         } else if (userName == "") {  
50.             request.setAttribute("info", "请输入用户名!");  
51.         } else if (password == "") {  
52.             request.setAttribute("info", "请输入密码!");  
53.         } else {  
54.             request.setAttribute("info", "用户名或密码错误!");  
55.         }  
56.         logger.info(request.getAttribute("info"));  
57.         return "/login";  
58.     }  
59. }  

2、   完成上述工作，我们将两个工程都部署到tomcat服务器下，启动tomcat服务器，进行以下测试：

先访问HspAdmin，在浏览器中输入localhost:8088/HspAdmin/（我的tomcat端口设置的是8088）这时因为session信息不存在，被HspAdmin这个工程中的拦截器（两个工程都设有拦截器的）拦截下来，所以我们看到 了用户登录界面。

 

关闭浏览器的标签页，在新的标签页中输入localhost:8088/ServiceMontior/同样看到用户登录界面，不过我们这次选中登录。

 

登录之后，可以看到HspServiceMontior这个工程的主界面。

 

打开浏览器新标签页，再次输入localhost:8088/HspAdmin/，这一次不一样的事情发生了，我们不再是看到用户登录界面，而是直接看到HspAdmin这个工程的主界面。

 

下面对是一个简单的分析：第一次我们访问HspAdmin，因为没有没有sessio为空，所以被拦截器拦截下来，这时我们跳到登录界面；然后我们访问HspServiceMontior，同样因为session为空，我们跳转到登录界面，当我们登录HspServiceMontior之后，这时用户信息已经被保存在session中了，而两个工程的session又都被配置成保存在redis数据库中的同一个位置，所以我们再次访问HspAdmin时，没有再跳转到登录界面，而是直接跳转到主界面，这也就间接说明spring-session配置成功。

原文出自：http://blog.csdn.net/moxies8090/article/details/53355244（转载请注明出处，谢谢）