spring 缓存的使用

水深无声 2022-03-19 05:43 228阅读 0赞

1.自动启动类 ：CacheAutoConfiguration

2.主启动类：@EnableCaching注解

3.属性配置：CacheProperties

4.pom配置

<dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-cache</artifactId>
    </dependency>

5.原理分析

自动启动类中的@Import({CacheAutoConfiguration.CacheConfigurationImportSelector.class})的CacheConfigurationImportSelector的类中有

static class CacheConfigurationImportSelector implements ImportSelector {
        CacheConfigurationImportSelector() {
        }
    
        public String[] selectImports(AnnotationMetadata importingClassMetadata) {
            CacheType[] types = CacheType.values();
            String[] imports = new String[types.length];
    //加载所需要缓存的cache
            for(int i = 0; i < types.length; ++i) {
                imports[i] = CacheConfigurations.getConfigurationClass(types[i]);
            }
    
            return imports;
        }
    }

加载结果：

org.springframework.boot.autoconfigure.cache.GenericCacheConfiguration  
   org.springframework.boot.autoconfigure.cache.JCacheCacheConfiguration  
   org.springframework.boot.autoconfigure.cache.EhCacheCacheConfiguration  
   org.springframework.boot.autoconfigure.cache.HazelcastCacheConfiguration  
   org.springframework.boot.autoconfigure.cache.InfinispanCacheConfiguration  
   org.springframework.boot.autoconfigure.cache.CouchbaseCacheConfiguration  
   org.springframework.boot.autoconfigure.cache.RedisCacheConfiguration  
   org.springframework.boot.autoconfigure.cache.CaffeineCacheConfiguration  
   org.springframework.boot.autoconfigure.cache.GuavaCacheConfiguration  
   org.springframework.boot.autoconfigure.cache.SimpleCacheConfiguration【默认】  
   org.springframework.boot.autoconfigure.cache.NoOpCacheConfiguration  
simpleCacheConfiguration类此方法中给容器中注册了一个CacheManager组件：类型为ConcurrentMapCacheManager

@Bean
    public ConcurrentMapCacheManager cacheManager() {
        ConcurrentMapCacheManager cacheManager = new ConcurrentMapCacheManager();
        List<String> cacheNames = this.cacheProperties.getCacheNames();
        if (!cacheNames.isEmpty()) {
            cacheManager.setCacheNames(cacheNames);
        }
        return (ConcurrentMapCacheManager)this.customizerInvoker.customize(cacheManager);
    }

ConcurrentMapCacheManager类中有getCache方法获取缓存
    @Nullable
    public Cache getCache(String name) { 
    //cacheMap 为ConcurrentMap  类型，获取一个cache组件
        Cache cache = (Cache)this.cacheMap.get(name);
        if (cache == null && this.dynamic) {
            ConcurrentMap var3 = this.cacheMap;
            synchronized(this.cacheMap) {
                cache = (Cache)this.cacheMap.get(name);
    //可以获取或者创建ConcurrentMapCache类型的缓存组件；他的作用将数据保存在ConcurrentMap中；
                if (cache == null) {
                    cache = this.createConcurrentMapCache(name);
                    this.cacheMap.put(name, cache);
                }
            }
        }
        return cache;
    }

@Cacheable工作流程：

@Cacheable：   1、方法运行之前，先去查询Cache（缓存组件），按照cacheNames指定的名字获取；           （CacheManager先获取相应的缓存），第一次获取缓存如果没有Cache组件会自动创建。   2、去Cache中查找缓存的内容(ConcurrentMapCache.lookup()方法中去查找)，使用一个key，默认就是方法的参数；   key是按照某种策略生成的；默认是使用keyGenerator生成的，默认使用SimpleKeyGenerator生成key； SimpleKeyGenerator生成key的默认策略；                         如果没有参数；key=new SimpleKey()；   如果有一个参数：key=参数的值       如果有多个参数：key=new SimpleKey(params)；

//这个方法  SimpleKeyGenerator.generateKey()    方法生成key
    public static Object generateKey(Object... params) {
       if (params.length == 0) {
          return SimpleKey.EMPTY;
       }
       if (params.length == 1) {  //如果只有一个参数，直接返回这个参数为key
          Object param = params[0];
          if (param != null && !param.getClass().isArray()) {
             return param;
          }
       }
       return new SimpleKey(params);
    }
     3、没有查到缓存就调用目标方法；        4、将目标方法返回的结果，放进缓存中ConcurrentMapCache.put();     
    
        @Cacheable标注的方法执行之前先来检查缓存中有没有这个数据，默认按照参数的值作为key去查询缓存，    如果没有就运行方法并将结果放入缓存；以后再来调用就可以直接使用缓存中的数据；
    
     核心：  1）、使用CacheManager【ConcurrentMapCacheManager】按照名字得到Cache【ConcurrentMapCache】组件       2）、key使用keyGenerator生成的，默认是SimpleKeyGenerator
    6.注解属性：
    cacheNames/value：指定缓存组件的名字;将方法的返回结果放在哪个缓存中，是数组的方式，可以指定 多个缓存；
    key：缓存数据使用的key；可以用它来指定。默认是使用方法参数的值  1-方法的返回值
    编写SpEL； #id;参数id的值   #a0  #p0  #root.args[0]
     getEmp[2]
    keyGenerator：key的生成器；可以自己指定key的生成器的组件id
    key/keyGenerator：二选一使用;
    cacheManager：指定缓存管理器；或者cacheResolver指定获取解析器
     condition：指定符合条件的情况下才缓存；,condition = "#id>0"
    condition = "#a0>1"：第一个参数的值》1的时候才进行缓存
    unless:否定缓存；当unless指定的条件为true，方法的返回值就不会被缓存；可以获取到结果进行判断
    unless = "#result == null"
    unless = "#a0==2":如果第一个参数的值是2，结果不缓存；
    sync：是否使用异步模式；异步模式的情况下unless不支持
    7.注解的使用
    @Cacheable查询使用缓存
    @Cacheable(cacheNames = "wn", key = "#gr")
    public Wn getWnData(String gr) {
        Wn wn = wnDao.selectByGr(gr);
        System.out.println("查询数据库");
        return wn;
    }
    @CachePut 更新缓存
    /**
        * @CachePut：既调用方法，又更新缓存数据；同步更新缓存
        * 修改了数据库的某个数据，同时更新缓存；
        * 运行时机：
        *  1、先调用目标方法
        *  2、将目标方法的结果缓存起来
        *
        * 测试步骤：
        *  1、查询1号员工；查到的结果会放在缓存中；
        *          key：1  value：lastName：张三
        *  2、以后查询还是之前的结果
        *  3、更新1号员工；【lastName:zhangsan；gender:0】
        *          将方法的返回值也放进缓存了；
        *          key：传入的xx对象  值：返回的xxx对象；
        *  4、查询1号员工？
        *      应该是更新后的员工；
        *          key = "#xxx.id":使用传入的参数的员工id；
        *          key = "#result.id"：使用返回后的id
        *             @Cacheable的key是不能用#result
        *      为什么是没更新前的？【1号员工没有在缓存中更新】
        *
        */
    @CachePut(value = "wn",key = "#result.gr")
    public Wn getWn(Wn wn) {
        int re = wnDao.edit(wn);
        System.out.println("查询数据库");
        return wn;
    }
    @CacheEvict 缓存清除
    /**
         * @CacheEvict：缓存清除
         *  key：指定要清除的数据
         *  allEntries = true：指定清除这个缓存中所有的数据
         *  beforeInvocation = false：缓存的清除是否在方法之前执行
         *      默认代表缓存清除操作是在方法执行之后执行;如果出现异常缓存就不会清除
         *
         *  beforeInvocation = true：
         *      代表清除缓存操作是在方法运行之前执行，无论方法是否出现异常，缓存都清除
         */
        @CacheEvict(value = "wn",beforeInvocation = true,key = "#gr")
        public String delWn(String gr) {
    //        int wn = wnDao.del(gr);
            System.out.println("del");
            return gr;
        }
    @Caching 复杂配置
    @Caching(
            cacheable = {
                    @Cacheable(/*value="wn",*/key = "#lastName")
                },
            put = {
                    @CachePut(/*value="wn",*/key = "#result.id"),
                    @CachePut(/*value="wn",*/key = "#result.email")
            }
    )
    public Wn getWnData(String gr) { Wn wn = wnDao.selectByGr(gr); System.out.println("查询数据库"); return wn; }

@CacheConfig(cacheNames="wn") //抽取缓存的公共配置
    @Service
    public class WnService {
    }