Springboot 集成 redis 实现 session 共享

今天分享 springboot 集成 redis 实现 session 共享，起因于目前部署服务大多是双节点或者是多节点，因此无法绕开 sesion 共享的问题，今天我们重点分析一下：

1、相关 jar 包引入：

      
          org.springframework.boot
          spring-boot-starter-data-redis
      
      
      
          org.springframework.session
          spring-session-data-redis
      

2、配置文件中 redis 集群配置：

spring
   redis:
    cluster:
      nodes:
        - 192.18.8.124:6008
        - 192.18.8.125:6008
    host: nandao.com
    password: 12345
    port: 6379
    timeout: 3000
    connectTimeout: 30000
    retryAttempts: 3
    retryInterval: 1500
    lettuce:
      pool:
        max-active: -1
        max-wait: -1
        max-idle: 8
        min-idle: 0

非集群默认配置：

#redis 默认配置
spring.redis.host=127.0.0.1
spring.redis.port=6379
spring.redis.password=123456
spring.redis.pool.max-idle=8
spring.redis.pool.min-idle=0
spring.redis.pool.max-active=8
spring.redis.pool.max-wait=-1
#超时一定要大于0，否则启动报错
spring.redis.timeout=3000
spring.session.store-type=redis

3，关闭自动配置 redis 参数，防止生产环境云平台启动时报错, 可以在启动类里添加：

/**
  * 关闭自动配置redis参数
  * @return
  */
 @Bean
 public ConfigureRedisAction configureRedisAction(){
  return ConfigureRedisAction.NO_OP;
 }

如果不添加此配置，启动时可能报错

Caused by: org.springframework.data.redis.RedisSystemException: Error in execution; nested exception is io.lettuce.core.RedisCommandExecutionException: ERR config is disabled command
 at org.springframework.data.redis.connection.lettuce.LettuceExceptionConverter.convert(LettuceExceptionConverter.java:54)
 at org.springframework.data.redis.connection.lettuce.LettuceExceptionConverter.convert(LettuceExceptionConverter.java:52)
 at org.springframework.data.redis.connection.lettuce.LettuceExceptionConverter.convert(LettuceExceptionConverter.java:41)
 at org.springframework.data.redis.PassThroughExceptionTranslationStrategy.translate(PassThroughExceptionTranslationStrategy.java:44)
 at org.springframework.data.redis.connection.ClusterCommandExecutor.convertToDataAccessException(ClusterCommandExecutor.java:337)
 at org.springframework.data.redis.connection.ClusterCommandExecutor.executeCommandOnSingleNode(ClusterCommandExecutor.java:147)
 at org.springframework.data.redis.connection.ClusterCommandExecutor.executeCommandOnSingleNode(ClusterCommandExecutor.java:123)
 at org.springframework.data.redis.connection.ClusterCommandExecutor.lambda$executeCommandAsyncOnNodes$0(ClusterCommandExecutor.java:212)
 at java.util.concurrent.FutureTask.run(FutureTask.java:266)
 at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149)
 at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)
 at java.lang.Thread.run(Thread.java:748)
Caused by: io.lettuce.core.RedisCommandExecutionException: ERR config is disabled command
 at io.lettuce.core.ExceptionFactory.createExecutionException(ExceptionFactory.java:135)
 at io.lettuce.core.ExceptionFactory.createExecutionException(ExceptionFactory.java:108)
 at io.lettuce.core.protocol.AsyncCommand.completeResult(AsyncCommand.java:120)
 at io.lettuce.core.protocol.AsyncCommand.complete(AsyncCommand.java:111)
 at io.lettuce.core.protocol.CommandWrapper.complete(CommandWrapper.java:59)
 at io.lettuce.core.protocol.CommandHandler.complete(CommandHandler.java:646)
 at io.lettuce.core.protocol.CommandHandler.decode(CommandHandler.java:604)
 at io.lettuce.core.protocol.CommandHandler.channelRead(CommandHandler.java:556)
 at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:374)
 at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:360)
 at io.netty.channel.AbstractChannelHandlerContext.fireChannelRead(AbstractChannelHandlerContext.java:352)
 at io.netty.channel.DefaultChannelPipeline$HeadContext.channelRead(DefaultChannelPipeline.java:1408)
 at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:374)
 at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:360)
 at io.netty.channel.DefaultChannelPipeline.fireChannelRead(DefaultChannelPipeline.java:930)
 at io.netty.channel.nio.AbstractNioByteChannel$NioByteUnsafe.read(AbstractNioByteChannel.java:163)
 at io.netty.channel.nio.NioEventLoop.processSelectedKey(NioEventLoop.java:682)
 at io.netty.channel.nio.NioEventLoop.processSelectedKeysOptimized(NioEventLoop.java:617)
 at io.netty.channel.nio.NioEventLoop.processSelectedKeys(NioEventLoop.java:534)
 at io.netty.channel.nio.NioEventLoop.run(NioEventLoop.java:496)
 at io.netty.util.concurrent.SingleThreadEventExecutor$5.run(SingleThreadEventExecutor.java:906)
 at io.netty.util.internal.ThreadExecutorMap$2.run(ThreadExecutorMap.java:74)

4、redis 集群配置类，及客户端工具来的生成：

import org.redisson.Redisson;
import org.redisson.api.RedissonClient;
import org.redisson.codec.JsonJacksonCodec;
import org.redisson.config.Config;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.data.redis.RedisProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
 
@Configuration
public class RedissonConfig {
 
    // 同任何节点创建链接时的等待超时。时间单位是毫秒。
    @Value("${spring.redis.connectTimeout}")
    private int connectTimeout = 10000;
 
    @Value("${spring.redis.timeout}")
    private int timeout = 3000;
    // 命令失败重试次数
    @Value("${spring.redis.retryAttempts}")
    private int retryAttempts = 3;
    // 命令重试发送时间间隔
    @Value("${spring.redis.retryInterval}")
    private int retryInterval = 1500;
 
    @Autowired
    private RedisProperties redisProperties;
 
    @Bean
    public RedissonClient redissonClient() {
        return Redisson.create(config());
    }
 
    private Config config() {
        String[] nodes = redisProperties.getCluster().getNodes().stream().map(addr -> "redis://" + addr).toArray(String[]::new);
 
        Config config = new Config();
        config.setThreads(4);
        config.setCodec(JsonJacksonCodec.INSTANCE);
        config.useClusterServers()
                .addNodeAddress(nodes)
                .setConnectTimeout(connectTimeout)
                .setRetryAttempts(retryAttempts)
                .setRetryInterval(retryInterval)
                .setTimeout(timeout)
                .setPassword(redisProperties.getPassword());
 
        return config;
    }
 
}

5、登录状态拦截器 RedisSessionInterceptor

/**
*
*拦截登录的请求
*/
public class RedisSessionInterceptor implements HandlerInterceptor
{
    @Autowired
    private StringRedisTemplate redisTemplate;
 
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception
    {
        //无论访问的地址是不是正确的，都进行登录验证，登录成功后的访问再进行分发，404的访问自然会进入到错误控制器中
        HttpSession session = request.getSession();
        if (session.getAttribute("loginUserId") != null)
        {
            try
            {
                //验证当前请求的session是否是已登录的session
                String loginSessionId = redisTemplate.opsForValue().get("loginUser:" + (long) session.getAttribute("loginUserId"));
                if (loginSessionId != null && loginSessionId.equals(session.getId()))
                {
                    return true;
                }
            }
            catch (Exception e)
            {
                e.printStackTrace();
            }
        }
 
        response401(response);
        return false;
    }
 
    private void response401(HttpServletResponse response)
    {
        response.setCharacterEncoding("UTF-8");
        response.setContentType("application/json; charset=utf-8");
 
        try
        {
            response.getWriter().print(JSON.toJSONString(new ReturnData(StatusCode.NEED_LOGIN, "", "用户未登录！")));
        }
        catch (IOException e)
        {
            e.printStackTrace();
        }
    }
 
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception
    {
 
    }
 
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception
    {
 
    }
}

6、配置拦截器

@Configuration
public class WebSecurityConfig extends WebMvcConfigurerAdapter{
    @Bean
    public RedisSessionInterceptor getSessionInterceptor()
    {
        return new RedisSessionInterceptor();
    }
 
    @Override
    public void addInterceptors(InterceptorRegistry registry)
    {
        //所有已api开头的访问都要进入RedisSessionInterceptor拦截器进行登录验证，并排除login接口(全路径)。必须写成链式，分别设置的话会创建多个拦截器。
        //必须写成getSessionInterceptor()，否则SessionInterceptor中的@Autowired会无效
        registry.addInterceptor(getSessionInterceptor()).addPathPatterns("/app/**").excludePathPatterns("/app/user/login");
        super.addInterceptors(registry);
    }
}

7、登录接口核心代码：

@Autowired
    private StringRedisTemplate redisTemplate;
 
   @RequestMapping("/user/login")
    public R login(HttpServletRequest request, String account, String password)
    {
        User user = userService.findUserByAccountAndPassword(account, password);
        if (user != null){
            HttpSession session = request.getSession();
            session.setAttribute("loginUserId", user.getUserId());
            redisTemplate.opsForValue().set("loginUser:" + user.getUserId(), session.getId());
 
            return new R(StatusCode.REQUEST_SUCCESS, user, "登录成功！");
        }
        else
        {
            throw new CommonException(StatusCode.ACCOUNT_OR_PASSWORD_ERROR, "用户名或密码错误");
        }
    }

到此，session 共享分享完成，大家可以亲测试试，定会惊喜多多！

---

作者：nandao158

来源链接：

https://blog.csdn.net/nandao158/article/details/122858880