订阅(接收消息)
在接收端,可以通过直接命名通道或使用模式匹配来订阅一个或多个通道。后一种方式相当有用,因为它不仅能用一条命令创建多个订阅,还可以监听在订阅时尚未创建的通道(只要它们匹配该模式)。
在低层,RedisConnection 提供了 subscribe 和 pSubscribe 方法,分别映射为按通道订阅和按模式订阅的 Redis 命令。请注意,可以把多个通道或模式作为参数。要更改连接的订阅或查询它是否正在监听,RedisConnection 提供了 getSubscription 和 isSubscribed 方法。
Spring Data Redis 中的订阅命令是阻塞的。也就是说,在一个连接上调用 subscribe 会导致当前线程阻塞,因为它开始等待消息。只有当订阅被取消时线程才会被释放,而取消发生在另一个线程在同一个连接上调用 unsubscribe 或 pUnsubscribe 时。关于这个问题的解决方案,请参见“消息监听器容器”(本文档后文)。
如前所述,一旦订阅,连接就开始等待消息。只允许那些添加新订阅、修改现有订阅和取消现有订阅的命令。调用 subscribe、pSubscribe、unsubscribe 或 pUnsubscribe 以外的任何命令都会抛出异常。
为了订阅消息,需要实现 MessageListener 回调。每当新消息到达时,该回调就会被调用,用户代码通过 onMessage 方法运行。该接口不仅提供对实际消息的访问,还提供对消息所经由的通道以及订阅用于匹配通道的模式(如果有的话)的访问。这些信息让被调用方不仅能根据内容区分各种消息,还能通过检查额外细节来区分。
消息监听器容器
由于其阻塞特性,低层订阅并不理想,因为它需要为每一个监听器管理连接和线程。为缓解这个问题,Spring Data 提供了 RedisMessageListenerContainer,它承担所有繁重的工作。如果你熟悉 EJB 和 JMS,应该会觉得这些概念很熟悉,因为它的设计尽可能贴近 Spring Framework 中的支持及其消息驱动 POJO(MDP)。
RedisMessageListenerContainer 充当消息监听器容器。它用于从 Redis 通道接收消息,并驱动注入其中的 MessageListener 实例。监听器容器负责消息接收的全部线程调度,并把消息分发给监听器进行处理。消息监听器容器是 MDP 与消息提供者之间的中介,负责注册接收消息、获取与释放资源、异常转换等。这让你作为应用开发者可以编写与接收消息(并对其作出反应)相关的(可能复杂的)业务逻辑,而把样板化的 Redis 基础架构事务委托给框架。
MessageListener 还可以额外实现 SubscriptionListener,以在订阅/取消订阅确认时接收通知。在同步调用时,监听订阅通知会很有用。
此外,为最小化应用占用,RedisMessageListenerContainer 让一个连接和一个线程可以被多个监听器共享,即使它们并不共享订阅。因此,无论一个应用追踪多少监听器或通道,运行时开销在其整个生命周期内都保持不变。而且,容器允许运行时配置变更,这样你可以在应用运行时添加或移除监听器,而无需重启。另外,容器采用延迟订阅方式,只在需要时才使用 RedisConnection。如果所有监听器都取消订阅,会自动执行清理并释放线程。
为帮助处理消息的异步特性,容器需要一个 java.util.concurrent.Executor(或 Spring 的 TaskExecutor)来分发消息。根据负载、监听器数量或运行时环境,你应当更改或调整执行器以更好地满足需求。特别地,在受管环境中(例如应用服务器),强烈建议选择一个合适的 TaskExecutor 以利用其运行时能力。
MessageListenerAdapter
MessageListenerAdapter 类是 Spring 异步消息支持中的最终组件。简而言之,它让你可以把几乎任何类暴露为 MDP(尽管存在一些约束)。
考虑下面的接口定义:
public interface MessageDelegate {
void handleMessage(String message);
void handleMessage(Map message);
void handleMessage(byte[] message);
void handleMessage(Serializable message);
// pass the channel/pattern as well
void handleMessage(Serializable message, String channel);
}
请注意,虽然该接口没有继承 MessageListener 接口,但仍然可以通过使用 MessageListenerAdapter 类把它用作 MDP。还请注意,各种消息处理方法是如何根据它们能够接收和处理的各种 Message 类型的内容而进行强类型化的。此外,消息所发往的通道或模式可以作为 String 类型的第二个参数传入方法:
public class DefaultMessageDelegate implements MessageDelegate {
// implementation elided for clarity...
}
Notice how the above implementation of the `MessageDelegate` interface (the above `DefaultMessageDelegate` class) has *no* Redis dependencies at all. It truly is a POJO that we make into an MDP with the following configuration:
- Java
- XML
@Configuration
class MyConfig {
// …
@Bean
DefaultMessageDelegate listener() {
return new DefaultMessageDelegate();
}
@Bean
MessageListenerAdapter messageListenerAdapter(DefaultMessageDelegate listener) {
return new MessageListenerAdapter(listener, "handleMessage");
}
@Bean
RedisMessageListenerContainer redisMessageListenerContainer(RedisConnectionFactory connectionFactory, MessageListenerAdapter listener) {
RedisMessageListenerContainer container = new RedisMessageListenerContainer();
container.setConnectionFactory(connectionFactory);
container.addMessageListener(listener, ChannelTopic.of("chatroom"));
return container;
}
}
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:redis="http://www.springframework.org/schema/redis"
xsi:schemaLocation="http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/redis https://www.springframework.org/schema/redis/spring-redis.xsd">
<!-- the default ConnectionFactory -->
<redis:listener-container>
<!-- the method attribute can be skipped as the default method name is "handleMessage" -->
<redis:listener ref="listener" method="handleMessage" topic="chatroom" />
</redis:listener-container>
<bean id="listener" class="redisexample.DefaultMessageDelegate"/>
...
</beans>
监听器主题既可以是一个通道(例如 topic="chatroom",相应地 Topic.channel("chatroom")),也可以是一个模式(例如 topic="*room",相应地 Topic.pattern("*room"))。
上例使用 Redis 命名空间声明消息监听器容器,并自动把这些 POJO 注册为监听器。完整的 bean 定义如下:
<bean id="messageListener" class="org.springframework.data.redis.listener.adapter.MessageListenerAdapter">
<constructor-arg>
<bean class="redisexample.DefaultMessageDelegate"/>
</constructor-arg>
</bean>
<bean id="redisContainer" class="org.springframework.data.redis.listener.RedisMessageListenerContainer">
<property name="connectionFactory" ref="connectionFactory"/>
<property name="messageListeners">
<map>
<entry key-ref="messageListener">
<bean class="org.springframework.data.redis.listener.ChannelTopic">
<constructor-arg value="chatroom"/>
</bean>
</entry>
</map>
</property>
</bean>
每次收到消息时,适配器都会在低层格式和所需对象类型之间自动、透明地执行转换(使用配置的 RedisSerializer)。方法调用引起的任何异常都会被容器捕获并处理(默认情况下,异常会被记录日志)。
响应式消息监听器容器
Spring Data 提供了 ReactiveRedisMessageListenerContainer,它代用户承担转换和订阅状态管理的全部繁重工作。
消息监听器容器本身不需要外部线程资源。它使用驱动线程来发布消息。
ReactiveRedisConnectionFactory factory = …
ReactiveRedisMessageListenerContainer container = new ReactiveRedisMessageListenerContainer(factory);
Flux<ChannelMessage<String, String>> stream = container.receive(ChannelTopic.of("my-channel"));
为等待并确保正确订阅,你可以使用 receiveLater 方法,它返回一个 Mono<Flux<ChannelMessage>>。当完成对给定主题的订阅时,得到的 Mono 会以一个内部 publisher 的形式完成。通过拦截 onNext 信号,你可以同步服务端订阅。
ReactiveRedisConnectionFactory factory = …
ReactiveRedisMessageListenerContainer container = new ReactiveRedisMessageListenerContainer(factory);
Mono<Flux<ChannelMessage<String, String>>> stream = container.receiveLater(ChannelTopic.of("my-channel"));
stream.doOnNext(inner -> // notification hook when Redis subscriptions are synchronized with the server)
.flatMapMany(Function.identity())
.…;
通过 Template API 订阅
如上所述,你可以直接使用 ReactiveRedisTemplate 来订阅通道/模式。这种方式提供了一个直接但有限的解决方案,因为你在初始订阅之后就无法再添加订阅。尽管如此,你仍可以通过返回的 Flux 控制消息流,例如使用 take(Duration)。读取结束、出错或取消时,所有绑定的资源都会被再次释放。
redisTemplate.listenToChannel("channel1", "channel2").doOnNext(msg -> {
// message processing ...
}).subscribe();