SpringBoot缓存注解使用

2024 年 07 月 26 日

81 次浏览

3801字数

Spring Boot 缓存注解使用

Spring Boot 提供了一套强大的缓存注解机制，用于简化和优化应用程序的缓存管理。通过缓存机制，开发者可以显著提升应用的性能，减少数据库访问频率。本文将详细介绍 Spring Boot 缓存注解的使用方法，包括配置、常用注解及其用法。

一、缓存配置

在 Spring Boot 中使用缓存，首先需要进行缓存配置。可以通过配置类或配置文件来启用缓存支持。

1. 添加依赖

在 pom.xml 文件中添加缓存依赖。这里以使用 EhCache 为例：

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

2. 启用缓存支持

在 Spring Boot 应用的主类上添加 @EnableCaching 注解：

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

3. 配置缓存管理器

可以在配置类中配置缓存管理器：

@Configuration
public class CacheConfig {
    @Bean
    public CacheManager cacheManager() {
        return new EhCacheCacheManager(ehCacheCacheManager().getObject());
    }

    @Bean
    public EhCacheManagerFactoryBean ehCacheCacheManager() {
        EhCacheManagerFactoryBean factory = new EhCacheManagerFactoryBean();
        factory.setConfigLocation(new ClassPathResource("ehcache.xml"));
        factory.setShared(true);
        return factory;
    }
}

二、常用缓存注解

Spring 提供了一些常用的缓存注解，用于在方法级别进行缓存操作。

1. @Cacheable

@Cacheable 注解用于标记方法的返回值可以被缓存。每次调用该方法时，都会先检查缓存是否存在，如果存在则直接返回缓存结果，否则执行方法并将结果缓存。

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

2. @CachePut

@CachePut 注解用于更新缓存。每次调用该方法时，都会执行方法并将结果缓存。

@CachePut(value = "users", key = "#user.id")
public User updateUser(User user) {
    userRepository.save(user);
    return user;
}

3. @CacheEvict

@CacheEvict 注解用于移除缓存。可以指定 allEntries 属性来清空整个缓存。

@CacheEvict(value = "users", key = "#userId")
public void deleteUser(Long userId) {
    userRepository.deleteById(userId);
}

@CacheEvict(value = "users", allEntries = true)
public void clearCache() {
    // 清空缓存
}

4. @Caching

@Caching 注解用于组合多个缓存操作注解。

@Caching(
    put = { @CachePut(value = "users", key = "#user.id") },
    evict = { @CacheEvict(value = "users", key = "#user.id") }
)
public User saveUser(User user) {
    userRepository.save(user);
    return user;
}

三、缓存示例

以下是一个完整的示例，展示了如何在 Spring Boot 应用中使用缓存注解。

1. 配置文件

在 src/main/resources 目录下创建 ehcache.xml 配置文件：

<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="ehcache.xsd">

    <cache name="users"
           maxEntriesLocalHeap="1000"
           timeToLiveSeconds="3600"
           memoryStoreEvictionPolicy="LRU">
    </cache>

</ehcache>

2. 服务类

创建用户服务类，使用缓存注解：

@Service
public class UserService {

    @Autowired
    private UserRepository userRepository;

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

    @CachePut(value = "users", key = "#user.id")
    public User updateUser(User user) {
        userRepository.save(user);
        return user;
    }

    @CacheEvict(value = "users", key = "#userId")
    public void deleteUser(Long userId) {
        userRepository.deleteById(userId);
    }

    @CacheEvict(value = "users", allEntries = true)
    public void clearCache() {
        // 清空缓存
    }
}

思维导图

graph TD;
    A[Spring Boot 缓存注解使用] --> B[缓存配置]
    B --> B1[添加依赖]
    B --> B2[启用缓存支持]
    B --> B3[配置缓存管理器]

    A --> C[常用缓存注解]
    C --> C1[@Cacheable]
    C --> C2[@CachePut]
    C --> C3[@CacheEvict]
    C --> C4[@Caching]

    A --> D[缓存示例]
    D --> D1[配置文件]
    D --> D2[服务类]

总结

Spring Boot 提供了一套方便的缓存注解，用于简化缓存管理。通过 @Cacheable、@CachePut、@CacheEvict 和 @Caching 等注解，开发者可以轻松地实现方法级别的缓存操作，从而提升应用的性能和响应速度。合理使用这些注解可以大大减少数据库的访问频率，优化系统性能。

SpringBoot缓存注解使用