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

小Hub领读：

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

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

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

  • http://localhost:8080

  • http://localhost:8081

有些同学不知道怎么用idea同一个项目分别启动两个端口，其实很简单，只需要在 Run/DebugConfigurations的 VM 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整合项目嘛？

这里给大家介绍一个

  1. https://github.com/alexxiyang/shiro-redis/

  2. # 文档

  3. https://github.com/alexxiyang/shiro-redis/blob/master/docs/README.md

  4. # 或者

  5. http://alexxiyang.github.io/shiro-redis/

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

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

  1. <dependency>

  2. <groupId>org.crazycake</groupId>

  3. <artifactId>shiro-redis-spring-boot-starter</artifactId>

  4. <version>3.2.1</version>

  5. </dependency>

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

图片

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

图片

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

  • com.markerhub.config.ShiroConfig

  1. @Configuration

  2. public class ShiroConfig {

  3.  

  4. @Autowired

  5. RedisSessionDAO redisSessionDAO;

  6.  

  7. @Autowired

  8. RedisCacheManager redisCacheManager;

  9.  

  10. @Bean

  11. AccountRealm accountRealm() {

  12. return new AccountRealm();

  13. }

  14.  

  15. @Bean

  16. public SessionManager sessionManager() {

  17. DefaultWebSessionManager sessionManager = new DefaultWebSessionManager();

  18.  

  19. // inject redisSessionDAO

  20. sessionManager.setSessionDAO(redisSessionDAO);

  21. return sessionManager;

  22. }

  23.  

  24. @Bean

  25. public DefaultWebSecurityManager securityManager(AccountRealm accountRealm, SessionManager sessionManager) {

  26. DefaultWebSecurityManager securityManager = new DefaultWebSecurityManager();

  27. securityManager.setRealm(accountRealm);

  28.  

  29. //inject sessionManager

  30. securityManager.setSessionManager(sessionManager);

  31.  

  32. // inject redisCacheManager

  33. securityManager.setCacheManager(redisCacheManager);

  34.  

  35. return securityManager;

  36. }

  37.  

  38. @Bean

  39. public ShiroFilterChainDefinition shiroFilterChainDefinition() {

  40. DefaultShiroFilterChainDefinition chainDefinition = new DefaultShiroFilterChainDefinition();

  41.  

  42. // logged in users with the 'admin' role

  43. chainDefinition.addPathDefinition("/admin/**", "authc, roles[admin]");

  44.  

  45. // logged in users with the 'document:read' permission

  46. chainDefinition.addPathDefinition("/docs/**", "authc, perms[document:read]");

  47.  

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

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

  50.  

  51. // all other paths require a logged in user

  52. chainDefinition.addPathDefinition("/**", "authc");

  53. return chainDefinition;

  54. }

  55. }

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

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

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

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

  • application.yml

  1. shiro-redis:

  2. enabled: true

  3. redis-manager:

  4. 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，内容为：

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

效果如下： 图片

结束语

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

posted @ 2022-05-12 16:07  知为谁开  阅读(102)  评论(0)    收藏  举报