Spring Boot 提供了多个缓存相关的注解,用于简化应用程序中的缓存操作。
使用 Spring Boot 中的缓存注解的一般步骤如下:
-
添加缓存依赖: 在项目的 Maven 或 Gradle 配置文件中添加相应的缓存依赖,如 Ehcache、Redis 等。例如,如果你想使用 Ehcache,可以添加以下依赖:
<!-- Maven 依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-cache</artifactId>
</dependency>
<dependency>
<groupId>org.ehcache</groupId>
<artifactId>ehcache</artifactId>
</dependency>
2.启用缓存功能: 在主应用程序类上添加 @EnableCaching
注解,以启用 Spring Boot 的缓存功能。
@SpringBootApplication
@EnableCaching//开启缓存注解
public class App{
public static void main(String[] args) {
SpringApplication.run(App.class, args);
log.info("server started");
}
}
以下是一些常用的 Spring Boot 缓存注解以及它们的使用方法:
-
@EnableCaching
: 这个注解用于启用缓存功能。通常在主应用程序类上添加。 -
@Cacheable
: 该注解用于指定方法的结果应该被缓存。当调用带有该注解的方法时,首先会检查缓存中是否已存在结果,如果存在,则直接返回缓存的结果,否则执行方法并将结果放入缓存。
@Cacheable(value = "myCache", key = "#id")
public User getUserById(Long id) { // ... }
@CachePut
: 该注解用于更新缓存中的数据,即使方法已经被缓存,也会重新执行方法,并将结果放入缓存。
@CachePut(value = "myCache", key = "#user.id")
public User updateUser(User user) { // ... }
@CacheEvict
: 该注解用于从缓存中移除数据。可以在方法调用前、调用后或者在方法抛出异常时触发移除操作。
@CacheEvict(value = "myCache", key = "#id")
public void deleteUserById(Long id) { // ... }
@Caching
: 该注解用于在同一个方法上同时使用多个缓存注解,可以定义多个不同的缓存行为。
@Caching( cacheable = @Cacheable(value = "users", key = "#name"), evict = @CacheEvict(value = "userList", allEntries = true) )
public List<User> getUsersByName(String name) { // ... }
@CacheConfig
: 该注解用于在类级别指定共同的缓存配置,可以省略@Cacheable
和@CachePut
等注解中的部分属性。
@CacheConfig(cacheNames = "users") @Service public class UserService { @Cacheable(key = "#id") public User getUserById(Long id) { // ... } @CachePut(key = "#user.id")
public User updateUser(User user) { // ... } }
这些是 Spring Boot 中常用的缓存注解,可以根据你的业务需要来选择合适的注解并在方法上使用。注意,要正确使用缓存,你需要配置一个缓存管理器(如 Ehcache、Redis 等)并在应用程序中启用缓存功能。