shiro缓存机实例代码

转载  更新时间:2017年09月19日 15:59:23   作者:动力节点   我要评论

Shiro提供了类似于Spring的Cache抽象,即Shiro本身不实现Cache,但是对Cache进行了又抽象,方便更换不同的底层Cache实现

Shiro提供了类似于Spring的Cache抽象,即Shiro本身不实现Cache,但是对Cache进行了又抽象,方便更换不同的底层Cache实现。 

Shiro提供的Cache接口: 

Java代码  

public interface Cache<K, V> { 
 //根据Key获取缓存中的值 
 public V get(K key) throws CacheException; 
 //往缓存中放入key-value,返回缓存中之前的值 
 public V put(K key, V value) throws CacheException; 
 //移除缓存中key对应的值,返回该值 
 public V remove(K key) throws CacheException; 
 //清空整个缓存 
 public void clear() throws CacheException; 
 //返回缓存大小 
 public int size(); 
 //获取缓存中所有的key 
 public Set<K> keys(); 
 //获取缓存中所有的value 
 public Collection<V> values(); 
} 

Shiro提供的CacheManager接口: 

Java代码 

public interface CacheManager { 
 //根据缓存名字获取一个Cache 
 public <K, V> Cache<K, V> getCache(String name) throws CacheException; 
} 

Shiro还提供了CacheManagerAware用于注入CacheManager: 

Java代码  

public interface CacheManagerAware { 
 //注入CacheManager 
 void setCacheManager(CacheManager cacheManager); 
} 

Shiro内部相应的组件(DefaultSecurityManager)会自动检测相应的对象(如Realm)是否实现了CacheManagerAware并自动注入相应的CacheManager。  

Realm缓存

Shiro提供了CachingRealm,其实现了CacheManagerAware接口,提供了缓存的一些基础实现;另外AuthenticatingRealm及AuthorizingRealm分别提供了对AuthenticationInfo 和AuthorizationInfo信息的缓存。 

ini配置   

Java代码  

userRealm=com.github.zhangkaitao.shiro.chapter11.realm.UserRealm 
userRealm.credentialsMatcher=$credentialsMatcher 
userRealm.cachingEnabled=true 
userRealm.authenticationCachingEnabled=true 
userRealm.authenticationCacheName=authenticationCache
userRealm.authorizationCachingEnabled=true 
userRealm.authorizationCacheName=authorizationCache 
securityManager.realms=$userRealm 
cacheManager=org.apache.shiro.cache.ehcache.EhCacheManager 
cacheManager.cacheManagerConfigFile=classpath:shiro-ehcache.xml 
securityManager.cacheManager=$cacheManager 

userRealm.cachingEnabled:启用缓存,默认false;
userRealm.authenticationCachingEnabled:启用身份验证缓存,即缓存AuthenticationInfo信息,默认false;
userRealm.authenticationCacheName:缓存AuthenticationInfo信息的缓存名称;
userRealm. authorizationCachingEnabled:启用授权缓存,即缓存AuthorizationInfo信息,默认false;
userRealm. authorizationCacheName:缓存AuthorizationInfo信息的缓存名称;

cacheManager:缓存管理器,此处使用EhCacheManager,即Ehcache实现,需要导入相应的Ehcache依赖,请参考pom.xml; 

因为测试用例的关系,需要将Ehcache的CacheManager改为使用VM单例模式:

this.manager = new net.sf.ehcache.CacheManager(getCacheManagerConfigFileInputStream());

改为

this.manager = net.sf.ehcache.CacheManager.create(getCacheManagerConfigFileInputStream()); 

测试用例 

Java代码  

@Test 
public void testClearCachedAuthenticationInfo() { 
 login(u1.getUsername(), password); 
 userService.changePassword(u1.getId(), password + "1"); 
 
 RealmSecurityManager securityManager = 
  (RealmSecurityManager) SecurityUtils.getSecurityManager(); 
 UserRealm userRealm = (UserRealm) securityManager.getRealms().iterator().next(); 
 userRealm.clearCachedAuthenticationInfo(subject().getPrincipals()); 
 login(u1.getUsername(), password + "1"); 
} 

首先登录成功(此时会缓存相应的AuthenticationInfo),然后修改密码;此时密码就变了;接着需要调用Realm的clearCachedAuthenticationInfo方法清空之前缓存的AuthenticationInfo;否则下次登录时还会获取到修改密码之前的那个AuthenticationInfo;

Java代码  

@Test 
public void testClearCachedAuthorizationInfo() { 
 login(u1.getUsername(), password); 
 subject().checkRole(r1.getRole()); 
 userService.correlationRoles(u1.getId(), r2.getId()); 
 
 RealmSecurityManager securityManager = 
  (RealmSecurityManager) SecurityUtils.getSecurityManager(); 
 UserRealm userRealm = (UserRealm)securityManager.getRealms().iterator().next(); 
 userRealm.clearCachedAuthorizationInfo(subject().getPrincipals()); 
 subject().checkRole(r2.getRole()); 
} 

和之前的用例差不多;此处调用Realm的clearCachedAuthorizationInfo清空之前缓存的AuthorizationInfo; 

另外还有clearCache,其同时调用clearCachedAuthenticationInfo和clearCachedAuthorizationInfo,清空AuthenticationInfo和AuthorizationInfo。 

UserRealm还提供了clearAllCachedAuthorizationInfo、clearAllCachedAuthenticationInfo、clearAllCache,用于清空整个缓存。

在某些清空下这种方式可能不是最好的选择,可以考虑直接废弃Shiro的缓存,然后自己通过如AOP机制实现自己的缓存;可以参考:

https://github.com/zhangkaitao/es/tree/master/web/src/main/java/com/sishuok/es/extra/aop

另外如果和Spring集成时可以考虑直接使用Spring的Cache抽象,可以考虑使用SpringCacheManagerWrapper,其对Spring Cache进行了包装,转换为Shiro的CacheManager实现:

https://github.com/zhangkaitao/es/blob/master/web/src/main/java/org/apache/shiro/cache/spring/SpringCacheManagerWrapper.java  

Session缓存

当我们设置