152 Star 392 Fork 126

BYStudio / shiro-redis

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

avatar Shiro-Redis

Shiro集成Redis的适配器,为解决shiro-ehcache不利于集群而打造的集中式缓存方案。

License Maven Central

Maven坐标

<dependency>
    <groupId>org.iherus.shiro</groupId>
    <artifactId>shiro-redis</artifactId>
    <version>2.5.0</version>
</dependency>

SpringBoot:

<dependency>
    <groupId>org.iherus.shiro</groupId>
    <artifactId>shiro-redis-spring-boot-web-starter</artifactId>
    <version>2.5.0</version>
</dependency>

更新日志

v2.5.0:
Change Log
1)解决Issues:#I1YUFN#I2BSCN#I2B7LC#I22K17#I26UHZ
2)支持session永不失效,#I2BCKL

v2.4.0:【存在bug,请忽略此版本】
常规bug fix 版本

v2.3.0:
Change Log
1)解决RedisSessionDAO#uncache方法抛出StackOverflowError。Issues:#I1TIIG
2)依赖升级,其中Shiro的版本升至1.6.0。

v2.2.0:

Change Log
1)加入scope策略.

v2.1.0:

Change Log
1)修复bug.
2)增强兼容性
3)发布shiro-redis-spring-boot-web-starter

v2.0.0:

Note
此版本为重构版本,API不兼容v1.x。

Change Log
1)在v1.x仅支持单机模式的基础上,新增了对 哨兵(Sentinel)、集群(Cluster)模式的支持。
2)支持Lettuce客户端、Redisson客户端
3)兼容Spring-data-redis
4)非集群模式,可设置独立的database
5)支持设置缓存失效时间
6)优化性能
7)新增RedisSessionDAO用于降低请求Redis的频率

Shiro-Redis使用说明

1、基于ini的使用方式

[main]
#定义凭证匹配器
credentialsMatcher=org.apache.shiro.authc.credential.HashedCredentialsMatcher
#散列算法
credentialsMatcher.hashAlgorithmName=MD5
#散列次数
credentialsMatcher.hashIterations=2

#定义缓存池配置
poolConfig=redis.clients.jedis.JedisPoolConfig
poolConfig.minIdle=3
poolConfig.maxIdle=10
poolConfig.maxWaitMillis=1500
poolConfig.maxTotal=100

#定义连接配置
## Standalone
configuration=org.iherus.shiro.cache.redis.config.RedisStandaloneConfiguration
configuration.host=127.0.0.1
configuration.port=6379
configuration.database=2
#configuration.password=

## Sentinel
#configuration=org.iherus.shiro.cache.redis.config.RedisSentinelConfiguration
#configuration.masterName=mymaster
#configuration.sentinelsFromText=127.0.0.1:56379,127.0.0.1:56479,127.0.0.1:56579
#configuration.database=2
#configuration.password=

## Cluster
#configuration=org.iherus.shiro.cache.redis.config.RedisClusterConfiguration
#configuration.clusterNodesFromText=127.0.0.1:16379, 127.0.0.1:16380, 127.0.0.1:16381, 127.0.0.1:16382, 127.0.0.1:16383, 127.0.0.1:16384
#configuration.password=

#定义连接工厂
## Jedis
connectionFactory=org.iherus.shiro.cache.redis.connection.jedis.JedisConnectionFactory
connectionFactory.poolConfig=$poolConfig
connectionFactory.configuration=$configuration
#connectionFactory.clientName=
#connectionFactory.connectTimeoutMillis=
#connectionFactory.soTimeoutMillis=

## Lettuce
#connectionFactory=org.iherus.shiro.cache.redis.connection.lettuce.LettuceConnectionFactory
#connectionFactory.poolConfig=$poolConfig
#connectionFactory.configuration=$configuration
#connectionFactory.clientName=
#connectionFactory.timeoutMillis=

## Redisson
#connectionFactory=org.iherus.shiro.cache.redis.connection.redisson.RedissonConnectionFactory
#connectionFactory.configuration=$configuration
#connectionFactory.clientName=
#connectionFactory.connectTimeoutMillis=
#connectionFactory.soTimeoutMillis=

#定义缓存管理器
cacheManager=org.iherus.shiro.cache.redis.RedisCacheManager
cacheManager.connectionFactory=$connectionFactory
cacheManager.expirationMillis=900000
cacheManager.keyPrefix=shiro:test:cache:
#cacheManager.scanBatchSize=3000
#cacheManager.deleteBatchSize=5000
#cacheManager.fetchBatchSize=50
#cacheManager.database=5

#将凭证匹配器设置到realm
customRealm=org.iherus.shiro.tester.CustomRealm
customRealm.credentialsMatcher=$credentialsMatcher
securityManager.realms=$customRealm
securityManager.cacheManager=$cacheManager

详细测试代码请看:src/test/java/org/iherus/shiro /tester/SimpleCacheTest.java

2、Spring集成的方式

    <!-- SHIRO安全管理器 -->
    <bean id="securityManager" class="org.apache.shiro.web.mgt.DefaultWebSecurityManager">
        <property name="realm" ref="userRealm" />
        <property name="cacheManager" ref="cacheManager" />
        <property name="rememberMeManager" ref="rememberMeManager" />
        <property name="sessionManager" ref="sessionManager" />
    </bean>

    <!-- 用户域 -->
    <bean id="userRealm" class="org.iherus.shiro.tester.CustomRealm" />

    <!-- 会话管理器-->
    <bean id="sessionManager" class="org.apache.shiro.web.session.mgt.DefaultWebSessionManager">
        <property name="sessionDAO" ref="sessionDAO" />
        <property name="globalSessionTimeout" value="${shiro.globalSessionTimeout}" />
        <property name="deleteInvalidSessions" value="${shiro.deleteInvalidSessions}" />
        <property name="sessionValidationInterval" value="${shiro.sessionValidationInterval}" />
    </bean>

    <!-- sessionDAO-->
    <bean id="sessionDAO" class=" org.iherus.shiro.cache.redis.RedisSessionDAO">
	<property name="cacheManager" ref="cacheManager" />
    </bean>

    <!-- 记住登录管理器 -->
    <bean id="rememberMeManager" class="org.apache.shiro.web.mgt.CookieRememberMeManager">
        <property name="cookie" ref="rememberMeCookie" />
    </bean>

    <!-- Cookie对象 -->
    <bean id="rememberMeCookie" class="org.apache.shiro.web.servlet.SimpleCookie">
        <property name="name" value="${shiro.cookieName}" />
        <property name="maxAge" value="${shiro.cookieMaxAge}" />
    </bean>

    <!-- 缓存管理器 -->
    <bean id="cacheManager" class="org.iherus.shiro.cache.redis.RedisCacheManager">
        <property name="connectionFactory" ref="connectionFactory" />
        <property name="database" value="2" />
        <property name="expirationMillis" value="90000" />
        <property name="keyPrefix" value="shiro:cache:" />
        <property name="scanBatchSize" value="3000" />
        <property name="deleteBatchSize" value="5000" />
        <property name="fetchBatchSize" value="50" />
    </bean>

    <!-- Redis连接工厂 -->
    <bean id="connectionFactory" class="org.iherus.shiro.cache.redis.connection.jedis.JedisConnectionFactory">
	<property name="clientName" value="SRC" />
	<property name="connectTimeoutMillis" value="3000" />
	<property name="soTimeoutMillis" value="2000" />
	<property name="poolConfig" ref="poolConfig" />
	<property name="configuration" ref="standaloneConfiguration" />
	<!-- <property name="configuration" ref="sentinelConfiguration" /> -->
	<!-- <property name="configuration" ref="clusterConfiguration" />  -->
    </bean>

    <!-- Redis单机配置 -->
    <bean id="standaloneConfiguration" class="org.iherus.shiro.cache.redis.config.RedisStandaloneConfiguration">
	<property name="host" value="127.0.0.1" />
	<property name="port" value="6379" />
	<property name="database" value="0" />
	<!-- <property name="password" value="" /> -->
    </bean>

    <!-- Redis哨兵配置 -->
    <bean id="sentinelConfiguration" class="org.iherus.shiro.cache.redis.config.RedisSentinelConfiguration">
	<property name="masterName" value="mymaster" />
	<property name="sentinelsFromText" value="127.0.0.1:56379,127.0.0.1:56479,127.0.0.1:56579" />
	<!-- <property name="password" value="" /> -->
    </bean>

    <!-- Redis集群配置 -->
    <bean id="clusterConfiguration" class="org.iherus.shiro.cache.redis.config.RedisClusterConfiguration">
	<property name="clusterNodesFromText" value="127.0.0.1:16379,127.0.0.1:16380,127.0.0.1:16381..." />
	<property name="maxAttempts" value="5" />
	<!-- <property name="password" value="" /> -->
    </bean>

    <!-- 配置缓存连接池 -->
    <bean id="poolConfig" class="redis.clients.jedis.JedisPoolConfig">
        <property name="minIdle" value="${redis.minIdle}" />
        <property name="maxIdle" value="${redis.maxIdle}" />
        <property name="maxWaitMillis" value="${redis.maxWaitMillis}" />
        <property name="maxTotal" value="${redis.maxTotal}" />
    </bean>

3、Spring Boot集成的方式

3-1)引入Spring Boot Starter依赖项:

        <dependency>
            <groupId>org.iherus.shiro</groupId>
            <artifactId>shiro-redis-spring-boot-web-starter</artifactId>
            <version>{latestVersion}</version>
        </dependency>

$\color{red}{注意:由于客户端工具是可选依赖,所以,请根据需要引入相应依赖,支持jedis、lettuce、redisson和spring-data-redis,}$
$\color{red}{如若使用lettuce,还需要再引入commons-pool2。}$

3-2)默认情况下,shiro-redis-spring-boot-web-starter会自动创建 RedisCacheManager 和 RedisSessionDAO 实例并注入 WebSecurityManager 和 WebSessionManager中,如果您需要自定义 SecurityManager 和 SessionManager。
示例如下:

    @Bean
    public SessionManager sessionManager(SessionDAO sessionDAO) {
        DefaultWebSessionManager webSessionManager = new DefaultWebSessionManager();
        
        // 注入RedisSessionDAO实例
        webSessionManager.setSessionDAO(sessionDAO);
        
        .....other.....

        return webSessionManager;
    }

    @Bean
    public DefaultWebSecurityManager securityManager(SessionManager sessionManager, CacheManager cacheManager, List<Realm> realms) {
        DefaultWebSecurityManager securityManager = new DefaultWebSecurityManager();
        // 注入SessionManager实例
        securityManager.setSessionManager(sessionManager);
        
        // 注入cacheManager实例
        securityManager.setCacheManager(cacheManager != null ? cacheManager : new MemoryConstrainedCacheManager());

        securityManager.setRealms(realms);

        .....other.....

        return securityManager;
    }

3-3)SSL相关配置,提供了接口:JedisSslClientConfigurationCustomizer、LettuceClientConfigurationCustomizer、RedissonSslClientConfigurationCustomizer,可根据需要去实现定制器,并注册Bean。
示例如下:

    @Bean
    public JedisSslClientConfigurationCustomizer JedisSslClientConfigurationCustomizer() {
        return ((builder) -> {
            ....SSL配置....
        });
    }

3-4)配置属性

属性项 缺省 描述
基本配置
shiro.redis.host localhost 主机名
shiro.redis.port 6379 端口
shiro.redis.database 0 数据库
shiro.redis.password 密码
shiro.redis.sentinel.master-name 哨兵模式中主节点名称
shiro.redis.sentinel.nodes 哨兵节点地址串,逗号分隔,eg:127.0.0.1:56379,127.0.0.1:56479,127.0.0.1:56579
shiro.redis.cluster.max-attempts 5 最大重试次数
shiro.redis.cluster.nodes 集群节点地址串,逗号分隔,eg: 127.0.0.1:16379,127.0.0.1:16380,127.0.0.1:16381...
Jedis
shiro.redis.jedis.client-name 客户端名称
shiro.redis.jedis.connect-timeout 2000ms 连接超时
shiro.redis.jedis.so-timeout 2000ms 读取超时
shiro.redis.jedis.ssl false 是否启用SSL
shiro.redis.jedis.pool.min-idle 3
shiro.redis.jedis.pool.max-idle 8
shiro.redis.jedis.pool.max-total 8
shiro.redis.jedis.pool.max-wait-millis 90000
shiro.redis.jedis.pool.min-evictable-idle-time-millis 60000
shiro.redis.jedis.pool.test-on-borrow false
shiro.redis.jedis.pool.test-while-idle true
shiro.redis.jedis.pool.time-between-eviction-runs-millis 30000
shiro.redis.jedis.pool.num-tests-per-eviction-run -1
Lettuce
shiro.redis.lettuce.client-name 客户端名称
shiro.redis.lettuce.read-from 读操作节点偏好
shiro.redis.lettuce.ssl false 是否启用SSL
shiro.redis.lettuce.verify-peer true 是否启用SSL证书校验
shiro.redis.lettuce.start-tls false 是否启用StartTLS
shiro.redis.lettuce.pool.min-idle 3
shiro.redis.lettuce.pool.max-idle 8
shiro.redis.lettuce.pool.max-total 8
shiro.redis.lettuce.pool.max-wait-millis 90000
shiro.redis.lettuce.pool.min-evictable-idle-time-millis 60000
shiro.redis.lettuce.pool.test-on-borrow false
shiro.redis.lettuce.pool.test-while-idle true
shiro.redis.lettuce.pool.time-between-eviction-runs-millis 30000
shiro.redis.lettuce.pool.num-tests-per-eviction-run -1
Redisson
shiro.redis.redisson.client-name 客户端名称
shiro.redis.redisson.connect-timeout 10000ms 连接超时
shiro.redis.redisson.connection-min-idle-size 8 最少空闲连接数
shiro.redis.redisson.connection-pool-size 32 连接池大小
shiro.redis.redisson.so-timeout 3000ms 读取超时
shiro.redis.redisson.ssl false 是否启用SSL
Shiro缓存配置
shiro.redis.cache.batch-options.delete-batch-size 5000 批量删除数量
shiro.redis.cache.batch-options.fetch-batch-size 50 批量获取数量
shiro.redis.cache.batch-options.scan-batch-size 3000 每批次扫描数量
shiro.redis.cache.database 0 shiro缓存数据库
shiro.redis.cache.expiration PT15M shiro缓存失效时长
shiro.redis.cache.key-prefix shiro:cache: shiro缓存键前缀

4、关于缓存key的特别说明

    针对非 byte[] 和 String 类型的缓存key,采用的是生成MD5作为key的策略,这样就要求AuthorizingRealm#doGetAuthenticationInfo返回的[PrincipalCollection principals]必须是一成不变的,这样一来,如果后续需要动态修改principals的属性,则会导致缓存key的变化。

所以,建议重写这两个方法来应对这种变化:

1)AuthorizingRealm #getAuthorizationCacheKey(PrincipalCollection principals)
2)AuthorizingRealm #getAuthenticationCacheKey(PrincipalCollection principals)

eg:

	/**
	 * 建议重写此方法,提供唯一的缓存Key
	 */
	@Override
	protected Object getAuthorizationCacheKey(PrincipalCollection principals) {
		return this.getAuthenticationCacheKey(principals);
	}

	/**
	 * 建议重写此方法,提供唯一的缓存Key
	 */
	@SuppressWarnings("unchecked")
	@Override
	protected Object getAuthenticationCacheKey(PrincipalCollection principals) {
		StringBuilder sb = new StringBuilder();
		principals.forEach(principal -> {
			sb.append(((User) principal).getId());
		});

		return sb.toString();
	}

更多正在补充中。。。。。 :smile:

Features

欢迎提出更好的意见,帮助完善 shiro-redis

Copyright

Apache License, Version 2.0

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: You must give any other recipients of the Work or Derivative Works a copy of this License; and You must cause any modified files to carry prominent notices stating that You changed the files; and You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2016 bosco_liao Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

基于Redis的shiro集中式缓存解决方案 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/BYSRepo/shiro-redis.git
git@gitee.com:BYSRepo/shiro-redis.git
BYSRepo
shiro-redis
shiro-redis
master

搜索帮助

14c37bed 8189591 565d56ea 8189591