并不复杂,只需4步搞定Shiro集成redis实现会话共享

MarkerHub
我的公众号:MarkerHub,Java网站:https://markerhub.com

更多精选文章请点击:Java笔记大全.md

小Hub领读:

集群的分布式场景中,我们需要把众多服务的会话状态保持一致,常见的就是把会话信息保存到redis中实现共享,那么你知道shiro集成redis实现会话共享有多简单吗?真的只需要4步!


在一些分布式场景中,比如一个简单负载均衡场景,一个nginx,反向代理到两个tomcat,tomcat运行这同样的项目,那么这时候,服务的会话需要共享,因为我们已经使用了shiro来完成我们的认证授权逻辑,那么shiro完成登录之后,如何让另外一个服务同时也是登录状态呢?

我们延用上篇文章的项目代码,使用两个端口8080、8081分别启动项目。

有些同学不知道怎么用idea同一个项目分别启动两个端口,其实很简单,只需要在Run/Debug ConfigurationsVM options上,指定启动端口-Dserver.port=8081即可!

ok,分别启动8080和8081项目之后,登录8080项目,然后访问8081,发现8081未登录!图示如下:

那么,如何才能8080登录之后,8081也同时完成登录呢?

特殊解决方式

其实在负载均衡集群中,有些人是这样解决问题,给ip指定服务,比如某个用户请求经过nginx反向代理到8080服务,那么nginx上指定ip_hash:依据ip分配方式,那么这个用户就一直访问同一个服务,不会访问到8081服务,所以用户就一直是访问统一服务,所以在用户看来,他就一直是登录状态的。

但是,这是有缺陷的,因为ip和服务绑定了,加入这个服务挂了之后,是不会转发到其他服务,所以对这用户来说,就访问异常。

所以我们需要使用更常用的负载均衡策略,比如轮询、权重等。

回顾shiro的架构与组件

ok,进入正题,shiro做会话共享,会话信息可以存储到内存,数据库,或者缓存中间件中,这里我们使用一个常用的缓存中间件Redis来保存我们的会话信息,那么,我们就需要shiro集成redis。

可以回顾一下之前我们介绍过的shiro的整体架构:
图片

上面与会话或缓存相关的组件有:

  • Session Manager 会话管理器
  • Session DAO 会话 DAO,将session保存到数据库、缓存等
  • Cache Manager 缓存管理器,权限认证的缓存、用户及权限信息的缓存等

如果只是做会话共享,只是改写Session DAO好像也是可以的,我之前试过,不过既然shiro已经集成redis,那么数据啥的最好也一起共享吧,防止出现缓存不一致的情况。按照这个逻辑,其实就是重写这3个组件就行了。

shiro-redis整合步骤

那么,有什么已经写好的shiro集成redis整合项目嘛?

这里给大家介绍一个

https://github.com/alexxiyang/shiro-redis/
# 文档
https://github.com/alexxiyang/shiro-redis/blob/master/docs/README.md
# 或者
http://alexxiyang.github.io/shiro-redis/

readme.md上有详细的教程,这里我们直接使用Spring boot starter方式,因为需要写的代码少,直接写写配置就好。

第一步:导入shiro-redis的starter包

<dependency>
    <groupId>org.crazycake</groupId>
    <artifactId>shiro-redis-spring-boot-starter</artifactId>
    <version>3.2.1</version>
</dependency>

可以看下shiro-redis-spring-boot-starter源码:

可以看出,已经包含了shiro-spring-boot-web-startershiro-redis整合包了,所以之前项目中整合进来的shiro-spring-boot-web-starter可以注释掉了。

第二步,根据说明,readme里面说,如果你没有自定义创建SessionManager or SessionsSecurityManager,那么会自动给你创建,集成完成。但是我们自定义了realm,所以SecurityManager还是必须要自定义的。

  • com.markerhub.config.ShiroConfig
@Configuration
public class ShiroConfig {

    @Autowired
    RedisSessionDAO redisSessionDAO;

    @Autowired
    RedisCacheManager redisCacheManager;

    @Bean
    AccountRealm accountRealm() {
        return new AccountRealm();
    }

    @Bean
    public SessionManager sessionManager() {
        DefaultWebSessionManager sessionManager = new DefaultWebSessionManager();

        // inject redisSessionDAO
        sessionManager.setSessionDAO(redisSessionDAO);
        return sessionManager;
    }

    @Bean
    public DefaultWebSecurityManager securityManager(AccountRealm accountRealm, SessionManager sessionManager) {
        DefaultWebSecurityManager securityManager = new DefaultWebSecurityManager();
        securityManager.setRealm(accountRealm);

        //inject sessionManager
        securityManager.setSessionManager(sessionManager);

        // inject redisCacheManager
        securityManager.setCacheManager(redisCacheManager);

        return securityManager;
    }

    @Bean
    public ShiroFilterChainDefinition shiroFilterChainDefinition() {
        DefaultShiroFilterChainDefinition chainDefinition = new DefaultShiroFilterChainDefinition();

        // logged in users with the 'admin' role
        chainDefinition.addPathDefinition("/admin/**", "authc, roles[admin]");

        // logged in users with the 'document:read' permission
        chainDefinition.addPathDefinition("/docs/**", "authc, perms[document:read]");

        chainDefinition.addPathDefinition("/login", "anon");
        chainDefinition.addPathDefinition("/doLogin", "anon");

        // all other paths require a logged in user
        chainDefinition.addPathDefinition("/**", "authc");
        return chainDefinition;
    }
}

相比之前的配置,多了配置了个SessionManager,然后对应配置中注入sessionManager和redisCacheManager。好像项目就已经可以运行啦。

登录成功之后查看redis中的数据效果如下:

说明我们的会话信息已经保存到redis中啦。然后我们再换个端口8081启动项目,发现8080登录成功之后,8081服务也是登录成功状态。

第三步、根据需求调整参数,可以在配置文件中调整的参数我贴出来:

  • application.yml
shiro-redis:
  enabled: true
  redis-manager:
    host: 127.0.0.1:6379

ok,shiro-redis已经整合完毕,是不是挺简单的哈。

注意点

使用这个整合包,有个注意点,如果你使用了spring-boot-devtools作为自动热加载重启,那么自动重启后会报错,解决方法也简单,官方已经给出了解决方案:

If you are using shiro-redis with spring-boot-devtools. Please add this line to resources/META-INF/spring-devtools.properties (Create it if there is no this file):

restart.include.shiro-redis=/shiro-[\w-\.]+jar

所以,第四步:只需要在resources新建一个文件夹META-INF,然后新建文件spring-devtools.properties,内容为:

restart.include.shiro-redis=/shiro-[\\w-\\.]+jar

效果如下:

结束语

好了,今天先讲到这里吧,shiro系列的文章已经发了几篇了,后面还有一篇集成单点登录的,然后就完结了哈。这里是MarkerHub,我是小Hub吕一明,快去星标置顶我的公众号吧!


(完)

推荐阅读

Java笔记大全.md

太赞了,这个Java网站,什么项目都有!https://markerhub.com

这个B站的UP主,讲的java真不错!

阅读 299

Java技术干货
每天一点Java小知识,让Java不再难懂!
393 声望
199 粉丝
0 条评论
你知道吗?

393 声望
199 粉丝
宣传栏