Spring Cache框架（AOP思想）+ Redis实现数据缓存

1 简介

1.1 基本介绍

Spring Cache 是 Spring 框架提供的一个抽象层，通过 Spring Cache，你可以将缓存逻辑与业务代码分离，减少对底层缓存实现的依赖。Spring Cache 支持多种缓存提供者，如 EhCache、Redis、Caffeine、Guava 等。
Spring Cache 的核心概念：

1. 缓存抽象 (Cache Abstraction)
   Spring Cache 通过抽象接口为各种缓存提供者提供支持。核心接口包括 Cache 和 CacheManager。
2. Cache
   Cache 接口代表具体的缓存对象。它提供了对缓存数据的访问和管理操作，如获取、插入、删除缓存项。
3. CacheManager
   CacheManager 是用于管理 Cache 实例的接口。它负责管理多个 Cache 实例，并提供访问这些缓存的机制。

1.2 为什么要用 Spring Cache？

使用 Spring Cache 主要是为了简化缓存管理，提高系统性能，并确保缓存的使用对开发者来说是透明和易于维护的。Spring Cache 的主要好处在于它提供了一个简单、透明且统一的缓存管理机制，可以显著提升应用的性能，同时减少了缓存实现的复杂性。它使得开发者能够更专注于业务逻辑，而不用担心底层缓存的细节，并且在系统扩展时，缓存策略也可以灵活调整。下面是使用 Spring Cache 的一些具体好处：

1. 性能提升

缓存可以显著减少对资源密集型操作的依赖，如数据库查询或复杂计算。通过将频繁访问的结果存储在缓存中，可以减少这些操作的次数，从而提高系统的响应速度和吞吐量。

• 减少数据库查询：将查询结果缓存起来，可以减少数据库的压力，尤其是在读操作较多的场景下。
• 加快计算速度：一些复杂的业务逻辑计算结果可以缓存，避免每次都重新计算。

2. 简化缓存管理

Spring Cache 提供了统一的缓存管理接口，开发者可以通过简单的注解来实现缓存功能，而不需要直接操作底层缓存框架。

• 统一的缓存抽象：通过 Cache 和 CacheManager 接口，Spring Cache 可以支持多种缓存实现，开发者无需关心底层实现的细节。
• 简化的配置：只需使用如 @Cacheable、@CachePut 等注解，就可以轻松实现缓存的添加、更新和删除。

3. 透明的缓存机制

Spring Cache 使得缓存的使用对业务逻辑透明，开发者不需要修改现有代码逻辑，只需在需要缓存的地方加上注解即可。这种透明性极大地减少了缓存逻辑与业务逻辑的耦合。

• 非侵入性：Spring Cache 通过 AOP（面向切面编程）机制将缓存逻辑与业务逻辑分离，不影响原有代码的可读性和维护性。
• 便捷性：开发者不需要手动处理缓存的增删查改，只需专注于业务逻辑。

4. 灵活性和扩展性

Spring Cache 支持多种缓存提供者，如 EhCache、Redis、Caffeine 等，可以根据不同的应用场景选择合适的缓存实现。此外，Spring Cache 还支持缓存的条件控制、缓存键的自定义等高级特性。

• 多缓存支持：可以无缝切换或组合多种缓存提供者，根据业务需求灵活配置。
• 条件缓存：通过 condition 和 unless 等属性，开发者可以精确控制缓存的行为，避免不必要的缓存。

5. 集成与维护方便

Spring Cache 与 Spring 生态系统紧密集成，特别是与 Spring Boot 的集成非常方便，使得缓存的配置和管理更加简单。

• Spring Boot 的自动配置：对于常用的缓存提供者，如 Redis，Spring Boot 提供了开箱即用的自动配置，减少了开发者的配置工作量。
• 一致性管理：Spring Cache 可以与其他 Spring 组件（如 Spring Data、Spring Security 等）无缝集成，提供一致的缓存管理。

6. 缓存更新和失效管理

Spring Cache 支持缓存的自动更新和失效机制，确保缓存数据与实际数据保持一致，避免脏数据的问题。

• 缓存失效控制：通过 @CacheEvict 注解可以灵活地控制缓存的失效时间和条件，确保缓存的准确性。
• 自动刷新：一些缓存实现支持缓存数据的自动刷新机制，避免数据过时的情况。

7. 提高应用的扩展性

通过缓存减少资源的占用，使得应用在负载增加时能更好地扩展。此外，Spring Cache 的抽象层允许开发者轻松切换或扩展缓存策略，而不影响现有的业务逻辑。

2 使用方法

2.1 依赖导入（Maven）

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-cache</artifactId>  		            		       	 
  <version>2.7.3</version> 
</dependency>
1
2
3
4
5

2.2 常用注解

在SpringCache中提供了很多缓存操作的注解，常见的是以下的几个：

在spring boot项目中，使用缓存技术只需在项目中导入相关缓存技术的依赖包，并在启动类上使用@EnableCaching开启缓存支持即可。例如，使用Redis作为缓存技术，只需要导入Spring Data Redis的maven坐标即可。

2.3 使用步骤

采用 SpringBoot+SpringCache+Redis+SpringData 实现数据的缓存小例子如下：

1. 导入相关依赖，并在配置文件中配置好数据库+redis 等相关工具的必须信息。

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

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.2.0</version>
</dependency>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

server:
  port: 8888
spring:
  datasource:
    druid:
      driver-class-name: com.mysql.cj.jdbc.Driver
      url: jdbc:mysql://localhost:3306/spring_cache_demo?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&useSSL=false&allowPublicKeyRetrieval=true
      username: ****
      password: ****
  redis:
    host: localhost
    port: 6379
    database: 1
logging:
  level:
    com:
      itheima:
        mapper: debug
        service: info
        controller: info
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

2. 在启动类中开启缓存注解功能，采用注解：@EnableCaching 打开cache缓存注解功能

@Slf4j
@SpringBootApplication
@EnableCaching // 打开cache缓存注解功能
public class CacheDemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(CacheDemoApplication.class, args);
        log.info("项目启动成功...");
    }
}
1
2
3
4
5
6
7
8
9

3. 在 controller 层，请求方法上加上相关的注解实现不同的作用，具体见下代码注解。（代码见下节）

2.4 常用注解说明

1）@EnableCaching

在启动类中开启缓存注解功能。

2）@CachePut

作用：用于更新缓存中的数据。与@Cacheable不同，@CachePut每次都会调用实际的方法，并将其返回值放入指定的缓存中。
两个参数：

• value：缓存的名称，每个缓存名称下面可以有很多的 key
• key：缓存的 key，支持 spring 的表大师语言 SPEL 语法

// 当用户ID为1时最终缓存的结果为userCache::1
@PostMapping
@CachePut(value = "userCache", key = "#user.id") // 将返回值自动存入缓存，括号的参数代表的是key的生成定义，userCache::1
public User save(@RequestBody User user) {
    userMapper.insert(user);
    return user;
}
1
2
3
4
5
6
7

效果：

附加说明：key 的写法有多种
#user.id : #user指的是方法形参的名称, id指的是user的id属性 , 也就是使用user的id属性作为key ;
#result.id : #result代表方法返回值，该表达式 代表以返回对象的id属性作为key ；
#p0.id：#p0指的是方法中的第一个参数，id指的是第一个参数的id属性,也就是使用第一个参数的id属性作为key ;
#a0.id：#a0指的是方法中的第一个参数，id指的是第一个参数的id属性,也就是使用第一个参数的id属性作为key ;
#root.args[0].id:#root.args[0]指的是方法中的第一个参数，id指的是第一个参数的id属性,也就是使用第一个参数
的id属性作为key ;

3）@Cacheable

作用：用于声明一个方法的返回值是可缓存的。当方法被调用时，Spring Cache会先检查缓存中是否已经存在相应的数据。如果存在，则直接返回缓存中的数据，而无需调用实际的方法。如果不存在，则调用方法并缓存其返回值。
两个重要参数：

• value/cacheNames: 缓存的名称，每个缓存名称下面可以有多个key
• key: 缓存的key ----------> 支持Spring的表达式语言SPEL语法

/**
 * 2、模拟查询请求，首先查找缓存是否存在该数据，没有就查库然后存入缓存，再返回
 */
@GetMapping
@Cacheable(cacheNames = "userCache", key = "#id")
public User getById(Long id) {
    User user = userMapper.getById(id);
    return user;
}
1
2
3
4
5
6
7
8
9

其他参数：

1. value/cacheNames：这两个参数是互斥的，用于指定缓存的名称。你可以使用 value 或 cacheNames 来指定缓存的标识符。如果定义了多个缓存名称，则可以使用逗号分隔。Spring 将会根据这个名称去查找对应的 CacheManager 中的 Cache。
2. key：指定缓存数据时使用的 key，可以是方法参数，也可以是 SpEL 表达式。如果未指定，Spring 将会使用默认的 key 生成策略。
3. keyGenerator：用于指定 key 的生成器，当 key 参数不足以满足需求时，可以通过实现 org.springframework.cache.interceptor.KeyGenerator 接口来自定义 key 的生成策略。
4. cacheManager：指定用于解析缓存名称的 CacheManager。如果未指定，将会使用 Spring Boot 自动配置的 CacheManager。
5. cacheResolver：当需要动态解析缓存时，可以使用 cacheResolver。它允许你基于方法的参数或其他条件来选择不同的缓存。
6. condition：SpEL 表达式，用于指定在什么条件下方法的结果应该被缓存。只有表达式结果为 true 时，才会缓存方法的返回结果。
7. unless：与 condition 类似，但用于指定在什么条件下方法的结果不应该被缓存。只有当表达式结果为 false 时，方法的返回结果才会被缓存。
8. sync：是否使用同步模式进行缓存。如果设置为 true，则对于同一个 key 的并发请求，只有一个能够更新缓存，其他请求则会等待缓存更新完成后再从缓存中获取数据。这个参数是 Spring Cache 的扩展，并非所有缓存提供者都支持。

4）@CacheEvict

作用：用于从缓存中移除数据。你可以指定根据某个条件来移除缓存中的数据，或者移除整个缓存。
参数：

• value/cacheName：缓存的名称，每个缓存名称下面可以有多个 key
• key：缓存的 key
• allEntries：是否删除缓存名称下的所有 key 缓存

两种使用方法，适用于清除缓存数据的情况。具体使用见下：

/**
 * 3、模拟删除某一个数据的请求，同时清理指定的缓存信息
 */
@DeleteMapping
@CacheEvict(cacheNames = "userCache", key = "#id") // 删除某个具体的key对应的id
public void deleteById(Long id) {
    userMapper.deleteById(id);
}

/**
 * 4、模拟批量删除数据请求，同时清理某个类型的key下对应的所有缓存
 */
@DeleteMapping("/delAll")
@CacheEvict(cacheNames = "userCache", allEntries = true) // 删除userCache下对应的所有缓存
public void deleteAll() {
    userMapper.deleteAll();
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

3 注意事项

1. 被缓存的方法的返回值需要是可序列化的，因为缓存数据通常会被存储在内存中或通过网络进行传输。
2. 缓存的key通常是根据方法的参数来生成的，但你也可以通过@Cacheable等注解的key属性来自定义key的生成策略。
3. 缓存的失效策略（如过期时间）通常由缓存实现来提供，而不是由Spring Cache直接控制。你需要根据所使用的缓存实现来配置相应的失效策略。
4. SpringCache并不直接“知道”你使用的是Redis还是其他缓存实现，而是通过项目的依赖和配置信息来间接确定的。Spring Boot的自动配置机制会根据这些信息来选择合适的缓存管理器实现，并在你的业务代码中通过AOP机制来执行缓存操作。

上述完整项目代码仓库：StrivePeng仓库