利用Spring的@Cacheable和@CacheEvict注解来实现缓存

本文链接：https://blog.youkuaiyun.com/weixin_46485607/article/details/130239566

文章介绍了如何利用Spring的缓存注解如@Cacheable和@CacheEvict来优化性能，避免重复计算。通过定义缓存对象，根据方法参数作为key存储和检索数据，可以减少耗时操作。示例中展示了在UserService中如何缓存用户查询和更新操作。此外，还提到了如何配置Ehcache缓存管理器，并指定了缓存存储位置。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

对于一些比较耗时的操作，可以使用缓存来避免重复计算的方法如下：

定义一个缓存对象，可以使用Spring提供的缓存框架或者第三方缓存库，如Ehcache、Redis等。
将需要进行缓存的数据作为缓存对象的key，将方法返回值作为缓存对象的value，并将其放入缓存中。
在每次调用该方法时，先从缓存中查找是否存在该key对应的value，如果存在直接返回缓存值，否则执行方法并将结果放入缓存中。
根据具体情况，可以设置缓存的失效时间或者手动清除缓存。

例子1，假设有一个方法根据用户ID查询用户信息，由于查询用户信息可能比较耗时，我们可以使用缓存来避免重复查询：

@Service
public class UserService {
    @Autowired
    private UserMapper userMapper;

    @Cacheable(value = "users", key = "#userId")
    public User getUserById(Long userId) {
        return userMapper.getUserById(userId);
    }

    @CacheEvict(value = "users", key = "#userId")
    public void updateUserName(Long userId, String newName) {
        userMapper.updateUserName(userId, newName);
    }
}

在上述代码中，使用了Spring提供的@Cacheable和@CacheEvict注解来实现缓存的功能。@Cacheable注解表示将方法的返回值缓存起来，@CacheEvict注解表示清除指定key的缓存。在getUserById方法中，使用了@Cacheable注解，并指定了value为"users"，key为方法参数userId的值。在每次调用该方法时，先从缓存中查找是否存在该userId对应的缓存值，如果存在直接返回缓存值，否则执行查询操作并将结果放入缓存中。

在updateUserName方法中，使用了@CacheEvict注解，并指定了value为"users"，key为方法参数userId的值，表示在更新用户信息时需要清除该用户的缓存。

例子2：

@Cacheable(value = "myCache", key = "'foo'")
public String getResult() {
    // 计算结果
}

这个例子中，方法的返回值将被缓存在名为 myCache 的缓存中，键值为 "foo"。如果之后再次调用带有相同参数的方法，那么就可以直接从缓存中读取结果，而不需要重新计算。

原理：

在启用 @Cacheable 注解时，Spring 会自动创建一个缓存管理器（CacheManager），并将数据缓存在内存或其他缓存实现中（如 Redis、Ehcache 等）。可以通过 Spring 的配置文件或 Java 代码来配置缓存管理器和缓存实现。

具体地说，当使用 @Cacheable 注解时，会按照以下步骤进行处理：

首先，Spring 会检查带有 @Cacheable 注解的方法是否已经被调用过，如果没有，那么就执行方法并将结果缓存起来。
如果方法已经被调用过，并且参数的值与之前的调用相同，那么就直接返回缓存中的结果。
如果参数的值不同，那么就重新计算结果，并将其缓存起来。

总之，@Cacheable 注解提供了一种方便和快速的方法来处理常见的数据缓存需求，可有效提高应用程序的性能和响应速度。

指定存储位置：

在Spring中，如果没有指定缓存的存储位置，则会使用默认的缓存管理器。可以也通过在应用程序上下文中配置一个或多个缓存管理器来指定缓存存储位置。在Spring的配置文件中定义缓存管理器，并显式地将其命名。然后，在使用@Cacheable注解时，通过使用"cacheManager"属性来指定缓存管理器的名称，从而将方法调用的结果存储到特定的缓存存储位置。

例如，以下代码片段演示了如何在Spring中配置一个基于Ehcache的缓存管理器：

<!-- 配置Ehcache缓存管理器 -->
<bean id="cacheManager" class="org.springframework.cache.ehcache.EhCacheCacheManager">
    <property name="cacheManager">
        <bean class="org.springframework.cache.ehcache.EhCacheManagerFactoryBean">
            <property name="configLocation" value="classpath:ehcache.xml"/>
        </bean>
    </property>
</bean>

在这里，我们配置了一个名为"cacheManager"的缓存管理器，并将其设置为基于Ehcache。然后，可以在使用@Cacheable注解时指定该缓存管理器的名称，如下所示：

@Cacheable(value = "myCache", cacheManager = "cacheManager")
public String myMethod(String param) {
    // Method implementation
}

在这个例子中，我们将方法的结果存储到名为"myCache"的缓存中，并指定了要使用的缓存管理器的名称为"cacheManager"。