SpringBoot - Spring缓存默认配置与运行流程

简介: SpringBoot - Spring缓存默认配置与运行流程

【1】CacheAutoConfiguration

在SpringBoot中,Cache的自动配置类,源码如下。

/**
 * {@link EnableAutoConfiguration Auto-configuration} for the cache abstraction. Creates a
 * {@link CacheManager} if necessary when caching is enabled via {@link EnableCaching}.
 * <p>
 * Cache store can be auto-detected or specified explicitly via configuration.
 *
 * @author Stephane Nicoll
 * @since 1.3.0
 * @see EnableCaching
 */
@Configuration
@ConditionalOnClass(CacheManager.class)
@ConditionalOnBean(CacheAspectSupport.class)
@ConditionalOnMissingBean(value = CacheManager.class, name = "cacheResolver")
@EnableConfigurationProperties(CacheProperties.class)
@AutoConfigureBefore(HibernateJpaAutoConfiguration.class)
@AutoConfigureAfter({ CouchbaseAutoConfiguration.class, HazelcastAutoConfiguration.class,
    RedisAutoConfiguration.class })
@Import(CacheConfigurationImportSelector.class)
public class CacheAutoConfiguration {
  static final String VALIDATOR_BEAN_NAME = "cacheAutoConfigurationValidator";
  @Bean
  @ConditionalOnMissingBean
  public CacheManagerCustomizers cacheManagerCustomizers(
      ObjectProvider<List<CacheManagerCustomizer<?>>> customizers) {
    return new CacheManagerCustomizers(customizers.getIfAvailable());
  }
  @Bean
  @Role(BeanDefinition.ROLE_INFRASTRUCTURE)
  public static CacheManagerValidatorPostProcessor cacheAutoConfigurationValidatorPostProcessor() {
    return new CacheManagerValidatorPostProcessor();
  }
  @Bean(name = VALIDATOR_BEAN_NAME)
  public CacheManagerValidator cacheAutoConfigurationValidator() {
    return new CacheManagerValidator();
  }
  @Configuration
  @ConditionalOnClass(LocalContainerEntityManagerFactoryBean.class)
  @ConditionalOnBean(AbstractEntityManagerFactoryBean.class)
  protected static class CacheManagerJpaDependencyConfiguration
      extends EntityManagerFactoryDependsOnPostProcessor {
    public CacheManagerJpaDependencyConfiguration() {
      super("cacheManager");
    }
  }
  /**
   * {@link BeanFactoryPostProcessor} to ensure that the {@link CacheManagerValidator}
   * is triggered before {@link CacheAspectSupport} but without causing early
   * instantiation.
   */
  static class CacheManagerValidatorPostProcessor implements BeanFactoryPostProcessor {
    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
        throws BeansException {
      for (String name : beanFactory.getBeanNamesForType(CacheAspectSupport.class,
          false, false)) {
        BeanDefinition definition = beanFactory.getBeanDefinition(name);
        definition.setDependsOn(
            append(definition.getDependsOn(), VALIDATOR_BEAN_NAME));
      }
    }
    private String[] append(String[] array, String value) {
      String[] result = new String[array == null ? 1 : array.length + 1];
      if (array != null) {
        System.arraycopy(array, 0, result, 0, array.length);
      }
      result[result.length - 1] = value;
      return result;
    }
  }
  /**
   * Bean used to validate that a CacheManager exists and provide a more meaningful
   * exception.
   */
  static class CacheManagerValidator {
    @Autowired
    private CacheProperties cacheProperties;
    @Autowired(required = false)
    private CacheManager cacheManager;
    @PostConstruct
    public void checkHasCacheManager() {
      Assert.notNull(this.cacheManager,
          "No cache manager could "
              + "be auto-configured, check your configuration (caching "
              + "type is '" + this.cacheProperties.getType() + "')");
    }
  }
  /**
   * {@link ImportSelector} to add {@link CacheType} configuration classes.
   */
  static class CacheConfigurationImportSelector implements ImportSelector {
//拿到系统中的所有缓存配置类
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
      CacheType[] types = CacheType.values();
      String[] imports = new String[types.length];
      for (int i = 0; i < types.length; i++) {
        imports[i] = CacheConfigurations.getConfigurationClass(types[i]);
      }
      return imports;
    }
  }
}

如下所示,添加了11个缓存配置类:

0 = "org.springframework.boot.autoconfigure.cache.GenericCacheConfiguration"
1 = "org.springframework.boot.autoconfigure.cache.JCacheCacheConfiguration"
2 = "org.springframework.boot.autoconfigure.cache.EhCacheCacheConfiguration"
3 = "org.springframework.boot.autoconfigure.cache.HazelcastCacheConfiguration"
4 = "org.springframework.boot.autoconfigure.cache.InfinispanCacheConfiguration"
5 = "org.springframework.boot.autoconfigure.cache.CouchbaseCacheConfiguration"
6 = "org.springframework.boot.autoconfigure.cache.RedisCacheConfiguration"
7 = "org.springframework.boot.autoconfigure.cache.CaffeineCacheConfiguration"
8 = "org.springframework.boot.autoconfigure.cache.GuavaCacheConfiguration"
9 = "org.springframework.boot.autoconfigure.cache.SimpleCacheConfiguration"
10 = "org.springframework.boot.autoconfigure.cache.NoOpCacheConfiguration"

也就是说,CacheManager产品有:

  • Generic
  • JCache(JSR107)(EhCache3 Hazelcast Infinispan .etc)
  • EhCache 2.X
  • Hazelcast
  • Infinispan
  • Couchbase
  • Redis
  • Caffeine
  • Guava
  • Simple

【2】默认缓存配置

在application.properties中开启debug:debug=true。在控制台即可打印自动配置报告:

默认使用的是SimpleCacheConfiguration!

其源码如下:

@Configuration
@ConditionalOnMissingBean(CacheManager.class)
@Conditional(CacheCondition.class)
class SimpleCacheConfiguration {
  private final CacheProperties cacheProperties;
  private final CacheManagerCustomizers customizerInvoker;
  SimpleCacheConfiguration(CacheProperties cacheProperties,
      CacheManagerCustomizers customizerInvoker) {
    this.cacheProperties = cacheProperties;
    this.customizerInvoker = customizerInvoker;
  }
// 注册了ConcurrentMapCacheManager 
  @Bean
  public ConcurrentMapCacheManager cacheManager() {
    ConcurrentMapCacheManager cacheManager = new ConcurrentMapCacheManager();
    List<String> cacheNames = this.cacheProperties.getCacheNames();
    if (!cacheNames.isEmpty()) {
      cacheManager.setCacheNames(cacheNames);
    }
    return this.customizerInvoker.customize(cacheManager);
  }
}


ConcurrentMapCacheManager (可以获取和创建ConcurrentMapCache)源码如下:

/**
 * {@link CacheManager} implementation that lazily builds {@link ConcurrentMapCache}
 * instances for each {@link #getCache} request. Also supports a 'static' mode where
 * the set of cache names is pre-defined through {@link #setCacheNames}, with no
 * dynamic creation of further cache regions at runtime.
 *
 * <p>Note: This is by no means a sophisticated CacheManager; it comes with no
 * cache configuration options. However, it may be useful for testing or simple
 * caching scenarios. For advanced local caching needs, consider
 * {@link org.springframework.cache.jcache.JCacheCacheManager},
 * {@link org.springframework.cache.ehcache.EhCacheCacheManager},
 * {@link org.springframework.cache.caffeine.CaffeineCacheManager} or
 * {@link org.springframework.cache.guava.GuavaCacheManager}.
 *
 * @author Juergen Hoeller
 * @since 3.1
 * @see ConcurrentMapCache
 */
public class ConcurrentMapCacheManager implements CacheManager, BeanClassLoaderAware {
  private final ConcurrentMap<String, Cache> cacheMap = new ConcurrentHashMap<String, Cache>(16);
  private boolean dynamic = true;
  private boolean allowNullValues = true;
  private boolean storeByValue = false;
  private SerializationDelegate serialization;
  /**
   * Construct a dynamic ConcurrentMapCacheManager,
   * lazily creating cache instances as they are being requested.
   */
  public ConcurrentMapCacheManager() {
  }
  /**
   * Construct a static ConcurrentMapCacheManager,
   * managing caches for the specified cache names only.
   */
  public ConcurrentMapCacheManager(String... cacheNames) {
    setCacheNames(Arrays.asList(cacheNames));
  }
  /**
   * Specify the set of cache names for this CacheManager's 'static' mode.
   * <p>The number of caches and their names will be fixed after a call to this method,
   * with no creation of further cache regions at runtime.
   * <p>Calling this with a {@code null} collection argument resets the
   * mode to 'dynamic', allowing for further creation of caches again.
   */
  public void setCacheNames(Collection<String> cacheNames) {
    if (cacheNames != null) {
      for (String name : cacheNames) {
        this.cacheMap.put(name, createConcurrentMapCache(name));
      }
      this.dynamic = false;
    }
    else {
      this.dynamic = true;
    }
  }
  /**
   * Specify whether to accept and convert {@code null} values for all caches
   * in this cache manager.
   * <p>Default is "true", despite ConcurrentHashMap itself not supporting {@code null}
   * values. An internal holder object will be used to store user-level {@code null}s.
   * <p>Note: A change of the null-value setting will reset all existing caches,
   * if any, to reconfigure them with the new null-value requirement.
   */
  public void setAllowNullValues(boolean allowNullValues) {
    if (allowNullValues != this.allowNullValues) {
      this.allowNullValues = allowNullValues;
      // Need to recreate all Cache instances with the new null-value configuration...
      recreateCaches();
    }
  }
  /**
   * Return whether this cache manager accepts and converts {@code null} values
   * for all of its caches.
   */
  public boolean isAllowNullValues() {
    return this.allowNullValues;
  }
  /**
   * Specify whether this cache manager stores a copy of each entry ({@code true}
   * or the reference ({@code false} for all of its caches.
   * <p>Default is "false" so that the value itself is stored and no serializable
   * contract is required on cached values.
   * <p>Note: A change of the store-by-value setting will reset all existing caches,
   * if any, to reconfigure them with the new store-by-value requirement.
   * @since 4.3
   */
  public void setStoreByValue(boolean storeByValue) {
    if (storeByValue != this.storeByValue) {
      this.storeByValue = storeByValue;
      // Need to recreate all Cache instances with the new store-by-value configuration...
      recreateCaches();
    }
  }
  /**
   * Return whether this cache manager stores a copy of each entry or
   * a reference for all its caches. If store by value is enabled, any
   * cache entry must be serializable.
   * @since 4.3
   */
  public boolean isStoreByValue() {
    return this.storeByValue;
  }
  @Override
  public void setBeanClassLoader(ClassLoader classLoader) {
    this.serialization = new SerializationDelegate(classLoader);
    // Need to recreate all Cache instances with new ClassLoader in store-by-value mode...
    if (isStoreByValue()) {
      recreateCaches();
    }
  }
  @Override
  public Collection<String> getCacheNames() {
    return Collections.unmodifiableSet(this.cacheMap.keySet());
  }
//根据名字获取Cache组件
  @Override
  public Cache getCache(String name) {
    Cache cache = this.cacheMap.get(name);
    if (cache == null && this.dynamic) {
      synchronized (this.cacheMap) {
        cache = this.cacheMap.get(name);
        if (cache == null) {
          cache = createConcurrentMapCache(name);
          this.cacheMap.put(name, cache);
        }
      }
    }
    return cache;
  }
  private void recreateCaches() {
    for (Map.Entry<String, Cache> entry : this.cacheMap.entrySet()) {
      entry.setValue(createConcurrentMapCache(entry.getKey()));
    }
  }
  /**
   * Create a new ConcurrentMapCache instance for the specified cache name.
   * @param name the name of the cache
   * @return the ConcurrentMapCache (or a decorator thereof)
   */
  protected Cache createConcurrentMapCache(String name) {
    SerializationDelegate actualSerialization = (isStoreByValue() ? this.serialization : null);
    return new ConcurrentMapCache(name, new ConcurrentHashMap<Object, Object>(256),
        isAllowNullValues(), actualSerialization);
  }
}

ConcurrentMapCache作用:将数据保存在ConcurrentMap中,并进行获取。

【3】运行流程

这里以注解@Cacheable为例,过程如下。

① 方法运行之前,先去Cache组件中进行查询。Cache组件是CacheManager根据cacheNames获取,如果没有则自动创建。



② 根据key 从Cache中查询缓存的内容,默认key为使用keyGenerator(默认为SimpleKeyGenerator)生成的。


SimpleKeyGenerator的生成key的策略:

  • 如果没有参数,则key = new SimpleKey();
  • 如果有一个参数,key = 参数值;
  • 如果有多个参数,key = new SimpleKey(params)。

③ 如果没有查到缓存就调用目标方法



④ 将目标方法的返回结果放入缓存中


⑤ 如果从缓存中查到了就不调用目标方法,直接从缓存中获取然后返回

CacheAspectSupport中源码示例如下:

private Cache.ValueWrapper findCachedItem(Collection<CacheOperationContext> contexts) {
    Object result = CacheOperationExpressionEvaluator.NO_RESULT;
    for (CacheOperationContext context : contexts) {
      if (isConditionPassing(context, result)) {
        Object key = generateKey(context, result);
        Cache.ValueWrapper cached = findInCaches(context, key);
        if (cached != null) {
          return cached;
        }
        else {
          if (logger.isTraceEnabled()) {
            logger.trace("No cache entry for key '" + key + "' in cache(s) " + context.getCacheNames());
          }
        }
      }
    }
    return null;
  }


目录
相关文章
|
12天前
|
Java API 数据库
构建RESTful API已经成为现代Web开发的标准做法之一。Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐。
【10月更文挑战第11天】本文介绍如何使用Spring Boot构建在线图书管理系统的RESTful API。通过创建Spring Boot项目,定义`Book`实体类、`BookRepository`接口和`BookService`服务类,最后实现`BookController`控制器来处理HTTP请求,展示了从基础环境搭建到API测试的完整过程。
30 4
|
9天前
|
Java API 数据库
Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐
本文通过在线图书管理系统案例,详细介绍如何使用Spring Boot构建RESTful API。从项目基础环境搭建、实体类与数据访问层定义,到业务逻辑实现和控制器编写,逐步展示了Spring Boot的简洁配置和强大功能。最后,通过Postman测试API,并介绍了如何添加安全性和异常处理,确保API的稳定性和安全性。
24 0
|
2天前
|
Java API Spring
在 Spring 配置文件中配置 Filter 的步骤
【10月更文挑战第21天】在 Spring 配置文件中配置 Filter 是实现请求过滤的重要手段。通过合理的配置,可以灵活地对请求进行处理,满足各种应用需求。还可以根据具体的项目要求和实际情况,进一步深入研究和优化 Filter 的配置,以提高应用的性能和安全性。
|
11天前
|
Java BI 调度
Java Spring的定时任务的配置和使用
遵循上述步骤,你就可以在Spring应用中轻松地配置和使用定时任务,满足各种定时处理需求。
65 1
|
15天前
|
Java 测试技术 开发者
springboot学习四:Spring Boot profile多环境配置、devtools热部署
这篇文章主要介绍了如何在Spring Boot中进行多环境配置以及如何整合DevTools实现热部署,以提高开发效率。
36 2
|
15天前
|
前端开发 Java 程序员
springboot 学习十五:Spring Boot 优雅的集成Swagger2、Knife4j
这篇文章是关于如何在Spring Boot项目中集成Swagger2和Knife4j来生成和美化API接口文档的详细教程。
39 1
|
15天前
|
Java Spring
springboot 学习十一:Spring Boot 优雅的集成 Lombok
这篇文章是关于如何在Spring Boot项目中集成Lombok,以简化JavaBean的编写,避免冗余代码,并提供了相关的配置步骤和常用注解的介绍。
55 0
|
23天前
|
存储 缓存 NoSQL
数据的存储--Redis缓存存储(一)
数据的存储--Redis缓存存储(一)
58 1
|
23天前
|
存储 缓存 NoSQL
数据的存储--Redis缓存存储(二)
数据的存储--Redis缓存存储(二)
36 2
数据的存储--Redis缓存存储(二)
|
20天前
|
消息中间件 缓存 NoSQL
Redis 是一个高性能的键值对存储系统,常用于缓存、消息队列和会话管理等场景。
【10月更文挑战第4天】Redis 是一个高性能的键值对存储系统,常用于缓存、消息队列和会话管理等场景。随着数据增长,有时需要将 Redis 数据导出以进行分析、备份或迁移。本文详细介绍几种导出方法:1)使用 Redis 命令与重定向;2)利用 Redis 的 RDB 和 AOF 持久化功能;3)借助第三方工具如 `redis-dump`。每种方法均附有示例代码,帮助你轻松完成数据导出任务。无论数据量大小,总有一款适合你。
55 6