redis订阅 springboot

原创

mob64ca12d6c78e 2024-09-12 06:38:28 ©著作权

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

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

一、项目概述

本文将指导你如何在 Spring Boot 项目中实现 Redis 订阅模式。Redis 提供的 Pub/Sub 模式让你可以实现高效的消息传递，本文将通过具体的步骤和代码示例来帮助你理解和实现这个功能。

流程概述

首先，我们列出实现 Redis 订阅的具体步骤：

步骤	描述
1	添加 Redis 依赖
2	配置 Redis 连接
3	创建消息发布者
4	创建消息订阅者
5	运行示例并测试

二、具体步骤

1. 添加 Redis 依赖

在你的 pom.xml 文件中添加 Spring Data Redis 以及 Spring Boot Starter 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 的 Redis 启动器和 Jedis 客户端库。

2. 配置 Redis 连接

在 application.properties 或 application.yml 中添加 Redis 连接信息。

spring.redis.host=localhost
spring.redis.port=6379

以上配置指示 Spring Boot 连接到本地 Redis 服务器，端口为 6379。

3. 创建消息发布者

创建一个 RedisPublisher 类，用于发布消息。

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

@Component
public class RedisPublisher {

    @Autowired
    private RedisTemplate<String, String> redisTemplate;

    public void publish(String channel, String message) {
        redisTemplate.convertAndSend(channel, message); // 发送消息
    }
}

RedisPublisher 类是一个组件，通过 RedisTemplate 发送消息至指定通道。

4. 创建消息订阅者

创建一个 RedisSubscriber 类来订阅消息。

import org.springframework.data.redis.connection.Message;
import org.springframework.data.redis.connection.MessageListener;
import org.springframework.stereotype.Component;

@Component
public class RedisSubscriber implements MessageListener {

    @Override
    public void onMessage(Message message, byte[] pattern) {
        System.out.println("Received message: " + message.toString()); // 处理接收到的消息
    }
}

RedisSubscriber 类实现了 MessageListener 接口，以接收从 Redis 发布的消息。

创建配置类以注册 RedisSubscriber。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.listener.RedisMessageListenerContainer;
import org.springframework.data.redis.listener.adapter.MessageListenerAdapter;

@Configuration
public class RedisConfig {

    @Bean
    RedisMessageListenerContainer container(RedisConnectionFactory connectionFactory,
                                           MessageListenerAdapter listenerAdapter) {
        RedisMessageListenerContainer container = new RedisMessageListenerContainer();
        container.setConnectionFactory(connectionFactory);
        container.addMessageListener(listenerAdapter, "your_channel_name"); // 设置订阅的频道
        return container;
    }

    @Bean
    MessageListenerAdapter listenerAdapter(RedisSubscriber subscriber) {
        return new MessageListenerAdapter(subscriber);
    }
}

在配置类 RedisConfig 中配置了消息监听容器，并注册了订阅者。

三、可视化表示

类图

classDiagram
    class RedisPublisher {
        +publish(String channel, String message)
    }
    class RedisSubscriber {
        +onMessage(Message message, byte[] pattern)
    }
    class RedisConfig {
        +container(RedisConnectionFactory connectionFactory, MessageListenerAdapter listenerAdapter)
        +listenerAdapter(RedisSubscriber subscriber)
    }
    
    RedisPublisher --> RedisConfig
    RedisSubscriber --> RedisConfig

甘特图

gantt
    title Redis 订阅实现流程
    dateFormat  YYYY-MM-DD
    section 添加依赖
    添加 Redis 依赖       :done, 2023-10-01, 1d
    section 配置 Redis
    配置 Redis 连接       :done, 2023-10-02, 1d
    section 创建发布者
    创建 RedisPublisher    :done, 2023-10-03, 1d
    section 创建订阅者
    创建 RedisSubscriber    :done, 2023-10-04, 1d
    section 测试运行
    运行示例并测试        :done, 2023-10-05, 1d