Shiro 緩存機制

緩存機制

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

Shiro 提供的 Cache 接口：

public interface Cache<K, V> {
    //根據(jù)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 接口：

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

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

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

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

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

Realm 緩存

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

ini 配置

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 實現(xiàn)，需要導入相應的 Ehcache 依賴，請參考 pom.xml；

因為測試用例的關系，需要將 Ehcache 的 CacheManager 改為使用 VM 單例模式： this.manager = new net.sf.ehcache.CacheManager(getCacheManagerConfigFileInputStream())； 改為 this.manager = net.sf.ehcache.CacheManager.create(getCacheManagerConfigFileInputStream())；

測試用例

@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；

@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 機制實現(xiàn)自己的緩存；可以參考： https://github.com/zhangkaitao/es/tree/master/web/src/main/java/com/sishuok/es/extra/aop

另外如果和 Spring 集成時可以考慮直接使用 Spring 的 Cache 抽象，可以考慮使用 SpringCacheManagerWrapper，其對 Spring Cache 進行了包裝，轉換為 Shiro 的 CacheManager 實現(xiàn)：
https://github.com/zhangkaitao/es/blob/master/web/src/main/java/org/apache/shiro/cache/spring/SpringCacheManagerWrapper.java

Session 緩存

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

securityManager.cacheManager=$cacheManager

當我們設置 SessionManager 時：

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

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

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

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

activeSessionsCacheName 默認就是 shiro-activeSessionCache。