Springboot2集成Shiro框架（七）使用ehcache缓存

﹏ヽ暗。殇╰゛Y 2023-10-11 12:12 52阅读 0赞

### 目录 ###

*   *  1、pom.xml配置
     *  2、在核心启动类上新增开启缓存注解
     *  3、新增ehcache.xml
     *  4、ShiroConfig配置
     *  5、手动清除缓存
     *  6、源码

## 1、pom.xml配置 ##

*  新增 ***shiro-ehcache*** jar

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
      <modelVersion>4.0.0</modelVersion>
      <groupId>cn.junengxiong</groupId>
      <artifactId>springboot-shiro-ehcache</artifactId>
      <packaging>war</packaging>
      <version>0.0.1-SNAPSHOT</version>
      <name>springboot-shiro-ehcache Maven Webapp</name>
      <url>http://maven.apache.org</url>
      <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.0.4.RELEASE</version>
            <relativePath /> 
        </parent>
        <dependencies>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            
            <dependency>
                <groupId>org.apache.shiro</groupId>
                <artifactId>shiro-spring</artifactId>
                <version>1.4.0</version>
            </dependency>
            
            <dependency>
                <groupId>org.apache.shiro</groupId>
                <artifactId>shiro-ehcache</artifactId>
                <version>1.4.0</version>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-devtools</artifactId>
                <optional>true</optional>
                <scope>true</scope>
            </dependency>
        </dependencies>
      <build>
        <finalName>springboot-shiro-ehcache</finalName>
      </build>
    </project>

## 2、在核心启动类上新增开启缓存注解 ##

import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cache.annotation.EnableCaching;
    
    @EnableCaching//开启缓存
    @SpringBootApplication
    public class SpringBootApp { 
        public static void main(String[] args) { 
            SpringApplication.run(SpringBootApp.class, args);
        }
    }

## 3、新增ehcache.xml ##

在resources文件夹下新增ehcache.xml文件,该配置文件来自[这里][Link 1]。

<?xml version="1.0" encoding="UTF-8"?>
    <ehcache name="ehcache">
    
        
        <diskStore path="java.io.tmpdir"/>
    
        
        <defaultCache maxElementsInMemory="10000" eternal="false" timeToIdleSeconds="0" timeToLiveSeconds="0" overflowToDisk="false" diskPersistent="false" diskExpiryThreadIntervalSeconds="120" />
    
        
        <cache name="authorizationCache" maxEntriesLocalHeap="2000" eternal="false" timeToIdleSeconds="0" timeToLiveSeconds="0" overflowToDisk="false" statistics="true">
        </cache>
    
        
        <cache name="authenticationCache" maxEntriesLocalHeap="2000" eternal="false" timeToIdleSeconds="0" timeToLiveSeconds="0" overflowToDisk="false" statistics="true">
        </cache>
    
    </ehcache>

## 4、ShiroConfig配置 ##

*  新增 ***myEhCacheManager*** 方法
 *  修改 ***myShiroRealm***
 *  把 缓存交给管理器 ***securityManager***

/** * 自定义身份认证 realm; * <p> * 必须写这个类，并加上 @Bean 注解，目的是注入 MyShiroRealm， 否则会影响 MyShiroRealm类 中其他类的依赖注入 */
    	@Bean
    	public MyShiroRealm myShiroRealm() { 
    		MyShiroRealm myShiroRealm = new MyShiroRealm();
    		// 设置密码比较器
            myShiroRealm.setCredentialsMatcher(CredentialsMatcher());
    		// 启用身份验证缓存，即缓存AuthenticationInfo信息，默认false
    		myShiroRealm.setAuthenticationCachingEnabled(true);
    		// 缓存AuthenticationInfo信息的缓存名称 在ehcache-shiro.xml中有对应缓存的配置
    		myShiroRealm.setAuthenticationCacheName("authenticationCache");
    		// 启用授权缓存，即缓存AuthorizationInfo信息，默认false
    		myShiroRealm.setAuthorizationCachingEnabled(true);
    		// 缓存AuthorizationInfo信息的缓存名称 在ehcache-shiro.xml中有对应缓存的配置
    		myShiroRealm.setAuthorizationCacheName("authorizationCache");
    		return myShiroRealm;
    	}
    
    @Bean
    	public EhCacheManager myEhCacheManager() { 
    		CacheManager cacheManager = CacheManager.getCacheManager("ehcache");
    		EhCacheManager em = new EhCacheManager();
    		//因为配合springboot热启动，所以注入bean时加上此判断，不然会报错
    		if (ObjectUtils.isEmpty(cacheManager)) { 
    			em.setCacheManagerConfigFile("classpath:ehcache.xml");
    		} else { 
    			em.setCacheManager(cacheManager);
    		}
    		return em;
    	}
    
    /** * 注入 securityManager */
    	@Bean
    	public SecurityManager securityManager() { 
    		DefaultWebSecurityManager securityManager = new DefaultWebSecurityManager();
    		securityManager.setRealm(myShiroRealm());
    		securityManager.setRememberMeManager(rememberMeManager());
    		securityManager.setCacheManager(myEhCacheManager());// 将缓存管理交给ehCache
    		return securityManager;
    	}

## 5、手动清除缓存 ##

1.  在自定义realm中重写和新增部分方法

/** * 重写方法,清除当前用户的的 授权缓存 * @param principals */
        public void clearCachedAuthorizationInfo() { 
            super.clearCachedAuthorizationInfo(SecurityUtils.getSubject().getPrincipals());
        }
    
        /** * 重写方法，清除当前用户的 认证缓存 * @param principals */
        public void clearCachedAuthenticationInfo() { 
            super.clearCachedAuthenticationInfo(SecurityUtils.getSubject().getPrincipals());
        }
        /** * 清除某个用户认证和授权缓存 */
        @Override
        public void clearCache(PrincipalCollection principals) { 
            super.clearCache(principals);
        }
    
        /** * 自定义方法：清除所有 授权缓存 */
        public void clearAllCachedAuthorizationInfo() { 
            getAuthorizationCache().clear();
        }
    
        /** * 自定义方法：清除所有 认证缓存 */
        public void clearAllCachedAuthenticationInfo() { 
            getAuthenticationCache().clear();
        }
    
        /** * 自定义方法：清除所有的 认证缓存 和 授权缓存 */
        public void clearAllCache() { 
            clearAllCachedAuthenticationInfo();
            clearAllCachedAuthorizationInfo();
        }

1.  调用清除缓存方法,可以根据需求调用

RealmSecurityManager rsm = (RealmSecurityManager)SecurityUtils.getSecurityManager();  
            MyShiroRealm realm = (MyShiroRealm)rsm.getRealms().iterator().next(); 
            realm.clearCachedAuthenticationInfo();
            realm.clearCachedAuthorizationInfo();

## 6、源码 ##

*  需要源码可以[点击这里][Link 2]获取！

[Link 1]: https://blog.csdn.net/qq_34021712/article/details/80309246
[Link 2]: https://github.com/NewYao/springboot/tree/master/springboot-shiro-ehcache