第十一章 緩存機制——《跟我學Shiro》[張開濤]

Shiro提供了類似於Spring的Cache抽象，即Shiro本身不實現Cache，但是對Cache進行了又抽象，方便更換不同的底層Cache實現。對於Cache的一些概念可以參考我的《Spring Cache抽象詳解》：http://jinnianshilongnian.iteye.com/blog/2001040。

 

Shiro提供的Cache接口： 

Java代碼  

1. public interface Cache<K, V> {  
2.     //根據Key獲取緩存中的值  
3.     public V get(K key) throws CacheException;  
4.     //往緩存中放入key-value，返回緩存中之前的值  
5.     public V put(K key, V value) throws CacheException;   
6.     //移除緩存中key對應的值，返回該值  
7.     public V remove(K key) throws CacheException;  
8.     //清空整個緩存  
9.     public void clear() throws CacheException;  
10.     //返回緩存大小  
11.     public int size();  
12.     //獲取緩存中所有的key  
13.     public Set<K> keys();  
14.     //獲取緩存中所有的value  
15.     public Collection<V> values();  
16. }  

  

Shiro提供的CacheManager接口： 

Java代碼  

1. public interface CacheManager {  
2.     //根據緩存名字獲取一個Cache  
3.     public <K, V> Cache<K, V> getCache(String name) throws CacheException;  
4. }  

  

Shiro還提供了CacheManagerAware用於注入CacheManager： 

Java代碼  

1. public interface CacheManagerAware {  
2.     //注入CacheManager  
3.     void setCacheManager(CacheManager cacheManager);  
4. }  

 

Shiro內部相應的組件（DefaultSecurityManager）會自動檢測相應的對象（如Realm）是否實現了CacheManagerAware並自動注入相應的CacheManager。

  

本章用例使用了與第六章的代碼。

 

Realm緩存

Shiro提供了CachingRealm，其實現了CacheManagerAware接口，提供了緩存的一些基礎實現；另外AuthenticatingRealm及AuthorizingRealm分別提供了對AuthenticationInfo 和AuthorizationInfo信息的緩存。

 

ini配置   

Java代碼  

1. userRealm=com.github.zhangkaitao.shiro.chapter11.realm.UserRealm  
2. userRealm.credentialsMatcher=$credentialsMatcher  
3. userRealm.cachingEnabled=true  
4. userRealm.authenticationCachingEnabled=true  
5. userRealm.authenticationCacheName=authenticationCache  
6. userRealm.authorizationCachingEnabled=true  
7. userRealm.authorizationCacheName=authorizationCache  
8. securityManager.realms=$userRealm  
9.   
10. cacheManager=org.apache.shiro.cache.ehcache.EhCacheManager  
11. cacheManager.cacheManagerConfigFile=classpath:shiro-ehcache.xml  
12. 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代碼  

1. @Test  
2. public void testClearCachedAuthenticationInfo() {  
3.     login(u1.getUsername(), password);  
4.     userService.changePassword(u1.getId(), password + "1");  
5.   
6.     RealmSecurityManager securityManager =  
7.      (RealmSecurityManager) SecurityUtils.getSecurityManager();  
8.     UserRealm userRealm = (UserRealm) securityManager.getRealms().iterator().next();  
9.     userRealm.clearCachedAuthenticationInfo(subject().getPrincipals());  
10.   
11.     login(u1.getUsername(), password + "1");  
12. }   

首先登錄成功（此時會緩存相應的AuthenticationInfo），然後修改密碼；此時密碼就變了；接着需要調用Realm的clearCachedAuthenticationInfo方法清空之前緩存的AuthenticationInfo；否則下次登錄時還會獲取到修改密碼之前的那個AuthenticationInfo；

 

Java代碼  

1. @Test  
2. public void testClearCachedAuthorizationInfo() {  
3.     login(u1.getUsername(), password);  
4.     subject().checkRole(r1.getRole());  
5.     userService.correlationRoles(u1.getId(), r2.getId());  
6.   
7.     RealmSecurityManager securityManager =  
8.       (RealmSecurityManager) SecurityUtils.getSecurityManager();  
9.     UserRealm userRealm = (UserRealm)securityManager.getRealms().iterator().next();  
10.     userRealm.clearCachedAuthorizationInfo(subject().getPrincipals());  
11.   
12.     subject().checkRole(r2.getRole());  
13. }   

和之前的用例差不多；此處調用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緩存

當我們設置了SecurityManager的CacheManager時，如：

Java代碼  

1. securityManager.cacheManager=$cacheManager  

 

當我們設置SessionManager時：

Java代碼  

1. sessionManager=org.apache.shiro.session.mgt.DefaultSessionManager  
2. securityManager.sessionManager=$sessionManager   

如securityManager實現了SessionsSecurityManager，其會自動判斷SessionManager是否實現了CacheManagerAware接口，如果實現了會把CacheManager設置給它。然後sessionManager會判斷相應的sessionDAO（如繼承自CachingSessionDAO）是否實現了CacheManagerAware，如果實現了會把CacheManager設置給它；如第九章的MySessionDAO就是帶緩存的SessionDAO；其會先查緩存，如果找不到才查數據庫。

 

對於CachingSessionDAO，可以通過如下配置設置緩存的名稱：

Java代碼  

1. sessionDAO=com.github.zhangkaitao.shiro.chapter11.session.dao.MySessionDAO  
2. sessionDAO.activeSessionsCacheName=shiro-activeSessionCache   

activeSessionsCacheName默認就是shiro-activeSessionCache。

 

 

示例源代碼：https://github.com/zhangkaitao/shiro-example；可加羣 231889722 探討Spring/Shiro技術。