跳到主要内容
版本:2.0.7

Topic 解析

Doubao 中英对照 Topic Resolution

目录

生产或消费消息时需要目标 topic。框架会按以下顺序查找位置来确定 topic(找到第一个即停止):

  • 用户指定
  • 消息类型默认
  • 全局默认

当通过某种默认机制找到 topic 时,就无需在生产或消费 API 上指定 topic。

当未找到 topic 时,API 会相应地抛出异常。

1. 用户指定​

传入所使用 API 的 topic 具有最高优先级(例如 PulsarTemplate.send("my-topic", myMessage) 或 @PulsarListener(topics = "my-topic")。

2. 消息类型默认​

当没有向 API 传入 topic 时,系统会查找为所生产或消费消息的类型配置的“消息类型到 topic”映射。

可以使用 spring.pulsar.defaults.type-mappings 属性配置映射。以下示例使用 application.yml 配置消费或生产 Foo 或 Bar 消息时使用的默认 topic:

spring:
pulsar:
defaults:
type-mappings:
- message-type: com.acme.Foo
topic-name: foo-topic
- message-type: com.acme.Bar
topic-name: bar-topic
备注

message-type 是消息类的全限定名。

注意

如果消息(或 Publisher 输入的第一条消息)为 null,框架将无法从中确定 topic。如果你的应用程序可能发送 null 消息,应使用其他方法来指定 topic。

2.1. 通过注解指定​

当没有向 API 传入 topic,且未配置自定义 topic 映射时,系统会在所要生产或消费消息的类上查找 @PulsarMessage 注解。可以通过注解上的 topic 属性指定默认 topic。

以下示例配置生产或消费 Foo 类型消息时使用的默认 topic:

@PulsarMessage(topic = "foo-topic")
record Foo(String value) {
}

@PulsarMessage 注解支持属性占位符和 SpEL 表达式,例如:

@PulsarMessage(topic = "${app.topics.foo}")
record Foo(String value) {
}

@PulsarMessage(topic = "#{someBean.getTopic()}")
record Bar(String value) {
}

2.2. 自定义 topic 解析器​

添加映射的首选方式是通过前述属性。不过,如果需要更多控制力,你可以通过提供自己的实现来替换默认解析器,例如:

@Bean
public MyTopicResolver topicResolver() {
return new MyTopicResolver();
}

3. 生产者全局默认​

(生产时)最后查找的位置是系统级的生产者默认 topic。它通过 spring.pulsar.producer.topic-name 属性配置。

4. 消费者全局默认​

(消费时)最后查找的位置是系统级的消费者默认 topic。它通过 spring.pulsar.consumer.topics 或 spring.pulsar.consumer.topics-pattern 属性配置。