Spring实战(十三)-缓存数据

本文基于《Spring实战(第4版)》所写。

启用对缓存的支持

Spring对缓存的支持有两种方式:

  • 注解驱动的缓存
  • XML声明的缓存

使用Spring的缓存抽象时,最为通用的方式就是在方法上添加@Cacheable和@CacheEvict注解。

在往bean上添加缓存注解之前,必须要启用Spring对注解驱动缓存的支持。如果我们使用Java配置的话,那么可以在其中的一个配置类上添加@EnableCaching,这样的话就能启动注解驱动的缓存。下面的程序展现了如何实际使用@EnableCaching。

package spittr.config;

import org.springframework.cache.CacheManager;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.cache.concurrent.ConcurrentMapCacheManager;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableCaching   // 启用缓存
public class CachingConfig {
    @Bean
    public CacheManager cacheManager(){  // 声明缓存管理器
        return new ConcurrentMapCacheManager();
    }
}

如果以XML的方式配置应用的话,那么可以使用Spring cache命名空间中的元素来启动注解驱动的缓存。




    
    


本质上,@EnableCaching和的工作方式是相同的。它们都会创建一个切面(aspect)并触发Spring缓存注解的切点(pointcut)。根据所使用的注解以及缓存的状态,这个切面会从缓存中获取数据,将数据添加到缓存之中或者从缓存中移除某个值。

上面的程序配置中,它们不仅仅启用了注解驱动的缓存,还声明了一个缓存管理器(cache manager)的bean。缓存管理器是Spring缓存抽象的核心,它能够与多个流行的缓存实现进行集成。

本例中,声明了ConcurrentMapManager,这个简单的缓存管理器使用java.util.concurrent.ConcurrentHashMap作为缓存存储。它的缓存存储是基于内存的,所以它的生命周期是与应用关联的,对于生产级别的大型企业级应用程序,这可能并不是理想的选择。

配置缓存管理器

Spring 3.1内置了五个缓存管理器实现,如下所示:

  • SimpleCacheManager
  • NoOpCacheManager
  • ConcurrentMapCacheManager
  • CompositeCacheManager
  • EhCacheCacheManager

Spring 3.2引入了另外一个缓存管理器,这个管理器可以用在基于JCache(JSR-107)的缓存提供商之中。除了核心的Spring框架,Spring Data又提供了两个缓存管理器:

  • RedisCacheManager(来自于Spring Data Redis项目)
  • GemfireCacheManager(来自于Spring Data GemFire项目)

具体选择哪一个要取决于想要使用的底层缓存供应商。尽管所作出的选择会影响到数据如何缓存,但是Spring声明缓存的方式上并没有什么差别。

我们必须选择一个缓存管理器,然后要在Spring 应用上下文中,以bean的形式对其进行配置。

使用Redis缓存

如果仔细想一下的话,缓存的条目不过是一个键值对(key-value pair),其中key描述了产生value的操作和参数。因此,很自然地就会想到,Redis作为key-value存储。非常适合于存储缓存。

Redis可以用来为Spring缓存抽象机制存储缓存条目,Spring Data Redis提供了RedisCacheManager,这是CacheManager的一个实现。RedisCacheManager会与一个Redis服务器协作,并通过RedisTemplate将缓存条目存储到Redis中。

为了使用RediCacheManager,我们需要RedisConnectionFactory实现类(JedisConnnectionFactory)的bean。之前的篇章,已经看到了这些bean该如何配置。在RedisConnectionFactory就绪之后,就可以配置RedisCacheManager了

package spittr.config;

import org.springframework.cache.CacheManager;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.cache.RedisCacheManager;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;

@Configuration
@EnableCaching   // 启用缓存
public class CachingConfig {

    @Bean
    public CacheManager cacheManager(RedisConnectionFactory redisConnectionFactory){
        return RedisCacheManager.create(redisConnectionFactory);
    }

    @Bean
    public JedisConnectionFactory jedisConnectionFactory() {
        RedisStandaloneConfiguration redisStandaloneConfiguration = new RedisStandaloneConfiguration("localhost", 6379);
        redisStandaloneConfiguration.setPassword(RedisPassword.of("123456"));
        redisStandaloneConfiguration.setDatabase(6);
        return new JedisConnectionFactory(redisStandaloneConfiguration);
    }
    
}

为方法添加注解以支持缓存

如前文所述,Spring的缓存抽象在很大程度上围绕切面构建的。在Spring中启用缓存时,会创建一个切面,它触发一个或更多的Spring的缓存注解。下表列出了Spring所提供的缓存注解。

下表的所有注解都能运用在方法或类上。当将其放在单个方法上时,注解所描述的缓存行为只会运用到这个方法上。如果注解放在类级别的话,那么缓存行为就会应用到这个类的所有方法上。

注解 描述
@Cacheable 表明Spring在调用方法之前,首先应该在缓存中查找方法的返回值。如果这个值能够找到,就会返回缓存的值。否则的话,这个方法就会被调用,返回值会放到缓存之中。
@CachePut 表明Spring应该将方法的返回值放到缓存中。在方法的调用前并不会检查缓存,方法始终都会被调用
@CacheEvict 表明Spring应该在缓存中清除一个或多个条目
@Caching 这是一个分组的注解,能够同时应用多个其他的缓存注解

填充缓存

@Cacheable和@CachePut注解都可以填充缓存,但是它们的工作方式略有差异。

@Cacheable首先在缓存中查找条目,如果找到了匹配的条目,那么就不会对方法进行调用了。如果没有找到匹配的条目,方法会被调用并且返回值要放到缓存之中。而@CachePut并不会在缓存中检查匹配的值,目标放方法总是会被调用,并将返回值添加到缓存之中。

@Cacheable和@CachePut有一些属性是共有的,见下表

属性 类型 描述
value String[] 要使用的缓存名称
condition String SpEL表达式,如果得到的值是false的话,不会将缓存应用到方法调用上
key String SpEL表达式,用来计算自定义的缓存key
unless String SpEL表达式,如果得到的值是true的话,返回值不会放到缓存之中

在最简单的情况下,在@Cacheable和@CachePut的这些属性中,只需使用value属性指定一个或多个缓存即可。例如,考虑SpittleRepository的findOne()方法。在初始保存之后,Spittle就不会再发生变化了。如果有的Spittle比较热门并且会被频繁请求,反复地在数据库中进行获取是对时间和资源的浪费。通过在findOne()方法上添加@Cacheable注解,如下面的程序所示,能够确保将Spittle保存在缓存中,从而避免对数据库的不必要访问。

    @Cacheable("spittleCache")  // 缓存这个方法的结果
    public Spittle findOne(long id) {
        List spittles = jdbc.query(
                "select id, message, created_at, latitude, longitude" +
                        " from Spittle" +
                        " where id = ?",
                new SpittleRowMapper(), id);
        return spittles.size() > 0 ? spittles.get(0) : null;
    }

当findOne() 被调用时,缓存切面会拦截调用并在缓存中查找之前以名spittleCache存储的返回值。缓存的key是缓存名加上传递到findOne()方法的id参数(spittleCache::6)。如果按照这个key能够找到值的话,就会返回找到的值,方法不会在被调用。如果没有找到值的话,那么就会调用这个方法,并将返回值放到缓存之中,为下一次调用findOne()方法做好准备。

在上面的程序清单中,@Cacheable注解被放到了JdbcSpittleRepository的findOne()方法实现上。这样能够起作用,但是缓存的作用只限于JdbcSpittleRepository这个实现类中,SpittleRepository的其他实现并没有缓存功能,除非也其添加上@Cacheable注解。因此,可以考虑将注解添加到SpittleRepository的方法声明上,而不是放在实现类中:

@Cacheable("spittleCache")
Spittle findOne(long id);

当为接口方法添加注解后,@Cacheable注解会被SpittleRepository的所有实现继承,这些实现类都会应用相同的缓存规则。

将值放到缓存之中

@Cacheable会条件性地触发对方法的调用,这取决于缓存中是不是已经有了所需要的值,对于所注解的方法,@CachePut采用了一种更为直接的流程。带有@CachePut注解的方法始终都会被调用,而且它的返回值也会放到缓存中。这提供一种很便利的机制,能够让我们在请求之前预先加载缓存。

例如,当一个全新的Spittle通过SpittleRepository的save()方法保存之后,很可能马上就会请求这条记录。所以,当save()方法调用后,立即将Spittle塞到缓存之中是很有意义的,这样当其他人通过findOne()对其进行查找时,它就已经准备就绪了。为了实现这一点,可以在save()方法上添加@CachaPut注解,如下所示:

@CachePut("spittleCache")
Spittle save(Spittle spittle);

当save()方法被调用时,它首先会做所有必要的事情来保存Spittle,然后返回Spittle会被放到spittleCache缓存中。

但如果直接执行的话,会报错。因为默认的缓存要基于方法的参数来确定,这里唯一的参数就是Spittle,所以它会用做缓存的key。但我们这里使用的是String的key,虽然也可以将Spittle作为key,但显然不是我们想要的key。

自定义缓存key

@Cacheable和@CachePut都有一个名为key属性,这个属性能够替换默认的key,它是通过一个SpEL表达式计算得到的。任意的SpEL表达式都是可行的,但是更常见的场景是所定义的表达式与存储在缓存中的值有关。据此计算得到key。

具体到我们这个场景,我们需要将key设置为所保存Spittle的ID。以参数形式传递给save() 的Spittle还没有保存,因此并没有ID。我们只能通过save()返回的Spittle得到id属性。

幸好,在为缓存编写SpEL表达式的时候,Spring暴露了一些很有用的元数据。下表列出了SpEL中可用的缓存元数据。

表达式 描述
#root.args 传递给缓存方法的参数,形式为数组
#root.caches 该方法执行时所对应的缓存,形式为数组
#root.target 目标对象
#root.targetClass 目标对象的类,是#root.target.class的简写形式
#root.method 缓存方法
#root.methodName 缓存方法的名字,是#root.method.name的简写形式
#result 方法调用的返回值(不能用在@Cacheable注解上)
#Argument 任意的方法参数名(如#argName)或参数索引(如#a0或#p0)

对于save() 方法来说,我们需要的键是所返回Spittle对象的id属性。表达式#result能够得到返回的Spittle。借助这个对象,我们可以通过将key属性设置为#result.id来引用id属性:

@CachePut( value = "spittleCache", key = "#result.id")
Spittle save(Spittle spittle);

按照这种方式配置@CachePut,缓存不会去干涉save() 方法的执行,但是返回的Spittle将会保存在缓存中,并且缓存的key与Spittle的id属性相同。

条件化缓存

通过为方法添加Spring的缓存注解,Spring就会围绕着这个方法创建一个缓存切面。但是,在有些场景下我们可能希望将缓存功能关闭。

@Cacheable和@CachePut提供了两个属性用以实现条件化缓存:unless和condition,这两个属性都接受一个SpEL表达式。如果unless属性的SpEL表达式计算结果为true,那么缓存方法返回的数据就不会放到缓存中。与之类似,如果conditon属性的SpEL表达式计算结果为false,那么对于这个方法缓存就会被禁用掉。

表面上来看,unless和condition属性做的是相同的事情。但是,这里有一点细微的差别。unless属性只能阻止将对象放进缓存,但是这个方法调用的时候,依然会去缓存中进行查找,如果找到了匹配的值,就会返回找到的值。与之不同,如果condition的表达式计算结果为false,那么在这个方法调用的过程中,缓存是被禁用的。就是说,不会去缓存进行查找,同时返回值也不会放进缓存中。

作为样例(尽管有些牵强),假设对于message属性包含“NoCache”的Spittle对象,我们不想对其进行缓存。为了阻止这样的Spittle对象被缓存起来,可以这样设置unless属性:

@Cacheable(value = "spittleCache", unless = "#result.message.contains('NoCache')")
Spittle findOne(long id);

为unless设置的SpEL表达式会检查返回的Spittle对象(在表达式中通过#result来识别)的message属性。如果它包含“NoCache”文本内容,那么这个表达式的计算值为true,这个Spittle对象不会放进缓存中。否则的话,表达式的计算结果为false,无法满足unless的条件,这个Spittle对象会被缓存。

属性unless能够阻止将值写入到缓存中,但是有时候我们希望将缓存全部禁用,也就是说,在一定的条件下,我们既不希望将值添加到缓存中,也不希望从缓存中获取数据。

例如,对于ID值小于10的Spittle对象,我们不希望对其使用缓存。在这种场景下,这些Spittle是用来进行调试的测试条目,对其进行缓存并没有实际的价值。为了要对ID小于10的Spittle关闭缓存,可以在@Cacheable上使用condition属性,如下所示:

@Cacheable(value = "spittleCache", 
      unless = "#result.message.contains('NoCache')",
      condition="#id >= 10")
Spittle findOne(long id);

如果findOne()调用时,参数值小于10,那么将不会在缓存中进行查找,返回的Spittle也不会放进缓存中,就像这个方法没有添加@Cacheable注解一样。

如样例所示,unless属性的表达式能够通过#result引用返回值。这是很有用的,这么做之所以可行是因为unless属性只有在缓存方法有返回值时才开始发挥作用。而condition肩负着在方法上禁用缓存的任务,因此它不能等到方法返回时在确定是否该关闭缓存。这意味着它的表达式必须要在进入方法时进行计算,所以我们不能通过#result引用发挥之。

移除缓存条目

@CacheEvict并不会往缓存中添加任何东西。相反,如果带有@CacheEvict注解的方法被调用的话,那么会有一个或更多的条目会在缓存中移除。

当缓存值不再合法时,我们应该确保将其从缓存中移除,这样的话,后续的缓存中就不会返回旧的或者已经不存在的值,其中一个这样的场景就是数据被删除掉了。这样的话,SpittleRepository的remove() 方法就是使用@CacheEvict的绝佳选择:

@CacheEvict("spittleCache")
void remove(long spittleId);

注意:与@Cacheable和@CachePut不同,@CacheEvict能够应用在返回值为void的方法上,而@Cacheable和@CachePut需要非void的返回值,它将会作为放在缓存中的条目。因为@CacheEvict只是将条目从缓存中移除,因此它可以放在任意的方法上,甚至void方法。

从这里可以看到,当remove() 调用时,会从缓存中删除一个条目。被删除条目的key与传递进来的spittleId参数的值相等。

@CacheEvict有多个属性,如下表,这些属性会影响到该注解的行为,使其不同于默认的做法。

可以看到,@CacheEvict的一些属性与@Cacheable和@CachePut是相同的,另外还有几个新的属性。与@Cacheable和@CachePut不同,@CacheEvict并没有提供unless属性。

属性 类型 描述
value String[] 要使用的缓存名称
key String SpEL表达式,用来计算自定义的缓存key
condition String SpEL表达式,如果得到的值是false的话,不会将缓存应用到方法调用上
allEntries boolean 如果为true的话,特定缓存的所有条目都会被移除掉
beforeInvocation boolean 如果为true的话,在方法调用之前移除条目。如果为false(默认值)的话,在方法成功调用之后再移除条目

使用XML声明缓存

如果需要在没有源码的bean上应用缓存功能,最好将缓存配置与缓存数据的代码分隔开来。Spring的cache命名空间提供了使用XML声明缓存规则的方法,可以作为面向注解缓存的替代方法。因为缓存是一种面向切面的行为,所以cache命名空间会与Spring的aop命名空间结合起来使用,用来声明缓存所应用的切点在哪里。

要开始配置XML声明的缓存,首先需要创建Spring配置文件,这个文件中要包含cache和aop命名空间:





cache命名空间定义了在Spring XML配置文件中声明缓存的配置元素。下表列出了cache命名空间所提供的所有元素。

元素 描述
启动注解驱动的缓存。等同于Java配置中的@EnableCaching
定义缓存通知(advice)。结合,将通知应用到切点上
在缓存通知中,定义一组特定的缓存规则
指明某个方法要进行缓存。等同于@Cacheable注解
指明某个方法要填充缓存,但不会考虑缓存中是否有匹配的值。等同于@CachePut注解
指明某个方法要从缓存中移除一个或多个条目,等同于@CacheEvict注解

接下来的代码清单展现了如何使用这些元素为SpittleRepository bean配置缓存,其作用等同于前面使用缓存注解的方法。



    
    
    
        
    
    
    
        
            
            
            
            
            
        
    
    
    


在上述程序中,我们首先看到的是,它引用ID为cacheAdvice的通知,该元素将这个通知与一个切点进行匹配,因此建立了一个完整的切面。在本例中,这个切面的切点会在执行SpittleRepository的任意方法时触发。如果这样的方法被Spring应用上下文中的任意某个bean所调用,那么就会调用切面的通知。

在这里,通知利用元素进行了声明。在元素中,可以包含任意数量的元素,这些元素用来完整地定义应用的缓存规则。在本例中,只包含了一个元素。这个元素又包含了三个元素和一个元素。

每个元素都声明了切点中的某一个方法是支持缓存的。这是与@Cacheable注解同等作用的XML元素。具体来讲,findRecent()、findOne()和findBySpitterId()都声明为支持缓存,它们的返回值将会保存在名为spittleCache的缓存之中。

元素也都与@CachePut和@CacheEvict注解等效功能。

需要注意的是,元素有一个cache-manager元素,用来指定作为缓存管理器的bean。它的默认值是cacheManager,这与xml配置中底部的声明恰好是一致的,所以没有必要再显式地进行设置。但是,如果缓存管理器的ID与之不同的话(使用多个缓存管理器的时候,可能会遇到这样的场景),那么可以通过设置cache-manager属性指定要使用哪个缓存管理器。

另外,还要留意的是,元素都引用了同一个名为spittleCache的缓存。为了消除这种重复,我们可以在元素上指明缓存的名字:

    
        
            
            
            
            
            
        
    

有几个可以供共享的属性。包括:

cache:指明要存储和获取值的缓存;
condition: SpEL表达式,如果计算得到的值为false,将会为这个方法禁用缓存;
key:SpEL表达式,用来得到缓存的key(默认为方法的参数);
method:要缓存的方法名。

除此之外,还有一个unless属性,可以为这个可选的属性指定一个SpEL表达式,如果这个表达式的计算结果为true,那么将会阻止返回值放到缓存之中。

元素还有几个特有的属性:

  • all-entries: 如果是true的话,缓存中所有的条目都会被移除掉。如果是false的话,只有匹配key的条目才会被移除掉。
  • before-invocation: 如果是true的话,缓存条目将会在方法调用之前被移除掉。如果是false的话,方法调用之后才会移除缓存。

all-entries和before-invocation的默认值都是false。这意味着在使用元素且不配置这两个属性时,会在方法调用完成后只删除一个缓存条目。要删除的条目会通过默认的key(基于方法的参数)进行识别,当然也可以通过为名为key的属性设置一个SpEL表达式指定要删除的key。

你可能感兴趣的:(Spring实战(十三)-缓存数据)