Springboot的@Cacheable注解

概述

@Cacheable 是 Spring 框架提供的一种基于缓存的注解，它可以被应用在方法上以指示该方法的结果需要被缓存起来，缓存在哪个 Cache 中以及该方法使用何种缓存键。

使用 @Cacheable 注解后，每次调用该方法时，首先从缓存中检查是否有对应的缓存值。如果缓存中已有该值，则直接返回该缓存值；否则就执行该方法并将返回结果缓存起来以备下次使用。

@Cacheable 有以下几个常用属性：

1. value：设置缓存所属的缓存组件名称，必须指定至少一个。
2. key：设置方法被调用时使用的缓存键，支持 SpEL 表达式。如果不指定，则会使用默认策略生成缓存键。
3. condition：在执行方法之前，根据 SpEL 条件表达式判断是否需要缓存，默认为 true。
4. unless：在执行方法之后，根据 SpEL 条件表达式判断是否需要移除缓存，默认为 false。

使用

例如，以下代码展示了如何使用 @Cacheable 注解：

@Service
public class UserServiceImpl implements UserService {

    @Autowired
    private UserMapper userMapper;

    @Cacheable(value = "userCache", key = "#id")
    @Override
    public User findById(Long id) {
        // 如果用户信息在缓存中存在，则直接返回
        // 否则调用底层获取数据的方法，并将获取到的数据添加到缓存中
        return userMapper.findById(id);
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

上述代码表示，当调用 findById() 方法时，Spring 将首先从名为 userCache 的缓存中检索带有 #id 键的值。如果找到已缓存的值，则此方法不会执行。否则，将执行该方法，并将方法返回的结果缓存起来。

对比

用这个注解和我直接使用redisTemplate做缓存有什么区别吗？
@Cacheable 注解和直接使用 RedisTemplate 进行缓存操作最大的区别在于它们提供了不同级别的抽象层次。

使用 RedisTemplate 进行缓存操作需要手动写代码实现缓存的读取、添加、更新、删除等操作，通常需要对 Redis 调用进行封装并处理异常，这些都会增加代码量和复杂度。而 @Cacheable 注解则可以将这些细节全部封装起来，从而简化了开发人员的操作。

此外，通过 @Cacheable 注解所设置的缓存管理器还支持多种缓存类型，例如 Ehcache、Guava、Infinispan 等，并且可以轻松地切换缓存类型。

总之，使用 @Cacheable 注解不仅能够为我们带来更简洁、易懂的代码，同时也带来了更好的可扩展性和灵活性，可以让我们更加专注于业务本身的逻辑实现。