缓存键管理

在Spring缓存中，缓存键的生成有两种策略，一种是默认策略，另一种是自定义策略。

自定义键生成策略

我们在前面已经演示了自定义键的生成策略，如代码清单6-10所示的就是一种常见的根据对象的ID来生成key的实现机制。

代码清单6-10　自定义键生成示例代码

key = "'user'.concat(#id.toString())"

public User findUserById(Long id) {}

这里实际上使用了方法的参数来作为键生成的数据来源。除了上述将方法参数作为key之外，Spring还为我们提供了一个Root对象来生成key。通过该Root对象，开发人员可以获取到本地方法调用所涉及的一组元数据，如表6-2所示。

基于Root对象，我们可以使用如代码清单6-11所示的方式来生成同样效果的key。

代码清单6-11　基于Root对象的自定义键生成示例代码

key = "'user'.concat(#args[0].toString())"

public User findUserById(Long id)

默认键生成策略

如果没有指定key属性，那么Spring会帮我们自动生成键。默认的键生成策略是通过KeyGenerator生成的，KeyGenerator接口定义如代码清单6-12所示。

代码清单6-12　KeyGenerator接口代码

public interface KeyGenerator {

Object generate(Object target, Method method, Object... params);

}

默认键生成策略的具体运作方式是这样的：如果方法没有参数，则使用0作为key；如果只有一个参数，则使用该参数作为key；如果参数多于一个的话则使用所有参数的HashCode作为key。

当然，如果我们想要自定义默认键的生成策略，可以实现自己的KeyGenerator，然后指定Spring缓存使用的KeyGenerator为这个自定义的KeyGenerator。

缓存配置

和其他功能类似，尽管Spring为我们提供了包括XML、注解在内等多种开发方式，在本书中我们还是以最常用的注解来启用缓存。在注解模式下想要启用Spring内置的缓存功能，需要在配置类上添加@EnableCaching注解，如代码清单6-13所示。

代码清单6-13　@EnableCaching注解示例代码

@Configuration

@EnableCaching

public class SpringCacheConfig {}

CacheManager是一个由Spring定义的用来管理Cache的核心接口。目前，Spring已经内置了一大批主流的缓存实现工具，这些工具都统一通过CacheManager进行管理。CacheManager的类层结构如图6-1所示。

可以看到，除了基于Java API的ConcurrentMapCacheManager之外，EhCache、Redis、Caffeine、Guava等第三方缓存工具都已经被整合进了Spring框架。如果我们想要使用其他类型的缓存，也可以自己来实现CacheManager接口，或者扩展AbstractCacheManager抽象类。

显然，不同的缓存工具使用方法是不一样的，所以对于不同的CacheManager实现，我们都需要设置对应的配置项。以EhCache为例，我们可以在类路径上创建一个ehcache.xml配置文件，并设置如代码清单6-14所示的配置项。

代码清单6-14　ehcache.xml示例配置文件

<ehcache xmlns:xsi=http://www.w3.org/2001/XMLSchema

instancexsi:noNamespaceSchemaLocation="http://ehcache.org/ehcache.xsd"

updateCheck="false">

<diskStore path="java.io.tmpdir"/>

<!-- 配置默认的缓存区 -->

<defaultCache

maxElementsInMemory="10000"

eternal="false"

overflowToDisk="true"

timeToIdleSeconds="900"

timeToLiveSeconds="900"

diskPersistent="false"

memoryStoreEvictionPolicy="LRU"

diskExpiryThreadIntervalSeconds="120"/>

<!-- 配置名为user的缓存区 -->

<cache name="user"

maxElementsInMemory="100"

eternal="false"

timeToIdleSeconds="900"

timeToLiveSeconds="900"

overflowToDisk="true"

maxElementsOnDisk="10000"

diskPersistent="true"

diskExpiryThreadIntervalSeconds="120"

memoryStoreEvictionPolicy="LRU"/>

</ehcache>这里我们设置了EhCache的常规属性，并针对user这个缓存指定了它的内存中最大缓存对象数、缓存对象失效前允许存活时间等属性。然后，在Spring Boot应用程序的application.yml配置文件中，我们也需要指定当前使用的缓存类型为ehcache并设置对应的配置文件地址，如代码清单6-15所示。

代码清单6-15　基于ehcache缓存类型的application.yml示例配置文件

spring:

cache:

type: ehcache

ehcache:

config: classpath:ehcache.xml

而如果你使用的是Caffeine，那么可以使用如代码清单6-16所示的配置方法。

代码清单6-16　基于Caffeine的配置方法示例代码

@Configuration

public class CacheConfig {

@Bean

public CacheManager cacheManager() {

SimpleCacheManager manager = new SimpleCacheManager();

ArrayList<CaffeineCache> caches = new ArrayList<>();

caches.add(new CaffeineCache("user",

Caffeine.newBuilder().recordStats()

.expireAfterWrite(60, TimeUnit.SECONDS)

.maximumSize(100)

.build())

); manager.setCaches(caches);

return manager;

}

}

这里，我们针对user缓存对象创建了一个CaffeineCache，并把它注册到CacheManager中。

本文给大家讲解的内容是springboot内置缓存：打造高性能系统缓存，缓存键管理+缓存配置

• 下文给大家讲解的是springboot内置缓存：打造高性能系统缓存，Spring缓存案例分析