spring boot redis stream 封装

最新推荐文章于 2024-09-09 12:01:53 发布

杞星

最新推荐文章于 2024-09-09 12:01:53 发布

阅读量13

点赞数

使用 Spring Boot 封装 Redis Stream

在实际项目中，Redis Stream 是一个非常强大的特性，能够支持高效的消息传递和任务队列。如果你是一名刚入职的开发者，可能会对如何在 Spring Boot 中封装 Redis Stream 感到迷茫。本文将指导你通过一系列步骤来实现这一目标。

流程概述

我们可以使用以下步骤来实现 Redis Stream 的封装：

步骤	描述
1. 创建 Spring Boot 项目	使用 Spring Initializr 创建一个新的 Spring Boot 项目。
2. 添加依赖	在 `pom.xml` 文件中添加 Spring Data Redis 和相关依赖。
3. 配置 Redis	在 `application.yml` 中配置 Redis 连接信息。
4. 创建 Service	创建一个用于操作 Redis Stream 的服务类。
5. 创建 Controller	创建一个控制器，处理外部请求并调用服务方法。
6. 测试功能	使用 Postman 或其他工具测试 Redis Stream 功能。

步骤详解

1. 创建 Spring Boot 项目

你可以使用 [Spring Initializr]( 创建一个新的 Maven 项目，选择以下选项：

项目：Maven Project
语言：Java
Spring Boot 版本：选择稳定版本，比如 2.5.x
依赖：Spring Web、Spring Data Redis、Lettuce（或Jedis）

2. 添加依赖

在 pom.xml 中，你需要添加如下依赖：

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

这将会引入 Spring Data Redis 的相关功能。

3. 配置 Redis

在 src/main/resources/application.yml 中配置 Redis 连接：

spring:
  redis:
    host: localhost          # Redis 服务器地址
    port: 6379               # Redis 服务器端口

4. 创建 Service

接下来，创建一个名为 RedisStreamService 的服务类，用于操作 Redis Stream。

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

@Service
public class RedisStreamService {

    private final StreamOperations<String, String, String> streamOps;

    @Autowired
    public RedisStreamService(RedisTemplate<String, String> redisTemplate) {
        this.streamOps = redisTemplate.opsForStream(); // 获取 Stream 操作对象
    }

    // 向 Stream 中添加消息
    public void addMessage(String streamName, String message) {
        streamOps.add(streamName, Map.of("message", message)); // 将消息添加到指定的 Stream
    }

    // 读取 Redis Stream 消息
    public List<MapRecord<String, String, String>> readMessages(String streamName) {
        return streamOps.read(StreamReadOptions.empty().count(10), StreamOffset.create(streamName, ReadOffset.lastId())); // 读取最新的消息
    }
}

5. 创建 Controller

创建一个控制器 RedisStreamController 处理 HTTP 请求。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("/stream")
public class RedisStreamController {
    
    @Autowired
    private RedisStreamService redisStreamService;

    @PostMapping("/{streamName}/add")
    public void addMessage(@PathVariable String streamName, @RequestParam String message) {
        redisStreamService.addMessage(streamName, message); // 添加消息
    }

    @GetMapping("/{streamName}/read")
    public List<MapRecord<String, String, String>> readMessages(@PathVariable String streamName) {
        return redisStreamService.readMessages(streamName); // 读取消息
    }
}

6. 测试功能

使用 Postman，你可以通过如下方式测试你的功能：

添加消息: 向 http://localhost:8080/stream/test-stream/add?message=Hello 发送 POST 请求。
读取消息: 向 http://localhost:8080/stream/test-stream/read 发送 GET 请求。