itzg/redis-stomp-relay

redis-stomp-relay 镜像文档

镜像概述

redis-stomp-relay是一个基于Spring Boot开发的应用，实现了STOMP协议中继功能，通过Redis的发布/订阅（pub/sub）机制进行消息转发。

注意：该项目仍在开发中，STOMP协议的部分功能尚未实现，欢迎贡献代码。

核心功能与特性

• 实现STOMP协议与Redis pub/sub之间的消息中继
• 可配置的Redis连接参数
• 支持自定义通道前缀，与客户端StompBrokerRelay配置保持一致
• 暴露标准STOMP端口（61613）

使用场景

• 需要通过STOMP协议与Redis pub/sub进行消息交互的应用场景
• 构建基于WebSocket和Redis的实时消息系统
• 作为STOMP客户端与Redis之间的中间件

使用方法

直接通过CLI运行（开发环境）

bash
mvn \
  -Dspring.redis.host=172.17.0.1 \
  -Dspring.redis.password=my#super#strong#pass \
  -Dspring.redis.port=6379 \
  -Dstomp-redis-relay.channel-prefix=/stomp/  \
  spring-boot:run

使用Docker运行

基本运行命令

bash
docker run \
  -p=61613:61613 \
  -e SPRING_REDIS_HOST="172.17.0.1" \
  -e SPRING_REDIS_PASSWORD="my#super#strong#pass" \
  -e SPRING_REDIS_PORT=6379 \
  -e STOMP-REDIS-RELAY_CHANNEL-PREFIX='/stomp/' \
  --name=redis-stomp-relay \
  -d docker.xuanyuan.run/redis-stomp-relay

该镜像暴露标准STOMP端口61613，并连接到指定的Redis实例。

配置说明

环境变量/配置参数

配置注意事项

1. 通道前缀一致性：stomp-redis-relay.channel-prefix必须与客户端StompBrokerRelay配置的值保持一致。

2. 简化配置名：除了使用完整配置名（如spring.redis.host）外，也可使用简化配置名：redis.host、redis.port和redis.password。

3. 默认配置：若未指定任何配置，将使用以下默认值：

   • spring.redis.host: localhost
   • spring.redis.port: 6379
   • stomp-redis-relay.channel-prefix: /channel/

4. 额外Redis连接属性：可通过传递以--spring.redis.为前缀的属性来设置其他Redis连接参数。

外部参考

1. https://docs.spring.io/spring/docs/current/spring-framework-reference/html/websocket.html#websocket-stomp-handle-broker-relay
2. http://docs.spring.io/spring-boot/docs/current/api/org/springframework/boot/autoconfigure/data/redis/RedisProperties.html