springboot 中 redis 的使用和分布式 session 共享问题

本文旨在解决分布式系统的 session 如何共享问题,大致思路:session 放入 redis。其他解决方案:持久化、放 cache 等都可以,但是自从有了 redis,这完全可以变的简简单单。
本文大致分两步:
1.springboot 中如何使用 redis。
2.redis 如何解决 session 共享

pom 依赖

 <!--redis配置开始-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-redis</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.data</groupId>
            <artifactId>spring-data-redis</artifactId>
            <version>${spring-data-redis.version}</version>
        </dependency>
        <dependency>
            <groupId>redis.clients</groupId>
            <artifactId>jedis</artifactId>
            <version>${jedis.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.session</groupId>
            <artifactId>spring-session-data-redis</artifactId>
        </dependency>
        <!--redis配置结束--> 

添加 redis 配置类

该配置类同样可以配置缓存失效时间等。

package com.mos.quote.config;

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.cache.CacheManager;
import org.springframework.cache.annotation.CachingConfigurerSupport;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.cache.interceptor.KeyGenerator;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.cache.RedisCacheManager;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;

/**
 * @author Administrator
 */
@Configuration
@EnableCaching
public class RedisConfig extends CachingConfigurerSupport {
    @Bean
    public KeyGenerator KeyGenerator(){
        return (target, method, params) -> {
            StringBuilder sb = new StringBuilder();
            sb.append(target.getClass().getName());
            sb.append(method.getName());
            for (Object obj : params) {
                sb.append(obj.toString());
            }
            return sb.toString();
        };
    }

    @Bean
    public RedisTemplate<String, String> redisTemplate(RedisConnectionFactory factory) {
        StringRedisTemplate template = new StringRedisTemplate(factory);
        Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
        ObjectMapper om = new ObjectMapper();
        om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        jackson2JsonRedisSerializer.setObjectMapper(om);
        template.setValueSerializer(jackson2JsonRedisSerializer);
        template.afterPropertiesSet();
        return template;
    }

    @Bean
    public CacheManager cacheManager(RedisTemplate<String,String> redisTemplate) {
        RedisCacheManager rcm = new RedisCacheManager(redisTemplate);
        //设置缓存过期时间
        rcm.setDefaultExpiration(600000);
        return rcm;
    }
} 

配置 redis 服务

# Redis数据库索引(默认为0)
spring.redis.database=0
# Redis服务器地址
spring.redis.host=192.168.1.118
# Redis服务器连接端口
spring.redis.port=6381
# Redis服务器连接密码(默认为空)
spring.redis.password=
# 连接池最大连接数(使用负值表示没有限制)
spring.redis.pool.max-active=8
# 连接池最大阻塞等待时间(使用负值表示没有限制)
spring.redis.pool.max-wait=-1
# 连接池中的最大空闲连接
spring.redis.pool.max-idle=8
# 连接池中的最小空闲连接
spring.redis.pool.min-idle=0
# 连接超时时间(毫秒)
spring.redis.timeout=0 

单元测试

  1. set 值(字符串)
 @Test
    public void put(){
        stringRedisTemplate.opsForValue().set("test001","test001");
        Assert.assertEquals("test001", stringRedisTemplate.opsForValue().get("test001"));
    } 

往 redis 放一个 key 为 test001、value 为 test001 的值,然后查看 redis

  1. set 值(object)
 @Test
    public void testObj() throws Exception {
        SysUser user=new SysUser();
        user.setId("123456");
        user.setName("张三");
        ValueOperations<String, SysUser> operations=redisTemplate.opsForValue();
        operations.set("user1", user);
        operations.set("user2", user,5, TimeUnit.SECONDS);
        Thread.sleep(6000);
        Assert.assertFalse(redisTemplate.hasKey("user2"));
    } 

往 redis 分别放 key 为 user1 和 user2 的对象,user2 设置 5 秒失效,线程等待 6 秒再完成,期望结果:redis 中有 user1,没有 user2,bingo!!!

解决 session 共享

使用 spring-session-data-redis 实现 session 共享,pom 中引入该依赖(上文已添加),添加 SessionConfig 配置类。
对,没看错,只需要这个就够了。最长有效时间根据自己情况随意配置即可。

package com.mos.quote.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.session.data.redis.config.annotation.web.http.EnableRedisHttpSession;

/**
 * @author Administrator
 */
@Configuration
@EnableRedisHttpSession(maxInactiveIntervalInSeconds = 3000)
public class SessionConfig {
} 

测试

写一个简单 Controller,如下

 @RequestMapping("testSessionTimeOut")
    public String testSessionTimeOut(String id,HttpSession session,Model model){
        Area area = areaService.getById(id);
        System.out.println("sessionId-------->"+session.getId());
        model.addAttribute("area",JSON.toJSONString(area));
        session.setAttribute("area",JSON.toJSONString(area));
        return "demo/test1";
    } 

这里可以看到 sessionId:

看 redis 中,可以看到失效时间,sessionId 等

共享 session

另外找一个机器,照着这个配置再来一遍,自动启用 session 共享,因为 sessionId 都存在了同一个 redis 中。奏是这么简单。挽起袖子开始干吧。