echache缓存注解说明文档

echache缓存注解说明------    Spring为我们提供了几个注解来支持Spring Cache。其核心主要是@Cacheable和@CacheEvict。使用@Cacheable标记的方法在执行后Spring Cache将缓存其返回结果，而使用@CacheEvict标记的方法会在方法执行前或者执行后移除Spring Cache中的某些元素。下面我们将来详细介绍一下Spring基于注解对Cache的支持所提供的几个注解。 【Spring Ecache缓存注解详解】 Spring框架从3.1版本开始引入了对缓存的支持，这使得在应用程序中实现缓存管理变得更加便捷。Spring Cache的设计理念与Spring的事务管理相似，它允许开发者在方法级别声明缓存，从而提高性能和效率。当一个带有缓存注解的方法被调用时，如果参数相同，那么结果将直接从缓存中读取，而不是再次执行方法。因此，确保相同参数对应相同返回结果是使用Spring Cache的前提。 Spring Cache的核心注解有两个：`@Cacheable`和`@CacheEvict`。`@Cacheable`用于在方法执行后将结果存入缓存，而`@CacheEvict`则用于在方法执行前后从缓存中移除指定的元素。 1. **@Cacheable** `@Cacheable`可以应用于方法或类，若标记在类上，则类的所有方法都将启用缓存。当一个方法被调用并返回结果后，Spring会将结果以键值对的形式存储在缓存中。缓存的键和值分别由`key`和`value`属性决定。 - **value属性**：此属性是必需的，它指定了缓存的名称，即返回结果将被存储在哪个Cache中。可以是一个或多个Cache，如果是多个，以数组形式提供。 ```java @Cacheable("cache1") public User find(Integer id) { return null; } @Cacheable({"cache1", "cache2"}) public User find(Integer id) { return null; } ``` - **key属性**：可以自定义缓存的键，通过Spring Expression Language (Spring EL)表达式。未指定时，Spring会使用默认策略生成key。例如： ```java @Cacheable(value = "users", key = "#id") public User find(Integer id) { return null; } @Cacheable(value = "users", key = "#user.id") public User find(User user) { return null; } ``` 自定义key可以使用方法参数、它们的属性以及静态字段。 1. **@CacheEvict** `@CacheEvict`用于在方法执行前后从缓存中删除元素。它同样可以指定`value`属性来确定要操作的Cache，并且可以设置`key`属性来指定要移除的特定缓存项。此外，还可以使用`allEntries`属性清除整个Cache，以及`beforeInvocation`属性决定是在方法执行前还是执行后进行清理。 ```java @CacheEvict(value = "users", key = "#id") public void deleteUser(Integer id) {} @CacheEvict(value = "users", allEntries = true) public void clearAllUsers() {} ``` 2. **其他注解** - **@CachePut**：与`@Cacheable`类似，但它总是执行方法并将结果存入缓存，即使已经存在缓存。 - **@Caching**：用于组合多个缓存操作，如`@Cacheable`和`@CacheEvict`。 - **@CacheConfig**：用于在类级别共享缓存配置，例如`cacheNames`属性可以指定所有方法默认使用的缓存名称。 3. **缓存配置** 要使用Spring Cache，我们需要在Spring配置中声明缓存管理器（如Ehcache、Redis等），并启用缓存注解处理。配置可以是基于XML的，也可以是基于Java配置。例如，使用Ehcache时，我们需要引入Ehcache库，并在配置中指定缓存管理器： ```xml <bean id="cacheManager" class="org.springframework.cache.ehcache.EhCacheCacheManager"> <property name="cacheManager" ref="ehcache"/> </bean> <bean id="ehcache" class="org.springframework.cache.ehcache.EhCacheManagerFactoryBean"> <property name="configLocation" value="classpath:ehcache.xml"/> </bean> ``` 或者使用Java配置： ```java @Configuration @EnableCaching public class CacheConfig { @Bean public EhCacheManagerFactoryBean ehCacheManagerFactoryBean() { EhCacheManagerFactoryBean cmfb = new EhCacheManagerFactoryBean(); cmfb.setConfigLocation(new ClassPathResource("ehcache.xml")); cmfb.setShared(true); return cmfb; } @Bean public EhCacheCacheManager cacheManager() { return new EhCacheCacheManager(ehCacheManagerFactoryBean().getObject()); } } ``` 这里，`ehcache.xml`是Ehcache的配置文件，定义了具体的缓存策略和设置。 Spring Cache通过注解简化了缓存的管理，使得开发者能更专注于业务逻辑，而不是缓存细节。通过合理使用`@Cacheable`、`@CacheEvict`以及其他相关注解，可以构建出高效、灵活的缓存系统。同时，结合不同类型的缓存管理器（如Ehcache、Redis等），可以根据实际需求选择合适的缓存解决方案。