shiro缓存机实例代码
<p>Shiro提供了类似于Spring的Cache抽象,即Shiro本身不实现Cache,但是对Cache进行了又抽象,方便更换不同的底层Cache实现。 </p>
<p>
Shiro提供的Cache接口: </p>
<p>
Java代码 </p>
<div class="jb51code">
<div>
<div class="syntaxhighlighterjava" id="highlighter_450402">
<div class="toolbar">
<span>?</span>
</div>
<table border="0" cellpadding="0" cellspacing="0"><tbody><tr>
<td class="gutter">
<div class="line number1 index0 alt2">
1</div>
<div class="line number2 index1 alt1">
2</div>
<div class="line number3 index2 alt2">
3</div>
<div class="line number4 index3 alt1">
4</div>
<div class="line number5 index4 alt2">
5</div>
<div class="line number6 index5 alt1">
6</div>
<div class="line number7 index6 alt2">
7</div>
<div class="line number8 index7 alt1">
8</div>
<div class="line number9 index8 alt2">
9</div>
<div class="line number10 index9 alt1">
10</div>
<div class="line number11 index10 alt2">
11</div>
<div class="line number12 index11 alt1">
12</div>
<div class="line number13 index12 alt2">
13</div>
<div class="line number14 index13 alt1">
14</div>
<div class="line number15 index14 alt2">
15</div>
<div class="line number16 index15 alt1">
16</div>
</td>
<td class="code">
<div class="container">
<div class="line number1 index0 alt2">
<code class="java keyword">public</code> <code class="java keyword">interface</code> <code class="java plain">Cache<K, V> { </code>
</div>
<div class="line number2 index1 alt1">
<code class="java spaces"> </code><code class="java comments">//根据Key获取缓存中的值 </code>
</div>
<div class="line number3 index2 alt2">
<code class="java spaces"> </code><code class="java keyword">public</code> <code class="java plain">V get(K key) </code><code class="java keyword">throws</code> <code class="java plain">CacheException; </code>
</div>
<div class="line number4 index3 alt1">
<code class="java spaces"> </code><code class="java comments">//往缓存中放入key-value,返回缓存中之前的值 </code>
</div>
<div class="line number5 index4 alt2">
<code class="java spaces"> </code><code class="java keyword">public</code> <code class="java plain">V put(K key, V value) </code><code class="java keyword">throws</code> <code class="java plain">CacheException; </code>
</div>
<div class="line number6 index5 alt1">
<code class="java spaces"> </code><code class="java comments">//移除缓存中key对应的值,返回该值 </code>
</div>
<div class="line number7 index6 alt2">
<code class="java spaces"> </code><code class="java keyword">public</code> <code class="java plain">V remove(K key) </code><code class="java keyword">throws</code> <code class="java plain">CacheException; </code>
</div>
<div class="line number8 index7 alt1">
<code class="java spaces"> </code><code class="java comments">//清空整个缓存 </code>
</div>
<div class="line number9 index8 alt2">
<code class="java spaces"> </code><code class="java keyword">public</code> <code class="java keyword">void</code> <code class="java plain">clear() </code><code class="java keyword">throws</code> <code class="java plain">CacheException; </code>
</div>
<div class="line number10 index9 alt1">
<code class="java spaces"> </code><code class="java comments">//返回缓存大小 </code>
</div>
<div class="line number11 index10 alt2">
<code class="java spaces"> </code><code class="java keyword">public</code> <code class="java keyword">int</code> <code class="java plain">size(); </code>
</div>
<div class="line number12 index11 alt1">
<code class="java spaces"> </code><code class="java comments">//获取缓存中所有的key </code>
</div>
<div class="line number13 index12 alt2">
<code class="java spaces"> </code><code class="java keyword">public</code> <code class="java plain">Set<K> keys(); </code>
</div>
<div class="line number14 index13 alt1">
<code class="java spaces"> </code><code class="java comments">//获取缓存中所有的value </code>
</div>
<div class="line number15 index14 alt2">
<code class="java spaces"> </code><code class="java keyword">public</code> <code class="java plain">Collection<V> values(); </code>
</div>
<div class="line number16 index15 alt1">
<code class="java plain">}</code>
</div>
</div>
</td>
</tr></tbody></table>
</div>
</div>
<div class="codetool" id="codetool">
<div class="code_n">
<textarea></textarea>
</div>
</div>
</div>
<p>
Shiro提供的CacheManager接口: </p>
<p>
Java代码 </p>
<div class="jb51code">
<div>
<div class="syntaxhighlighterjava" id="highlighter_564396">
<div class="toolbar">
<span>?</span>
</div>
<table border="0" cellpadding="0" cellspacing="0"><tbody><tr>
<td class="gutter">
<div class="line number1 index0 alt2">
1</div>
<div class="line number2 index1 alt1">
2</div>
<div class="line number3 index2 alt2">
3</div>
<div class="line number4 index3 alt1">
4</div>
</td>
<td class="code">
<div class="container">
<div class="line number1 index0 alt2">
<code class="java keyword">public</code> <code class="java keyword">interface</code> <code class="java plain">CacheManager { </code>
</div>
<div class="line number2 index1 alt1">
<code class="java spaces"> </code><code class="java comments">//根据缓存名字获取一个Cache </code>
</div>
<div class="line number3 index2 alt2">
<code class="java spaces"> </code><code class="java keyword">public</code> <code class="java plain"><K, V> Cache<K, V> getCache(String name) </code><code class="java keyword">throws</code> <code class="java plain">CacheException; </code>
</div>
<div class="line number4 index3 alt1">
<code class="java plain">}</code>
</div>
</div>
</td>
</tr></tbody></table>
</div>
</div>
<br><div class="codetool" id="codetool">
<div class="code_n">
<textarea></textarea>
</div>
</div>
</div>
<p>
Shiro还提供了CacheManagerAware用于注入CacheManager: </p>
<p>
Java代码 </p>
<div class="jb51code">
<div>
<div class="syntaxhighlighterjava" id="highlighter_111959">
<div class="toolbar">
<span>?</span>
</div>
<table border="0" cellpadding="0" cellspacing="0"><tbody><tr>
<td class="gutter">
<div class="line number1 index0 alt2">
1</div>
<div class="line number2 index1 alt1">
2</div>
<div class="line number3 index2 alt2">
3</div>
<div class="line number4 index3 alt1">
4</div>
</td>
<td class="code">
<div class="container">
<div class="line number1 index0 alt2">
<code class="java keyword">public</code> <code class="java keyword">interface</code> <code class="java plain">CacheManagerAware { </code>
</div>
<div class="line number2 index1 alt1">
<code class="java spaces"> </code><code class="java comments">//注入CacheManager </code>
</div>
<div class="line number3 index2 alt2">
<code class="java spaces"> </code><code class="java keyword">void</code> <code class="java plain">setCacheManager(CacheManager cacheManager); </code>
</div>
<div class="line number4 index3 alt1">
<code class="java plain">}</code>
</div>
</div>
</td>
</tr></tbody></table>
</div>
</div>
<div class="codetool" id="codetool">
<div class="code_n">
<textarea></textarea>
</div>
</div>
</div>
<p>
Shiro内部相应的组件(DefaultSecurityManager)会自动检测相应的对象(如Realm)是否实现了CacheManagerAware并自动注入相应的CacheManager。 </p>
<p>
<span><strong>Realm缓存</strong></span></p>
<p>
Shiro提供了CachingRealm,其实现了CacheManagerAware接口,提供了缓存的一些基础实现;另外AuthenticatingRealm及AuthorizingRealm分别提供了对AuthenticationInfo 和AuthorizationInfo信息的缓存。 </p>
<p>
<span><strong>ini配置 </strong></span></p>
<p>
Java代码 </p>
<div class="jb51code">
<div>
<div class="syntaxhighlighterjava" id="highlighter_407571">
<div class="toolbar">
<span>?</span>
</div>
<table border="0" cellpadding="0" cellspacing="0"><tbody><tr>
<td class="gutter">
<div class="line number1 index0 alt2">
1</div>
<div class="line number2 index1 alt1">
2</div>
<div class="line number3 index2 alt2">
3</div>
<div class="line number4 index3 alt1">
4</div>
<div class="line number5 index4 alt2">
5</div>
<div class="line number6 index5 alt1">
6</div>
<div class="line number7 index6 alt2">
7</div>
<div class="line number8 index7 alt1">
8</div>
<div class="line number9 index8 alt2">
9</div>
<div class="line number10 index9 alt1">
10</div>
<div class="line number11 index10 alt2">
11</div>
</td>
<td class="code">
<div class="container">
<div class="line number1 index0 alt2">
<code class="java plain">userRealm=com.github.zhangkaitao.shiro.chapter11.realm.UserRealm </code>
</div>
<div class="line number2 index1 alt1">
<code class="java plain">userRealm.credentialsMatcher=$credentialsMatcher </code>
</div>
<div class="line number3 index2 alt2">
<code class="java plain">userRealm.cachingEnabled=</code><code class="java keyword">true</code>
</div>
<div class="line number4 index3 alt1">
<code class="java plain">userRealm.authenticationCachingEnabled=</code><code class="java keyword">true</code>
</div>
<div class="line number5 index4 alt2">
<code class="java plain">userRealm.authenticationCacheName=authenticationCache</code>
</div>
<div class="line number6 index5 alt1">
<code class="java plain">userRealm.authorizationCachingEnabled=</code><code class="java keyword">true</code>
</div>
<div class="line number7 index6 alt2">
<code class="java plain">userRealm.authorizationCacheName=authorizationCache </code>
</div>
<div class="line number8 index7 alt1">
<code class="java plain">securityManager.realms=$userRealm </code>
</div>
<div class="line number9 index8 alt2">
<code class="java plain">cacheManager=org.apache.shiro.cache.ehcache.EhCacheManager </code>
</div>
<div class="line number10 index9 alt1">
<code class="java plain">cacheManager.cacheManagerConfigFile=classpath:shiro-ehcache.xml </code>
</div>
<div class="line number11 index10 alt2">
<code class="java plain">securityManager.cacheManager=$cacheManager</code>
</div>
</div>
</td>
</tr></tbody></table>
</div>
</div>
<div class="codetool" id="codetool">
<div class="code_n">
<textarea></textarea>
</div>
</div>
</div>
<p>
userRealm.cachingEnabled:启用缓存,默认false;<br>
userRealm.authenticationCachingEnabled:启用身份验证缓存,即缓存AuthenticationInfo信息,默认false;<br>
userRealm.authenticationCacheName:缓存AuthenticationInfo信息的缓存名称;<br>
userRealm. authorizationCachingEnabled:启用授权缓存,即缓存AuthorizationInfo信息,默认false;<br>
userRealm. authorizationCacheName:缓存AuthorizationInfo信息的缓存名称;</p>
<p>
cacheManager:缓存管理器,此处使用EhCacheManager,即Ehcache实现,需要导入相应的Ehcache依赖,请参考pom.xml; </p>
<p>
因为测试用例的关系,需要将Ehcache的CacheManager改为使用VM单例模式:</p>
<div class="jb51code">
<div>
<div class="syntaxhighlighterjava" id="highlighter_564942">
<div class="toolbar">
<span>?</span>
</div>
<table border="0" cellpadding="0" cellspacing="0"><tbody><tr>
<td class="gutter">
<div class="line number1 index0 alt2">
1</div>
</td>
<td class="code">
<div class="container">
<div class="line number1 index0 alt2">
<code class="java keyword">this</code><code class="java plain">.manager = </code><code class="java keyword">new</code> <code class="java plain">net.sf.ehcache.CacheManager(getCacheManagerConfigFileInputStream());</code>
</div>
</div>
</td>
</tr></tbody></table>
</div>
</div>
<div class="codetool" id="codetool">
<div class="code_n">
<textarea></textarea>
</div>
</div>
</div>
<p>
改为</p>
<div class="jb51code">
<div>
<div class="syntaxhighlighterjava" id="highlighter_611535">
<div class="toolbar">
<span>?</span>
</div>
<table border="0" cellpadding="0" cellspacing="0"><tbody><tr>
<td class="gutter">
<div class="line number1 index0 alt2">
1</div>
</td>
<td class="code">
<div class="container">
<div class="line number1 index0 alt2">
<code class="java keyword">this</code><code class="java plain">.manager = net.sf.ehcache.CacheManager.create(getCacheManagerConfigFileInputStream());</code>
</div>
</div>
</td>
</tr></tbody></table>
</div>
</div>
<div class="codetool" id="codetool">
<div class="code_n">
<textarea></textarea>
</div>
</div>
</div>
<p>
测试用例 </p>
<p>
Java代码 </p>
<div class="jb51code">
<div>
<div class="syntaxhighlighterjava" id="highlighter_626686">
<div class="toolbar">
<span>?</span>
</div>
<table border="0" cellpadding="0" cellspacing="0"><tbody><tr>
<td class="gutter">
<div class="line number1 index0 alt2">
1</div>
<div class="line number2 index1 alt1">
2</div>
<div class="line number3 index2 alt2">
3</div>
<div class="line number4 index3 alt1">
4</div>
<div class="line number5 index4 alt2">
5</div>
<div class="line number6 index5 alt1">
6</div>
<div class="line number7 index6 alt2">
7</div>
<div class="line number8 index7 alt1">
8</div>
<div class="line number9 index8 alt2">
9</div>
<div class="line number10 index9 alt1">
10</div>
<div class="line number11 index10 alt2">
11</div>
</td>
<td class="code">
<div class="container">
<div class="line number1 index0 alt2">
<code class="java color1">@Test</code>
</div>
<div class="line number2 index1 alt1">
<code class="java keyword">public</code> <code class="java keyword">void</code> <code class="java plain">testClearCachedAuthenticationInfo() { </code>
</div>
<div class="line number3 index2 alt2">
<code class="java spaces"> </code><code class="java plain">login(u1.getUsername(), password); </code>
</div>
<div class="line number4 index3 alt1">
<code class="java spaces"> </code><code class="java plain">userService.changePassword(u1.getId(), password + </code><code class="java string">"1"</code><code class="java plain">); </code>
</div>
<div class="line number5 index4 alt2">
<code class="java spaces"> </code>
</div>
<div class="line number6 index5 alt1">
<code class="java spaces"> </code><code class="java plain">RealmSecurityManager securityManager = </code>
</div>
<div class="line number7 index6 alt2">
<code class="java spaces"> </code><code class="java plain">(RealmSecurityManager) SecurityUtils.getSecurityManager(); </code>
</div>
<div class="line number8 index7 alt1">
<code class="java spaces"> </code><code class="java plain">UserRealm userRealm = (UserRealm) securityManager.getRealms().iterator().next(); </code>
</div>
<div class="line number9 index8 alt2">
<code class="java spaces"> </code><code class="java plain">userRealm.clearCachedAuthenticationInfo(subject().getPrincipals()); </code>
</div>
<div class="line number10 index9 alt1">
<code class="java spaces"> </code><code class="java plain">login(u1.getUsername(), password + </code><code class="java string">"1"</code><code class="java plain">); </code>
</div>
<div class="line number11 index10 alt2">
<code class="java plain">}</code>
</div>
</div>
</td>
</tr></tbody></table>
</div>
</div>
<div class="codetool" id="codetool">
<div class="code_n">
<textarea></textarea>
</div>
</div>
</div>
<p>
首先登录成功(此时会缓存相应的AuthenticationInfo),然后修改密码;此时密码就变了;接着需要调用Realm的clearCachedAuthenticationInfo方法清空之前缓存的AuthenticationInfo;否则下次登录时还会获取到修改密码之前的那个AuthenticationInfo;</p>
<p>
Java代码 </p>
<div class="jb51code">
<div>
<div class="syntaxhighlighterjava" id="highlighter_715997">
<div class="toolbar">
<span>?</span>
</div>
<table border="0" cellpadding="0" cellspacing="0"><tbody><tr>
<td class="gutter">
<div class="line number1 index0 alt2">
1</div>
<div class="line number2 index1 alt1">
2</div>
<div class="line number3 index2 alt2">
3</div>
<div class="line number4 index3 alt1">
4</div>
<div class="line number5 index4 alt2">
5</div>
<div class="line number6 index5 alt1">
6</div>
<div class="line number7 index6 alt2">
7</div>
<div class="line number8 index7 alt1">
8</div>
<div class="line number9 index8 alt2">
9</div>
<div class="line number10 index9 alt1">
10</div>
<div class="line number11 index10 alt2">
11</div>
<div class="line number12 index11 alt1">
12</div>
</td>
<td class="code">
<div class="container">
<div class="line number1 index0 alt2">
<code class="java color1">@Test</code>
</div>
<div class="line number2 index1 alt1">
<code class="java keyword">public</code> <code class="java keyword">void</code> <code class="java plain">testClearCachedAuthorizationInfo() { </code>
</div>
<div class="line number3 index2 alt2">
<code class="java spaces"> </code><code class="java plain">login(u1.getUsername(), password); </code>
</div>
<div class="line number4 index3 alt1">
<code class="java spaces"> </code><code class="java plain">subject().checkRole(r1.getRole()); </code>
</div>
<div class="line number5 index4 alt2">
<code class="java spaces"> </code><code class="java plain">userService.correlationRoles(u1.getId(), r2.getId()); </code>
</div>
<div class="line number6 index5 alt1">
<code class="java spaces"> </code>
</div>
<div class="line number7 index6 alt2">
<code class="java spaces"> </code><code class="java plain">RealmSecurityManager securityManager = </code>
</div>
<div class="line number8 index7 alt1">
<code class="java spaces"> </code><code class="java plain">(RealmSecurityManager) SecurityUtils.getSecurityManager(); </code>
</div>
<div class="line number9 index8 alt2">
<code class="java spaces"> </code><code class="java plain">UserRealm userRealm = (UserRealm)securityManager.getRealms().iterator().next(); </code>
</div>
<div class="line number10 index9 alt1">
<code class="java spaces"> </code><code class="java plain">userRealm.clearCachedAuthorizationInfo(subject().getPrincipals()); </code>
</div>
<div class="line number11 index10 alt2">
<code class="java spaces"> </code><code class="java plain">subject().checkRole(r2.getRole()); </code>
</div>
<div class="line number12 index11 alt1">
<code class="java plain">}</code>
</div>
</div>
</td>
</tr></tbody></table>
</div>
</div>
<div class="codetool" id="codetool">
<div class="code_n">
<textarea></textarea>
</div>
</div>
</div>
<p>
和之前的用例差不多;此处调用Realm的clearCachedAuthorizationInfo清空之前缓存的AuthorizationInfo; </p>
<p>
另外还有clearCache,其同时调用clearCachedAuthenticationInfo和clearCachedAuthorizationInfo,清空AuthenticationInfo和AuthorizationInfo。 </p>
<p>
UserRealm还提供了clearAllCachedAuthorizationInfo、clearAllCachedAuthenticationInfo、clearAllCache,用于清空整个缓存。</p>
<p>
在某些清空下这种方式可能不是最好的选择,可以考虑直接废弃Shiro的缓存,然后自己通过如AOP机制实现自己的缓存;可以参考:</p>
<p>
https://github.com/zhangkaitao/es/tree/master/web/src/main/java/com/sishuok/es/extra/aop</p>
<p>
另外如果和Spring集成时可以考虑直接使用Spring的Cache抽象,可以考虑使用SpringCacheManagerWrapper,其对Spring Cache进行了包装,转换为Shiro的CacheManager实现:</p>
<p>
https://github.com/zhangkaitao/es/blob/master/web/src/main/java/org/apache/shiro/cache/spring/SpringCacheManagerWrapper.java </p>
<p>
<span><strong>Session缓存</strong></span></p>
<p>
当我们设置了SecurityManager的CacheManager时,如:</p>
<p>
Java代码 </p>
<div class="jb51code">
<div>
<div class="syntaxhighlighterjava" id="highlighter_60649">
<div class="toolbar">
<span>?</span>
</div>
<table border="0" cellpadding="0" cellspacing="0"><tbody><tr>
<td class="gutter">
<div class="line number1 index0 alt2">
1</div>
</td>
<td class="code">
<div class="container">
<div class="line number1 index0 alt2">
<code class="java plain">securityManager.cacheManager=$cacheManager</code>
</div>
</div>
</td>
</tr></tbody></table>
</div>
</div>
<br><div class="codetool" id="codetool">
<div class="code_n">
<textarea></textarea>
</div>
</div>
</div>
<p>
当我们设置SessionManager时:</p>
<p>
Java代码 </p>
<div class="jb51code">
<div>
<div class="syntaxhighlighterjava" id="highlighter_856063">
<div class="toolbar">
<span>?</span>
</div>
<table border="0" cellpadding="0" cellspacing="0"><tbody><tr>
<td class="gutter">
<div class="line number1 index0 alt2">
1</div>
<div class="line number2 index1 alt1">
2</div>
</td>
<td class="code">
<div class="container">
<div class="line number1 index0 alt2">
<code class="java plain">sessionManager=org.apache.shiro.session.mgt.DefaultSessionManager </code>
</div>
<div class="line number2 index1 alt1">
<code class="java plain">securityManager.sessionManager=$sessionManager</code>
</div>
</div>
</td>
</tr></tbody></table>
</div>
</div>
<div class="codetool" id="codetool">
<div class="code_n">
<textarea></textarea>
</div>
</div>
</div>
<p>
如securityManager实现了SessionsSecurityManager,其会自动判断SessionManager是否实现了CacheManagerAware接口,如果实现了会把CacheManager设置给它。然后sessionManager会判断相应的sessionDAO(如继承自CachingSessionDAO)是否实现了CacheManagerAware,如果实现了会把CacheManager设置给它;如第九章的MySessionDAO就是带缓存的SessionDAO;其会先查缓存,如果找不到才查数据库。</p>
<p>
对于CachingSessionDAO,可以通过如下配置设置缓存的名称:</p>
<p>
Java代码 </p>
<div class="jb51code">
<div>
<div class="syntaxhighlighterjava" id="highlighter_610475">
<div class="toolbar">
<span>?</span>
</div>
<table border="0" cellpadding="0" cellspacing="0"><tbody><tr>
<td class="gutter">
<div class="line number1 index0 alt2">
1</div>
<div class="line number2 index1 alt1">
2</div>
<div class="line number3 index2 alt2">
3</div>
</td>
<td class="code">
<div class="container">
<div class="line number1 index0 alt2">
<code class="java plain">sessionDAO=com.github.zhangkaitao.shiro.chapter11.session.dao.MySessionDAO </code>
</div>
<div class="line number2 index1 alt1">
<code class="java plain">sessionDAO.activeSessionsCacheName=shiro-activeSessionCache </code>
</div>
<div class="line number3 index2 alt2">
<code class="java plain">activeSessionsCacheName默认就是shiro-activeSessionCache。</code>
</div>
</div>
</td>
</tr></tbody></table>
</div>
</div>
<div class="codetool" id="codetool">
<div class="code_n">
<textarea></textarea>
</div>
</div>
</div>
<p>
<span><strong>总结</strong></span></p>
<p>
以上所述是小编给大家介绍的shiro缓存机实例代码,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对网站的支持!</p>
<p>
原文链接:http://blog.sina.com.cn/s/blog_9c6852670102wwb3.html</p>
頁:
[1]