spring redistemplate 配置

原创

mob649e815d334b 2024-09-16 05:22:31 ©著作权

文章标签 redis Redis spring 文章分类 Redis 数据库

©著作权归作者所有：来自51CTO博客作者mob649e815d334b的原创作品，请联系作者获取转载授权，否则将追究法律责任

Spring RedisTemplate 配置指南

在现代开发中，使用 Redis 作为缓存系统越来越普遍，而 Spring 提供了方便的 RedisTemplate 来与 Redis 进行交互。对于刚入行的小白来说，配置 RedisTemplate 可能会有点复杂，本文将指导你一步步地完成这一配置。

整体流程

以下是配置 Spring RedisTemplate 的主要步骤：

步骤	描述
1. 添加依赖	在项目中添加 Redis 依赖
2. 配置 Redis	在 `application.properties` 文件中配置 Redis 连接信息
3. 创建配置类	创建一个配置类来创建 `RedisTemplate` 实例
4. 使用 RedisTemplate	在服务或控制器中使用 `RedisTemplate`

步骤详解

步骤 1: 添加依赖

在你的 Maven 项目的 pom.xml 文件中添加 Redis 相关的依赖：

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

注释:

spring-boot-starter-data-redis 是 Spring Boot 针对 Redis 的数据访问 Starter。
jedis 是 Redis 的 Java 客户端。

步骤 2: 配置 Redis

在项目的 src/main/resources/application.properties 文件中配置 Redis 连接信息：

spring.redis.host=localhost
spring.redis.port=6379
spring.redis.password=your_redis_password # 如果没有密码，可以去掉这一行

注释:

spring.redis.host 指定 Redis 服务器的地址。
spring.redis.port 指定 Redis 服务器的端口，默认是6379。
spring.redis.password 用于指定连接 Redis 时的密码，可以根据实际情况决定是否添加。

步骤 3: 创建配置类

接下来，我们需要创建一个配置类，负责创建 RedisTemplate 的实例。可以在 src/main/java 下创建一个配置包并添加以下类:

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;

@Configuration
public class RedisConfig {

    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
        RedisTemplate<String, Object> template = new RedisTemplate<>();
        template.setConnectionFactory(redisConnectionFactory);
        
        // 设置 key 的序列化方式
        template.setKeySerializer(new StringRedisSerializer());
        // 设置 value 的序列化方式
        template.setValueSerializer(new GenericJackson2JsonRedisSerializer());
        
        return template;
    }
}

注释:

@Configuration 注解表示该类是一个配置类。
RedisTemplate<String, Object> 是用于与 Redis 交互的模板类。
setConnectionFactory 方法设置 Redis 连接工厂。
setKeySerializer 和 setValueSerializer 方法配置序列化方式，方便进行存取。

步骤 4: 使用 RedisTemplate

在你的服务类中，你可以注入 RedisTemplate 以使用它。例如：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Service;

@Service
public class UserService {

    @Autowired
    private RedisTemplate<String, Object> redisTemplate;

    public void saveUser(String userId, User user) {
        // 将 User 对象保存到 Redis 中，key 为 userId
        redisTemplate.opsForValue().set(userId, user);
    }

    public User getUser(String userId) {
        // 从 Redis 中获取 User 对象
        return (User) redisTemplate.opsForValue().get(userId);
    }
}

注释:

@Service 注解表示这是一个服务类。
@Autowired 注解用于自动注入 RedisTemplate 实例。
opsForValue() 方法用于操作简易的 key-value 数据。

状态图

以下是 Redis 交互的状态图，用于描述系统在与 Redis 交互过程中的状态变化：

stateDiagram
    [*] --> Idle
    Idle --> Connecting : 开始连接
    Connecting --> Connected : 连接成功
    Connected --> Idle : 关闭连接

序列图

以下是使用 RedisTemplate 保存和获取用户数据的序列图：

sequenceDiagram
    participant UserService
    participant RedisTemplate
    participant RedisServer
    
    UserService->>RedisTemplate: saveUser(userId, user)
    RedisTemplate->>RedisServer: set(userId, user)
    RedisServer-->>RedisTemplate: OK
    RedisTemplate-->>UserService: 保存成功

    UserService->>RedisTemplate: getUser(userId)
    RedisTemplate->>RedisServer: get(userId)
    RedisServer-->>RedisTemplate: user
    RedisTemplate-->>UserService: 返回用户信息