Spring-session(spring-session-data-redis)实现分布式下Session共享

由于公司项目是单节点的，同事在开发过程中并未做Session共享，由于流量上升后，领导未经过了解直接加机器、加节点；大家可想而知了，项目中运行过程出现很多问题，经过同事们系列排查，才知道是由于上面原因导致拿不到Session。

大家在项目采用Spring-Session时一定要注意项目中Spring的版本，否则会给你带成很多坑，首先，Spring-Session所需的最低SPring版本是3.2.14.RELEASE

一、由于Redis采用Cluster集群方式所以在项目中引入以下版本Jar：

    org.springframework.session
	spring-session-data-redis
	1.3.1.RELEASE


	org.springframework.session
	spring-session
	1.3.1.RELEASE
 

需要注意Spring的版本，下面所引用jar是在Spring 4.3.10.RELEASE所测试，如果低于此版本会报错，项目无法启动

错误如下：

ERROR [RMI TCP Connection(7)-127.0.0.1] - Context initialization failed
org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'redisMessageListenerContainer' defined in class path resource [org/springframework/session/data/redis/config/annotation/web/http/RedisHttpSessionConfiguration.class]: Unsatisfied dependency expressed through constructor argument with index 1 of type [org.springframework.session.data.redis.RedisOperationsSessionRepository]: : Error creating bean with name 'sessionRepository' defined in class path resource [org/springframework/session/data/redis/config/annotation/web/http/RedisHttpSessionConfiguration.class]: Unsatisfied dependency expressed through constructor argument with index 0 of type [org.springframework.data.redis.core.RedisOperations]: : Error creating bean with name 'sessionRedisTemplate' defined in class path resource [org/springframework/session/data/redis/config/annotation/web/http/RedisHttpSessionConfiguration.class]: Invocation of init method failed; nested exception is java.lang.NoSuchMethodError: org.springframework.core.serializer.support.DeserializingConverter.(Ljava/lang/ClassLoader;)V; nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'sessionRedisTemplate' defined in class path resource [org/springframework/session/data/redis/config/annotation/web/http/RedisHttpSessionConfiguration.class]: Invocation of init method failed; nested exception is java.lang.NoSuchMethodError: org.springframework.core.serializer.support.DeserializingConverter.(Ljava/lang/ClassLoader;)V; nested exception is org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'sessionRepository' defined in class path resource [org/springframework/session/data/redis/config/annotation/web/http/RedisHttpSessionConfiguration.class]: Unsatisfied dependency expressed through constructor argument with index 0 of type [org.springframework.data.redis.core.RedisOperations]: : Error creating bean with name 'sessionRedisTemplate' defined in class path resource [org/springframework/session/data/redis/config/annotation/web/http/RedisHttpSessionConfiguration.class]: Invocation of init method failed; nested exception is java.lang.NoSuchMethodError: org.springframework.core.serializer.support.DeserializingConverter.(Ljava/lang/ClassLoader;)V; nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'sessionRedisTemplate' defined in class path resource [org/springframework/session/data/redis/config/annotation/web/http/RedisHttpSessionConfiguration.class]: Invocation of init method failed; nested exception is java.lang.NoSuchMethodError: org.springframework.core.serializer.support.DeserializingConverter.(Ljava/lang/ClassLoader;)V
	at org.springframework.beans.factory.support.ConstructorResolver.createArgumentArray(ConstructorResolver.java:752)
 

二、在Web.xml文件加入Spring-Session的入口依赖

 
        springSessionRepositoryFilter
        org.springframework.web.filter.DelegatingFilterProxy
    
    
        springSessionRepositoryFilter
        /*
        REQUEST
        ERROR
    

注意此处filter放置位置一定要放在第一行或是标签后面，否则出现希奇古怪问题。

        contextConfigLocation
        classpath*:config/applicationContext.xml
    

三、本人在项目是采用@Bean注解方式，不是传统的XML注入Bean方式，至于传统XML可以自己去网上百度

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.connection.RedisClusterConfiguration;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.connection.RedisSentinelConfiguration;
import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
import org.springframework.session.data.redis.config.ConfigureRedisAction;
import org.springframework.session.data.redis.config.annotation.web.http.EnableRedisHttpSession;
import org.springframework.session.web.http.CookieHttpSessionStrategy;
import org.springframework.session.web.http.CookieSerializer;
import org.springframework.session.web.http.DefaultCookieSerializer;
import redis.clients.jedis.Jedis;
import redis.clients.jedis.JedisPoolConfig;


/**
 * RedisHttpSessionConfiguration的配置文件
 * 引入RedisHttpSessionConfiguration.class
 * maxInactiveIntervalInSeconds设置session在redis里的超时
 */
@Configuration
@EnableRedisHttpSession(maxInactiveIntervalInSeconds=3600)
public class RedisHttpSessionConfiguration {
    final static Logger logger = LoggerFactory.getLogger(RedisHttpSessionConfiguration.class);

    //是否为集群模式
    @Value("#{configproperties_disconf['redis.cluster']}")
    private boolean cluster;

    //redis地址(集群下多台使用,号隔开)
    @Value("#{configproperties_disconf['redis.hostAndPort']}")
    private String hostAndPort;

    //密码
    @Value("#{configproperties_disconf['redis.password']}")
    private String password;

    //连接超时时间(单台redis有效)
    @Value("#{configproperties_disconf['redis.connectionTimeout']}")
    private String connectionTimeout;

    //获取连接重试次数(单台redis有效)
    @Value("#{configproperties_disconf['redis.failTimes']}")
    private String failTimes;

    //设置socket调用InputStream读数据的超时时间
    @Value("#{configproperties_disconf['redis.soTimeout']}")
    private String soTimeout;

    //缓存默认过期时间
    @Value("#{configproperties_disconf['redis.expire']}")
    private String expire;

    //单个缓存最大存储字节数
    @Value("#{configproperties_disconf['redis.max.value.size']}")
    private String maxValueSize;

    //
    @Value("#{configproperties_disconf['redis.maxIdle']}")
    private Integer maxIdle;

    //
    @Value("#{configproperties_disconf['redis.maxTotal']}")
    private Integer maxTotal;
    //Cookie域名，
    @Value("#{configproperties_disconf['redis.maxTotal']}")
    private String cookieDomainName;

    private String[] hostAndPorts;

    @Autowired
    private JedisPoolConfig jedisPoolConfig;

    @Autowired
    private JedisConnectionFactory jedisConnectionFactory;

	@Bean
    public static ConfigureRedisAction configureRedisAction() {
        return ConfigureRedisAction.NO_OP;
    }


/*    @Bean
    public CookieHttpSessionStrategy cookieHttpSessionStrategy() {
	    CookieHttpSessionStrategy strategy = new CookieHttpSessionStrategy();
	    strategy.setCookieSerializer(cookieSerializer());
	    return strategy;
	}*/

    @Bean
    public CookieSerializer cookieSerializer() {
        final DefaultCookieSerializer serializer = new DefaultCookieSerializer();
        serializer.setCookieName("JSESSIONID_CSDN");
        //如果项目是在子域名下使用时，建议直接配置成主域名如下
        serializer.setDomainName("csdn.net");

        serializer.setCookiePath("/");
        //serializer.setDomainNamePattern("^.+?\\.(\\w+\\.[a-z]+)$");
        //serializer.setCookieMaxAge(sessionCookieConfig.getMaxAge());
        //serializer.setJvmRoute();
        //serializer.setUseSecureCookie();
        //serializer.setUseBase64Encoding();
        //serializer.setUseHttpOnlyCookie(false);
        //serializer.setRememberMeRequestAttribute(SpringSessionRememberMeServices.REMEMBER_ME_LOGIN_ATTR);
        return serializer;
    }


    /**
     * JedisPoolConfig 配置
     *
     * 配置JedisPoolConfig的各项属性
     *
     * @return
     */

    @Bean
    public JedisPoolConfig jedisPoolConfig(){
        JedisPoolConfig jedisPoolConfig= new JedisPoolConfig();
        //连接耗尽时是否阻塞, false报异常,ture阻塞直到超时, 默认true
        jedisPoolConfig.setBlockWhenExhausted(true);

        //是否启用pool的jmx管理功能, 默认true
        jedisPoolConfig.setJmxEnabled(true);

        //jedis调用returnObject方法时，是否进行有效检查
        jedisPoolConfig.setTestOnReturn(true);

        //最大空闲连接数, 默认8个
        jedisPoolConfig.setMaxIdle(maxIdle);

        //最大连接数, 默认8个
        jedisPoolConfig.setMaxTotal(maxTotal);

        //获取连接时的最大等待毫秒数(如果设置为阻塞时BlockWhenExhausted),如果超时就抛异常, 小于零:阻塞不确定的时间,  默认-1
        jedisPoolConfig.setMaxWaitMillis(-1);

        //逐出连接的最小空闲时间 默认1800000毫秒(30分钟)
        jedisPoolConfig.setMinEvictableIdleTimeMillis(1800000);

        //最小空闲连接数, 默认0
        jedisPoolConfig.setMinIdle(maxIdle);

        //每次逐出检查时 逐出的最大数目 如果为负数就是 : 1/abs(n), 默认3
        jedisPoolConfig.setNumTestsPerEvictionRun(3);

        //对象空闲多久后逐出, 当空闲时间>该值 且 空闲连接>最大空闲数 时直接逐出,不再根据MinEvictableIdleTimeMillis判断  (默认逐出策略)
        jedisPoolConfig.setSoftMinEvictableIdleTimeMillis(1800000);

        //在获取连接的时候检查有效性, 默认false
        jedisPoolConfig.setTestOnBorrow(false);

        //在空闲时检查有效性, 默认false
        jedisPoolConfig.setTestWhileIdle(false);

        //逐出扫描的时间间隔(毫秒) 如果为负数,则不运行逐出线程, 默认-1
        jedisPoolConfig.setTimeBetweenEvictionRunsMillis(-1);

        return jedisPoolConfig;
    }

    @Bean
    public JedisConnectionFactory jedisConnectionFactory() {
    	 try {
             if (StringUtils.isBlank(hostAndPort)) {
                 logger.error("not set redis server Host");
                 return null;
             }

             hostAndPorts = hostAndPort.split(",");
             if (StringUtils.isNotBlank(hostAndPort)) {

             }
             if (cluster) {
                 logger.info("redis sever enable cluster model");
                 RedisClusterConfiguration redisClusterConfiguration = new RedisClusterConfiguration();

                 for (String hp : hostAndPorts) {
                     String[] args = hp.split(":");
                     logger.error(args[0]+ "=="+args[1]);
                     redisClusterConfiguration.clusterNode(args[0], Integer.valueOf(args[1]).intValue());
                 }

                 JedisConnectionFactory connectionFactory = new JedisConnectionFactory(
                         redisClusterConfiguration, jedisPoolConfig);
                 connectionFactory.setTimeout(3600);
                 return connectionFactory;
             } else {
                 //哨兵模式
                 if ( hostAndPorts!= null && hostAndPorts.length > 1) {
                     logger.info("redis sever enable single sentinel model");
                     RedisSentinelConfiguration redisSentinelConfiguration= new RedisSentinelConfiguration();
                     for (String hp : hostAndPorts) {
                         String[] args = hp.split(":");
                         redisSentinelConfiguration.sentinel(args[0], Integer.valueOf(args[1]));
                     }
                     JedisConnectionFactory jedisConnectionFactory = new JedisConnectionFactory(redisSentinelConfiguration, jedisPoolConfig);
                     jedisConnectionFactory.setTimeout(3600);
                     return jedisConnectionFactory;
                 } else {//单机模式
                     logger.info("redis sever enable single model");
                     String[] args = hostAndPort.split(":");
                     JedisConnectionFactory jedisConnectionFactory =  new JedisConnectionFactory(jedisPoolConfig);
                     jedisConnectionFactory.setHostName(args[0]);
                     jedisConnectionFactory.setPort(Integer.valueOf(args[1]).intValue());
                     jedisConnectionFactory.setTimeout(3600);
                     return jedisConnectionFactory;
                 }
             }
         } catch (Exception e) {
             logger.error("redis connection error");
         }
         return null;
    }
    

    /**
     * RedisTemplate配置
     *
     * @param redisConnectionFactory
     * @return
     */
    @Bean
    public RedisTemplate redisTemplate(RedisConnectionFactory redisConnectionFactory) {
        StringRedisTemplate template = new StringRedisTemplate(redisConnectionFactory);
        Jackson2JsonRedisSerializer