Spring Boot 3 整合Redis（2）注解驱动缓存

1. 为什么选择 Redis 作为缓存？
   Redis 是一个高效的键值对存储系统，特别适合于构建高性能、可扩展的缓存层。其优点包括：

• 高吞吐量：Redis 使用内存作为存储介质，读取和写入性能极快，能够支撑高并发的访问需求。
• 数据持久化：尽管 Redis 是内存数据库，它也支持将数据持久化到磁盘，防止数据丢失。
• 丰富的数据结构：Redis 不仅支持简单的字符串存储，还支持哈希、列表、集合等丰富的数据结构，适用于多种应用场景。
• 易于扩展：通过 Redis 的集群功能，可以很容易地扩展 Redis 实例，处理更大规模的数据和请求。

2. 如何在 Spring Boot 中启用 Redis 缓存？

在 application.yml 中，配置 Redis 服务器地址及相关连接池配置：

spring:
  cache:
    type: redis     	 	# 使用 Redis 作为缓存类型

当然我们还需要引入依赖，上面《Spring Boot 3 整合Redis（1） 基础功能》我们已经引入了redis相关的依赖，现在只需要在项目中添加cache依赖即可：

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

当前application.yml

spring:
  cache:
    # 缓存类型 redis、none(不使用缓存)
    type: redis
  data:
    redis:
      host: 127.0.0.1 # Redis服务器地址
      database: 0 # Redis数据库索引（默认为0）
      port: 6379 # Redis服务器连接端口
      password: # Redis服务器连接密码（默认为空）

启用缓存支持

在 Spring Boot 项目中，使用 @Cacheable 注解前，需要通过 @EnableCaching 注解启用缓存功能。可以在主应用类或者任何配置类中加上这个注解：

/**
 * @author harry
 * @公众号 Harry技术
 */
// 启用缓存支持
@EnableCaching
@SpringBootApplication
public class SpringbootRedisExampleApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringbootRedisExampleApplication.class, args);
    }

}

Spring 提供了一组注解用于操作缓存，这些注解可以直接应用于方法上，使得代码更简洁。如果你需要补充EnableCaching相关知识点,请查看:@EnableCaching,@Cacheable, @CachePut,@CacheEvict详解。

@Cacheable 示例

@Cacheable：用于标记一个方法的返回值是可缓存的。下一次调用该方法时，Spring 会直接从缓存中返回结果，而不是再次执行方法。

    @Override
    @Cacheable(value = "user", key = "#p0")
    public SysUser get(Long id) {
        // 模拟从数据库查询到的数据
        SysUser user = new SysUser();
        user.setId(id);
        user.setUsername("harry_" + id);
        log.info("获取到数据，get ....  id:{}", id);
        return user;
    }

解释：

@Cacheable 用于缓存方法的返回值。
value = “user” 指定了缓存的名称，即 “user”。
key = “#p0” 指定了缓存的键值。这里的 #p0 是一个 SpEL 表达式，表示方法的第一个参数。

在这个例子中，方法 get 第一次被调用时，结果会缓存到 Redis 中，并与 user::id 作为 key 存储。后续相同 id 的请求将直接从缓存返回，而无需执行方法。

@CachePut 示例

@CachePut：在方法执行后将返回值放入缓存。它与 @Cacheable 的区别在于，@CachePut 不会跳过方法执行，而是始终执行方法并更新缓存。

@Override
    @CachePut(value = "user", key = "#p0.id")
    public SysUser update(SysUser user) {
        log.info("更新数据，update ....  user:{}", user);
        return user;
    }

@CacheEvict 示例

@CacheEvict：用于清除缓存中的某些条目，可以指定缓存的 key 或清空整个缓存空间。

通过/api/cache/get方法，多模拟几条数据。

@Override
@CacheEvict(value = "user", key = "#p0")
public void delete(Long id) {
    // 清除缓存中的指定用户数据
    log.info("delete ....  id:{}", id);
}

请求：/api/cache/delete,可以看到控制台对id=1的数据缓存进行了清理，通过redis客户端显示已经被清理成功。

@Override
@CacheEvict(value = "user", allEntries = true)
public void clear() {
    // 清除缓存中的所有数据
    log.info("clear ....");
}

通过redis客户端显示user数据已经被清空。

自定义缓存管理

以上缓存名称、过期时间和序列化方式都是默认设置，Spring 允许我们自定义缓存管理器。在大多数情况下，默认配置足够使用，但如果需要定制化的缓存行为，我们可以自定义缓存配置。通过实现 RedisCacheConfiguration，我们可以设置缓存的过期时间、序列化方式等。

在上面的演示示例中，可以看到键时双冒号显示，那么我们自定义覆盖默认key双冒号

/**
 * @author harry
 * @公众号 Harry技术
 */
@Configuration
@EnableConfigurationProperties(CacheProperties.class)
public class RedisCacheConfig {

    /**
     * 自定义 RedisCacheManager
     * <p>
     * 修改 Redis 序列化方式，默认 JdkSerializationRedisSerializer
     *
     * @param redisConnectionFactory {@link RedisConnectionFactory}
     * @param cacheProperties        {@link CacheProperties}
     * @return {@link RedisCacheManager}
     */
    @Bean
    public RedisCacheManager redisCacheManager(RedisConnectionFactory redisConnectionFactory, CacheProperties cacheProperties){
        return RedisCacheManager.builder(RedisCacheWriter.nonLockingRedisCacheWriter(redisConnectionFactory))
                .cacheDefaults(redisCacheConfiguration(cacheProperties))
                .build();
    }

    /**
     * 自定义 RedisCacheConfiguration
     *
     * @param cacheProperties {@link CacheProperties}
     * @return {@link RedisCacheConfiguration}
     */
    @Bean
    RedisCacheConfiguration redisCacheConfiguration(CacheProperties cacheProperties) {

        RedisCacheConfiguration config = RedisCacheConfiguration.defaultCacheConfig();

        config = config.serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(RedisSerializer.string()));
        config = config.serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(RedisSerializer.json()));

        CacheProperties.Redis redisProperties = cacheProperties.getRedis();

        if (redisProperties.getTimeToLive() != null) {
            config = config.entryTtl(redisProperties.getTimeToLive());
        }
        if (!redisProperties.isCacheNullValues()) {
            config = config.disableCachingNullValues();
        }
        if (!redisProperties.isUseKeyPrefix()) {
            config = config.disableKeyPrefix();
        }
        // 覆盖默认key双冒号  CacheKeyPrefix#prefixed
        config = config.computePrefixWith(name -> name + ":");
        return config;
    }

}

Spring提供了简单易用的注解驱动的缓存操作方式，通过合理配置和使用缓存，我们能够大幅提升系统的性能和响应速度。在生产环境中，恰当的缓存策略、过期时间和缓存层优化将进一步提高系统的稳定性和扩展能力。

示例源码：关注公众号“Harry技术”，回复 redis 获取源码地址。