Redis的操作以及Spring Cache框架

news2025/5/12 17:13:51

Redis是一种开源的内存数据结构存储，用作数据库、缓存和消息代理。它支持多种数据结构，如字符串、哈希、列表、集合、有序集合等。在Spring应用中，可以使用Spring Cache框架结合Redis来实现高效的缓存机制。本文将详细介绍Redis的基本操作以及如何在Spring Boot中使用Spring Cache框架集成Redis。

一、Redis的基本操作

1.1 字符串操作

设置键值对

SET key value

示例：

SET myKey "Hello, Redis!"

获取值

GET key

示例：

GET myKey

1.2 哈希操作

设置哈希值

HSET key field value

示例：

HSET myHash field1 "value1"

获取哈希值

HGET key field

示例：

HGET myHash field1

1.3 列表操作

向列表左侧推入值

LPUSH key value

示例：

LPUSH myList "value1"

从列表右侧弹出值

RPOP key

示例：

RPOP myList

1.4 集合操作

向集合添加值

SADD key member

示例：

SADD mySet "member1"

获取集合中的所有值

SMEMBERS key

示例：

SMEMBERS mySet

1.5 有序集合操作

向有序集合添加值

ZADD key score member

示例：

ZADD myZSet 1 "member1"

获取有序集合中的值

ZRANGE key start stop

示例：

ZRANGE myZSet 0 -1

二、Spring Cache框架集成Redis

2.1 引入依赖

在 pom.xml中添加Spring Boot和Redis的依赖：

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

2.2 配置Redis连接

在 application.yml或 application.properties中配置Redis连接信息：

spring:
  redis:
    host: localhost
    port: 6379
    password: yourpassword # 如果没有设置密码，可以省略
    lettuce:
      pool:
        max-active: 8
        max-wait: -1
        max-idle: 8
        min-idle: 0

2.3 启用缓存支持

在Spring Boot的主应用类上启用缓存支持：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cache.annotation.EnableCaching;

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

2.4 配置缓存管理器

创建一个配置类，用于配置Redis缓存管理器：

import org.springframework.cache.CacheManager;
import org.springframework.cache.annotation.CachingConfigurerSupport;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.cache.redis.RedisCacheConfiguration;
import org.springframework.cache.redis.RedisCacheManager;
import org.springframework.cache.redis.RedisCacheWriter;
import org.springframework.cache.redis.connection.RedisConnectionFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.time.Duration;

@EnableCaching
@Configuration
public class CacheConfig extends CachingConfigurerSupport {

    @Bean
    public CacheManager cacheManager(RedisConnectionFactory redisConnectionFactory) {
        RedisCacheConfiguration redisCacheConfiguration = RedisCacheConfiguration.defaultCacheConfig()
                .entryTtl(Duration.ofMinutes(60)); // 设置缓存过期时间

        return RedisCacheManager.builder(RedisCacheWriter.nonLockingRedisCacheWriter(redisConnectionFactory))
                .cacheDefaults(redisCacheConfiguration)
                .build();
    }
}

2.5 使用缓存注解

在需要缓存的方法上使用缓存注解，Spring提供了 @Cacheable、@CachePut和 @CacheEvict等注解，方便地进行缓存操作。

2.5.1 `@Cacheable`

@Cacheable注解用于将方法的返回结果缓存起来，缓存的键由方法参数组成。

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

@Service
public class UserService {

    @Cacheable(value = "users", key = "#userId")
    public User getUserById(String userId) {
        // 模拟从数据库中获取用户信息
        return new User(userId, "John Doe", "john@example.com");
    }
}

2.5.2 `@CachePut`

@CachePut注解用于更新缓存，不影响方法的执行。

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

@Service
public class UserService {

    @CachePut(value = "users", key = "#user.id")
    public User updateUser(User user) {
        // 模拟更新数据库中的用户信息
        return user;
    }
}

2.5.3 `@CacheEvict`

@CacheEvict注解用于清除缓存，通常在删除或更新操作时使用。

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

@Service
public class UserService {

    @CacheEvict(value = "users", key = "#userId")
    public void deleteUserById(String userId) {
        // 模拟从数据库中删除用户信息
    }
}

三、示例项目

以下是一个完整的示例项目，展示了如何在Spring Boot中使用Redis进行缓存操作。

3.1 项目结构

├── src
│   ├── main
│   │   ├── java
│   │   │   ├── com
│   │   │   │   ├── example
│   │   │   │   │   ├── Application.java
│   │   │   │   │   ├── CacheConfig.java
│   │   │   │   │   ├── UserService.java
│   │   ├── resources
│   │   │   ├── application.yml

3.2 代码实现

Application.java

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cache.annotation.EnableCaching;

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

CacheConfig.java

import org.springframework.cache.CacheManager;
import org.springframework.cache.annotation.CachingConfigurerSupport;
import org.springframework.cache.redis.RedisCacheConfiguration;
import org.springframework.cache.redis.RedisCacheManager;
import org.springframework.cache.redis.RedisCacheWriter;
import org.springframework.cache.redis.connection.RedisConnectionFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.time.Duration;

@Configuration
public class CacheConfig extends CachingConfigurerSupport {

    @Bean
    public CacheManager cacheManager(RedisConnectionFactory redisConnectionFactory) {
        RedisCacheConfiguration redisCacheConfiguration = RedisCacheConfiguration.defaultCacheConfig()
                .entryTtl(Duration.ofMinutes(60)); // 设置缓存过期时间

        return RedisCacheManager.builder(RedisCacheWriter.nonLockingRedisCacheWriter(redisConnectionFactory))
                .cacheDefaults(redisCacheConfiguration)
                .build();
    }
}

UserService.java

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

@Service
public class UserService {

    @Cacheable(value = "users", key = "#userId")
    public User getUserById(String userId) {
        // 模拟从数据库中获取用户信息
        return new User(userId, "John Doe", "john@example.com");
    }

    @CachePut(value = "users", key = "#user.id")
    public User updateUser(User user) {
        // 模拟更新数据库中的用户信息
        return user;
    }

    @CacheEvict(value = "users", key = "#userId")
    public void deleteUserById(String userId) {
        // 模拟从数据库中删除用户信息
    }
}

application.yml

spring:
  redis:
    host: localhost
    port: 6379
    password: yourpassword # 如果没有设置密码，可以省略
    lettuce:
      pool:
        max-active: 8
        max-wait: -1
        max-idle: 8
        min-idle: 0