Spring-data-redis集成redis的方法-猿码集

1. Spring Data Redis 简介

Spring Data Redis 是 Spring Data 项目家族的一项成员，是为了方便 Spring 开发人员与 Redis 服务器进行交互而提供的工具集。它基于 Redis 的 Java 客户端 Jedis 进行封装，为我们提供了更为简洁而又强大的 API。

2. 前置条件

在进行 Spring Data Redis 的集成之前，需要确保以下两个条件都满足。

2.1 Redis 安装

首先，我们需要在本地或服务器上安装 Redis。如果您还没有安装 Redis，请前往官方网站下载安装包并进行安装。

2.2 Spring 项目

其次，我们需要一个可以运行的 Spring 项目。如果您还没有创建 Spring 项目，请参考 Spring Initializr 创建一个。

3. 引入 Redis Starter

如果要使用 Spring Data Redis 进行开发，需要在项目中引入相应的依赖。在 Spring Boot 项目中，只需要引入 spring-boot-starter-data-redis 即可自动配置 Redis 相关的环境。

打开 pom.xml 文件，在 <dependencies> 标签内添加以下代码：

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

4. 配置 Redis 连接信息

在 Spring Data Redis 中，需要在配置文件中配置 Redis 的连接信息。在默认情况下，Spring Boot 会自动使用以下配置信息连接 Redis 实例：

Host：localhost

Port：6379

Password：无密码

Database：0

如果您使用的是其他 Redis 实例，或者需要使用密码进行连接，请在 application.properties 文件中添加以下配置信息。

spring.redis.host=your.redis.host
spring.redis.port=your.redis.port
spring.redis.password=your.redis.password
spring.redis.database=your.redis.database

其中，your.redis.host 是 Redis 服务器的主机名或 IP 地址；your.redis.port 是 Redis 服务器的端口号；your.redis.password 是 Redis 的密码，如果没有设置密码则留空；your.redis.database 是 Redis 的数据库索引，从 0 开始编号。

5. RedisTemplate 的使用

在完成了 Redis 的配置之后，就可以在代码中使用 RedisTemplate 进行操作了。RedisTemplate 是 Spring Data Redis 提供的一个核心组件，可以在 Spring 应用程序中方便地使用 Redis。

5.1 添加 RedisTemplate Bean

要使用 RedisTemplate，首先需要定义一个 RedisTemplate Bean。在 Spring Boot 应用程序中，我们可以通过创建一个 RedisConfig 配置类来完成此操作。

在项目中创建一个名为 RedisConfig 的类，在其中添加以下代码：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.StringRedisSerializer;
@Configuration
public class RedisConfig {
    @Value("${spring.redis.host}")
    private String redisHost;
    @Value("${spring.redis.port}")
    private int redisPort;
    @Value("${spring.redis.password}")
    private String redisPassword;
    @Value("${spring.redis.database}")
    private int redisDatabase;
    @Bean
    public RedisConnectionFactory redisConnectionFactory() {
        LettuceConnectionFactory connectionFactory = new LettuceConnectionFactory(redisHost, redisPort);
        connectionFactory.setPassword(redisPassword);
        connectionFactory.setDatabase(redisDatabase);
        return connectionFactory;
    }
    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
        RedisTemplate<String, Object> template = new RedisTemplate<>();
        template.setConnectionFactory(redisConnectionFactory);
        template.setKeySerializer(new StringRedisSerializer());
        template.setValueSerializer(new StringRedisSerializer());
        return template;
    }
}

在上述代码中，我们通过 @Configuration 注解将 RedisConfig 类标记为配置类，Spring Boot 在启动时会自动扫描它并执行其中的 Bean 定义方法。

首先，我们注入了四个属性：Redis 的 Host、Port、Password 和 Database。其中，@Value 注解表示从配置文件中读取属性值。

接着，我们定义了两个 Bean：RedisConnectionFactory 和 RedisTemplate。

RedisConnectionFactory 是一个连接 Redis 的工厂类，我们使用 LettuceConnectionFactory 类构造出一个连接实例，并设置了连接信息。如果您使用的是 Jedis 来连接 Redis，需要将 LettuceConnectionFactory 改为 JedisConnectionFactory 即可。

RedisTemplate 是 Spring Data Redis 的核心类，它封装了 Redis 的操作，并提供了更为简洁的 API。我们通过 RedisTemplate<String, Object> 声明了一个 RedisTemplate，并注入了 RedisConnectionFactory。

最后，我们设置了 RedisTemplate 的 Key 和 Value 的序列化方式，本例中均使用了 StringRedisSerializer，也可以使用其他的序列化器，如 Jackson2JsonRedisSerializer。

5.2 使用 RedisTemplate

在完成 RedisTemplate 的配置之后，我们可以通过它来进行 Redis 操作。下面我们将介绍 RedisTemplate 的常用 API。

5.2.1 存储数据

我们可以使用 RedisTemplate 的 opsForValue() 方法获取一个 ValueOperations 实例，它提供了一系列操作方法来存储和获取数据。下面是一些常用的操作。

RedisTemplate<String, Object> redisTemplate;
// 存储字符串数据
redisTemplate.opsForValue().set("key", "value");
// 存储对象
User user = new User();
user.setId(1L);
user.setName("张三");
redisTemplate.opsForValue().set("user:1", user);
// 存储字符串数据，并设置过期时间 10 秒
redisTemplate.opsForValue().set("key", "value", 10, TimeUnit.SECONDS);

上述代码中，我们分别存储了一个字符串和一个 Java 对象，并且设置了字符串的过期时间为 10 秒。注意：存储 Java 对象时需要将对象序列化为字符串，可以使用 JSON 序列化器或其他序列化器来完成此操作。

5.2.2 获取数据

获取数据也很简单，我们可以使用 RedisTemplate 的 opsForValue() 方法获取一个 ValueOperations 实例，并使用它的 get() 方法来获取数据。

RedisTemplate<String, Object> redisTemplate;
// 获取字符串数据
String value = redisTemplate.opsForValue().get("key");
// 获取对象
User user = (User) redisTemplate.opsForValue().get("user:1");

5.2.3 删除数据

与存储和获取数据类似，删除数据也是通过 ValueOperations 实例来完成的。

RedisTemplate<String, Object> redisTemplate;
// 删除字符串数据
redisTemplate.opsForValue().delete("key");
// 删除对象
redisTemplate.opsForValue().delete("user:1");

6. 使用注解简化操作

如果您不想每次都使用 RedisTemplate 进行一些简单的操作，可以使用注解来简化您的代码。

在 Spring Data Redis 中，提供了以下注解来简化 Redis 操作：

@RedisHash：标记一个实体类为 Redis 的 Hash 类型。

@Id：标记实体类中的属性为该实体类的主键。

@Indexed：标记一个属性为该实体类的索引，用于查询。

下面以实体类 User 为例，介绍使用注解进行 Redis 操作的方法。

6.1 添加注解依赖

要使用注解，需要在项目的 pom.xml 文件中添加 spring-data-redis 依赖。

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

6.2 定义实体类

定义一个实体类使用 Redis Hash 作为数据源，需要使用 @RedisHash 注解标记该实体类，并使用 @Id 注解标记主键。

@RedisHash("user")
public class User {
    @Id
    private Long id;
    private String name;
    private Integer age;
    // 省略 getter 和 setter 方法
}

在 User 实体类中，我们使用了 @RedisHash("user") 注解标记它属于 Redis Hash 类型，其中 “user” 表示 Redis Hash 的名称。使用 @Id 注解标记了一个 Long 类型的 id 字段作为主键。

在 User 实体类中，还可以使用 @Indexed 注解标记属性为该实体类的索引，用于查询。

6.3 使用注解操作 Redis

添加、查询和删除 Redis 数据库示例：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisHash;
import org.springframework.data.redis.core.RedisKeyValueTemplate;
import org.springframework.stereotype.Service;
@Service
public class UserService {
    @Autowired
    private RedisKeyValueTemplate redisTemplate;
    // 插入数据
    public void saveUser(User user) {
        redisTemplate.insert(user);
    }
    // 根据 id 查询数据
    public User getUserById(Long id) {
        return redisTemplate.findById(id, User.class);
    }
    // 根据 id 删除数据
    public void deleteUserById(Long id) {
        redisTemplate.delete(id, User.class);
    }
}

本例中，我们在 UserService 中使用了 @Autowired 注解来注入 RedisKeyValueTemplate 实例，它可以让我们更方便地使用注解。

在插入数据时，我们使用了 redisTemplate.insert() 方法来完成添加。在查询数据时，我们使用了 redisTemplate.findById() 方法来通过主键查找相应的数据。在删除数据时，我们使用了 redisTemplate.delete() 方法来删除相应的数据。

7. 总结

本文介绍了使用 Spring Data Redis 进行 Redis 操作的方法。我们首先介绍了 Spring Data Redis 的概念和特点，然后讲解了在使用 Spring Data Redis 前需要满足的前置条件。接着，我们引入了 Redis Starter 并配置了 Redis 连接信息。最后，我们讲解了如何使用 RedisTemplate 进行 Redis 操作，并通过注解来简化操作。如有问题或建议，欢迎在下方留言。

Spring-data-redis集成redis的方法