在 Spring 中使用 @Cacheable 和 @CacheEvict

news2024/10/26 23:36:39

缓存是提高性能和用户体验的重要工具。Spring Framework 提供了强大的缓存抽象，使得缓存的使用变得简单高效。本文将介绍两个核心注解：@Cacheable 和 @CacheEvict，并讨论它们的用法和注意事项。

1. @Cacheable

@Cacheable 注解用于标记方法的返回值应该被缓存。当方法被调用时，Spring 会检查缓存中是否已有结果，如果有，则直接返回缓存中的结果；如果没有，则调用方法并将结果存入缓存。

用法示例：

import org.springframework.cache.annotation.Cacheable;
import org.springframework.stereotype.Service;

@Service
public class UserService {

    @Cacheable("users")
    public User findUserById(Long id) {
        // 模拟从数据库查询
        simulateSlowService();
        return new User(id, "User" + id);
    }

    private void simulateSlowService() {
        try {
            Thread.sleep(3000); // 模拟延迟
        } catch (InterruptedException e) {
            throw new IllegalStateException(e);
        }
    }
}

注意事项：

需要配置缓存管理器（如 Ehcache、Redis 等）。
适用于读取操作，避免缓存更新或删除带来的复杂性。

2. @CacheEvict

@CacheEvict 注解用于从缓存中移除一条或多条数据。通常在数据被修改或删除时使用，以保持缓存的一致性。

用法示例：

import org.springframework.cache.annotation.CacheEvict;
import org.springframework.stereotype.Service;

@Service
public class UserService {

    @CacheEvict(value = "users", key = "#id")
    public void deleteUserById(Long id) {
        // 删除用户逻辑
    }
}

注意事项：

可以使用 allEntries = true 参数，清空整个缓存。
适用于删除或更新操作，确保缓存数据的准确性。

3. 结合使用

@Cacheable 和 @CacheEvict 常常结合使用。例如，当更新用户信息时，可以先清除缓存，然后再更新数据库。

示例：

import org.springframework.cache.annotation.CacheEvict;
import org.springframework.cache.annotation.Cacheable;
import org.springframework.stereotype.Service;

@Service
public class UserService {

    @Cacheable("users")
    public User findUserById(Long id) {
        // 从数据库查询用户
    }

    @CacheEvict(value = "users", key = "#user.id")
    public void updateUser(User user) {
        // 更新用户逻辑
    }
}