Shiro 入门教程 - Shiro 缓存机制

作者简介：大家好，我是smart哥，前中兴通讯、美团架构师，现某互联网公司CTO

联系qq：184480602，加我进群，大家一起学习，一起进步，一起对抗互联网寒冬

学习必须往深处挖，挖的越深，基础越扎实！

阶段1、深入多线程

阶段2、深入多线程设计模式

阶段3、深入juc源码解析

阶段4、深入jdk其余源码解析

阶段5、深入jvm源码解析

码哥源码部分

码哥讲源码-原理源码篇【2024年最新大厂关于线程池使用的场景题】

码哥讲源码【炸雷啦！炸雷啦！黄光头他终于跑路啦！】

码哥讲源码-【jvm课程前置知识及c/c++调试环境搭建】

​​​​​​码哥讲源码-原理源码篇【揭秘join方法的唤醒本质上决定于jvm的底层析构函数】

码哥源码-原理源码篇【Doug Lea为什么要将成员变量赋值给局部变量后再操作？】

码哥讲源码【你水不是你的错,但是你胡说八道就是你不对了！】

码哥讲源码【谁再说Spring不支持多线程事务，你给我抽他！】

终结B站没人能讲清楚红黑树的历史，不服等你来踢馆！

打脸系列【020-3小时讲解MESI协议和volatile之间的关系，那些将x86下的验证结果当作最终结果的水货们请闭嘴】

缓存机制

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

Shiro 提供的 Cache 接口 ：

    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 接口 ：

    public interface CacheManager {
        //根据缓存名字获取一个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）是否实现了 CacheManagerAware 并自动注入相应的 CacheManager。

本章用例使用了与第六章的代码。

Realm 缓存

Shiro 提供了 CachingRealm，其实现了 CacheManagerAware 接口，提供了缓存的一些基础实现；另外 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 实现，需要导入相应的 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，用于清空整个缓存。

Session 缓存

当我们设置了 SecurityManager 的 CacheManager 时，如：

securityManager.cacheManager=$cacheManager

当我们设置 SessionManager 时：

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

如 securityManager 实现了 SessionsSecurityManager，其会自动判断 SessionManager 是否实现了 CacheManagerAware 接口，如果实现了会把 CacheManager 设置给它。然后 sessionManager 会判断相应的 sessionDAO（如继承自 CachingSessionDAO）是否实现了 CacheManagerAware，如果实现了会把 CacheManager 设置给它；如第九章的 MySessionDAO 就是带缓存的 SessionDAO；其会先查缓存，如果找不到才查数据库。

对于 CachingSessionDAO，可以通过如下配置设置缓存的名称：

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

activeSessionsCacheName 默认就是 shiro-activeSessionCache。