Spring Boot中的缓存支持（一）注解配置与EhCache使用

随着时间的积累，应用的使用用户不断增加，数据规模也越来越大，往往数据库查询操作会成为影响用户使用体验的瓶颈，此时使用缓存往往是解决这一问题非常好的手段之一。Spring 3开始提供了强大的基于注解的缓存支持，可以通过注解配置方式低侵入的给原有Spring应用增加缓存功能，提高数据访问性能。

在Spring Boot中对于缓存的支持，提供了一系列的自动化配置，使我们可以非常方便的使用缓存。下面我们通过一个简单的例子来展示，我们是如何给一个既有应用增加缓存功能的。

快速入门

首先，下载样例工程 chapter3-2-2 。本例通过spring-data-jpa实现了对User用户表的一些操作，若没有这个基础，可以先阅读 《使用Spring-data-jpa简化数据访问层》 一文对数据访问有所基础。

准备工作

为了更好的理解缓存，我们先对该工程做一些简单的改造。

• application.properties 文件中新增 spring.jpa.properties.hibernate.show_sql=true ，开启hibernate对sql语句的打印

• 修改单元测试 ApplicationTests ，初始化插入User表一条用户名为AAA，年龄为10的数据。并通过findByName函数完成两次查询。

@RunWith(SpringJUnit4ClassRunner.class) @SpringApplicationConfiguration(Application.class) public class ApplicationTests {      @Autowired     private UserRepository userRepository;      @Before     public void before() {         userRepository.save(new User("AAA", 10));     }      @Test     public void test() throws Exception {         User u1 = userRepository.findByName("AAA");         System.out.println("第一次查询：" + u1.getAge());          User u2 = userRepository.findByName("AAA");         System.out.println("第二次查询：" + u2.getAge());     }  } 

• 执行单元测试，我们可以在控制台中看到下面内容。

Hibernate: insert into user (age, name) values (?, ?)   Hibernate: select user0_.id as id1_0_, user0_.age as age2_0_, user0_.name as name3_0_ from user user0_ where user0_.name=?   第一次查询：10 Hibernate: select user0_.id as id1_0_, user0_.age as age2_0_, user0_.name as name3_0_ from user user0_ where user0_.name=?   第二次查询：10 

在测试用例执行前，插入了一条User记录。然后每次findByName调用时，都执行了一句select语句来查询用户名为AAA的记录。

引入缓存

• 在 pom.xml 中引入cache依赖，添加如下内容：

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

• 在Spring Boot主类中增加 @EnableCaching 注解开启缓存功能，如下：

@SpringBootApplication @EnableCaching public class Application {      public static void main(String[] args) {         SpringApplication.run(Application.class, args);     }  } 

• 在数据访问接口中，增加缓存配置注解，如：

@CacheConfig(cacheNames = "users") public interface UserRepository extends JpaRepository<User, Long> {      @Cacheable     User findByName(String name);  } 

• 再来执行以下单元测试，可以在控制台中输出了下面的内容：

Hibernate: insert into user (age, name) values (?, ?)   Hibernate: select user0_.id as id1_0_, user0_.age as age2_0_, user0_.name as name3_0_ from user user0_ where user0_.name=?   第一次查询：10 第二次查询：10 

到这里，我们可以看到，在调用第二次findByName函数时，没有再执行select语句，也就直接减少了一次数据库的读取操作。

为了可以更好的观察，缓存的存储，我们可以在单元测试中注入cacheManager。

@Autowired private CacheManager cacheManager;   

使用debug模式运行单元测试，观察cacheManager中的缓存集users以及其中的User对象的缓存加深理解。

Cache注解详解

回过头来我们再来看，这里使用到的两个注解分别作了什么事情。

• @CacheConfig ：主要用于配置该类中会用到的一些共用的缓存配置。在这里 @CacheConfig(cacheNames = "users") ：配置了该数据访问对象中返回的内容将存储于名为users的缓存对象中，我们也可以不使用该注解，直接通过 @Cacheable 自己配置缓存集的名字来定义。

• @Cacheable ：配置了findByName函数的返回值将被加入缓存。同时在查询时，会先从缓存中获取，若不存在才再发起对数据库的访问。该注解主要有下面几个参数：

  • value 、 cacheNames ：两个等同的参数（ cacheNames 为Spring 4新增，作为 value 的别名），用于指定缓存存储的集合名。由于Spring 4中新增了 @CacheConfig ，因此在Spring 3中原本必须有的 value 属性，也成为非必需项了
  • key ：缓存对象存储在Map集合中的key值，非必需，缺省按照函数的所有参数组合作为key值，若自己配置需使用SpEL表达式，比如： @Cacheable(key = "#p0") ：使用函数第一个参数作为缓存的key值，更多关于SpEL表达式的详细内容可参考 官方文档
  • condition ：缓存对象的条件，非必需，也需使用SpEL表达式，只有满足表达式条件的内容才会被缓存，比如： @Cacheable(key = "#p0", condition = "#p0.length() < 3") ，表示只有当第一个参数的长度小于3的时候才会被缓存，若做此配置上面的AAA用户就不会被缓存，读者可自行实验尝试。
  • unless ：另外一个缓存条件参数，非必需，需使用SpEL表达式。它不同于 condition 参数的地方在于它的判断时机，该条件是在函数被调用之后才做判断的，所以它可以通过对result进行判断。
  • keyGenerator ：用于指定key生成器，非必需。若需要指定一个自定义的key生成器，我们需要去实现 org.springframework.cache.interceptor.KeyGenerator 接口，并使用该参数来指定。需要注意的是： 该参数与 key 是互斥的
  • cacheManager ：用于指定使用哪个缓存管理器，非必需。只有当有多个时才需要使用
  • cacheResolver ：用于指定使用那个缓存解析器，非必需。需通过 org.springframework.cache.interceptor.CacheResolver 接口来实现自己的缓存解析器，并用该参数指定。

除了这里用到的两个注解之外，还有下面几个核心注解：

• @CachePut ：配置于函数上，能够根据参数定义条件来进行缓存，它与 @Cacheable 不同的是，它每次都会真是调用函数，所以主要用于数据新增和修改操作上。它的参数与 @Cacheable 类似，具体功能可参考上面对 @Cacheable 参数的解析
• @CacheEvict ：配置于函数上，通常用在删除方法上，用来从缓存中移除相应数据。除了同 @Cacheable 一样的参数之外，它还有下面两个参数：
  • allEntries ：非必需，默认为false。当为true时，会移除所有数据
  • beforeInvocation ：非必需，默认为false，会在调用方法之后移除数据。当为true时，会在调用方法之前移除数据。

缓存配置

完成了上面的缓存实验之后，可能大家会问，那我们在Spring Boot中到底使用了什么缓存呢？

在Spring Boot中通过 @EnableCaching 注解自动化配置合适的缓存管理器（CacheManager），Spring Boot根据下面的顺序去侦测缓存提供者：

• Generic
• JCache (JSR-107)
• EhCache 2.x
• Hazelcast
• Infinispan
• Redis
• Guava
• Simple

除了按顺序侦测外，我们也可以通过配置属性 spring.cache.type 来强制指定。我们可以通过debug调试查看cacheManager对象的实例来判断当前使用了什么缓存。

本文中不对所有的缓存做详细介绍，下面以常用的EhCache为例，看看如何配置来使用EhCache进行缓存管理。

在Spring Boot中开启EhCache非常简单，只需要在工程中加入 ehcache.xml 配置文件并在pom.xml中增加ehcache依赖，框架只要发现该文件，就会创建EhCache的缓存管理器。

• 在 src/main/resources 目录下创建： ehcache.xml

<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"            xsi:noNamespaceSchemaLocation="ehcache.xsd">      <cache name="users"            maxEntriesLocalHeap="200"            timeToLiveSeconds="600">     </cache>  </ehcache>   

• 在 pom.xml 中加入

<dependency>       <groupId>net.sf.ehcache</groupId>     <artifactId>ehcache</artifactId> </dependency>   

完成上面的配置之后，再通过debug模式运行单元测试，观察此时CacheManager已经是EhCacheManager实例，说明EhCache开启成功了。

对于EhCache的配置文件也可以通过 application.properties 文件中使用 spring.cache.ehcache.config 属性来指定，比如：

spring.cache.ehcache.config=classpath:config/another-config.xml   

完整示例： Chapter-4-4-1