此版本仍在开发中,尚不被认为是稳定的。对于最新的稳定版本,请使用 Spring for Apache Kafka 3.3.9spring-doc.cadn.net.cn

发送消息

本节介绍如何发送消息。spring-doc.cadn.net.cn

KafkaTemplate

本节介绍如何使用KafkaTemplate发送消息。spring-doc.cadn.net.cn

概述

KafkaTemplate包装生产者,并提供方便的方法将数据发送到 Kafka 主题。以下列表显示了KafkaTemplate:spring-doc.cadn.net.cn

CompletableFuture<SendResult<K, V>> sendDefault(V data);

CompletableFuture<SendResult<K, V>> sendDefault(K key, V data);

CompletableFuture<SendResult<K, V>> sendDefault(Integer partition, K key, V data);

CompletableFuture<SendResult<K, V>> sendDefault(Integer partition, Long timestamp, K key, V data);

CompletableFuture<SendResult<K, V>> send(String topic, V data);

CompletableFuture<SendResult<K, V>> send(String topic, K key, V data);

CompletableFuture<SendResult<K, V>> send(String topic, Integer partition, K key, V data);

CompletableFuture<SendResult<K, V>> send(String topic, Integer partition, Long timestamp, K key, V data);

CompletableFuture<SendResult<K, V>> send(ProducerRecord<K, V> record);

CompletableFuture<SendResult<K, V>> send(Message<?> message);

Map<MetricName, ? extends Metric> metrics();

List<PartitionInfo> partitionsFor(String topic);

<T> T execute(ProducerCallback<K, V, T> callback);

<T> T executeInTransaction(OperationsCallback<K, V, T> callback);

// Flush the producer.
void flush();

interface ProducerCallback<K, V, T> {

    T doInKafka(Producer<K, V> producer);

}

interface OperationsCallback<K, V, T> {

    T doInOperations(KafkaOperations<K, V> operations);

}

有关更多详细信息,请参阅 Javadocspring-doc.cadn.net.cn

sendDefaultAPI 要求已向模板提供默认主题。spring-doc.cadn.net.cn

API 会接收timestamp作为参数,并将此时间戳存储在记录中。用户提供的时间戳的存储方式取决于 Kafka 主题上配置的时间戳类型。如果主题配置为CREATE_TIME,则记录用户指定的时间戳(如果未指定,则生成)。如果主题配置为LOG_APPEND_TIME,则忽略用户指定的时间戳,代理会添加本地代理时间。spring-doc.cadn.net.cn

metricspartitionsFor方法委托给基础Producer. 这execute方法提供对底层Producer.spring-doc.cadn.net.cn

要使用该模板,您可以配置生产者工厂并在模板的构造函数中提供它。以下示例显示了如何执行此作:spring-doc.cadn.net.cn

@Bean
public ProducerFactory producerFactory() {
    return new DefaultKafkaProducerFactory<>(producerConfigs());
}

@Bean
public Map producerConfigs() {
    Map props = new HashMap<>();
    props.put(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, "localhost:9092");
    props.put(ProducerConfig.KEY_SERIALIZER_CLASS_CONFIG, IntegerSerializer.class);
    props.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG, StringSerializer.class);
    // See https://kafka.apache.org/40/documentation/#producerconfigs for more properties
    return props;
}

@Bean
public KafkaTemplate kafkaTemplate() {
    return new KafkaTemplate(producerFactory());
}

从 2.5 版开始,您现在可以覆盖工厂的ProducerConfig属性,以从同一工厂创建具有不同生产者配置的模板。spring-doc.cadn.net.cn

@Bean
public KafkaTemplate<String, String> stringTemplate(ProducerFactory<String, String> pf) {
    return new KafkaTemplate<>(pf);
}

@Bean
public KafkaTemplate<String, byte[]> bytesTemplate(ProducerFactory<String, byte[]> pf) {
    return new KafkaTemplate<>(pf,
            Collections.singletonMap(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG, ByteArraySerializer.class));
}

请注意,类型为ProducerFactory<?, ?>(例如由 Spring Boot 自动配置的那个)可以使用不同的缩小泛型类型进行引用。spring-doc.cadn.net.cn

您还可以使用标准配置模板<bean/>定义。spring-doc.cadn.net.cn

然后,要使用该模板,您可以调用其方法之一。spring-doc.cadn.net.cn

当您将方法Message<?>参数,则主题、分区、键和时间戳信息在消息头中提供,其中包含以下项目:spring-doc.cadn.net.cn

消息有效负载是数据。spring-doc.cadn.net.cn

或者,您可以配置KafkaTemplate使用ProducerListener获取具有发送结果(成功或失败)的异步回调,而不是等待Future以完成。以下列表显示了ProducerListener接口:spring-doc.cadn.net.cn

public interface ProducerListener<K, V> {

    default void onSuccess(ProducerRecord<K, V> producerRecord, RecordMetadata recordMetadata) {
	}

    default void onError(ProducerRecord<K, V> producerRecord, RecordMetadata recordMetadata, Exception exception) {
	}

}

默认情况下,模板配置了LoggingProducerListener,它会记录错误,并且在发送成功时不执行任何作。spring-doc.cadn.net.cn

为方便起见,如果您只想实现其中一种方法,则提供了默认方法实现。spring-doc.cadn.net.cn

请注意,send 方法返回一个CompletableFuture<SendResult>. 您可以向侦听器注册回调,以异步接收发送结果。以下示例演示了如何执行此作:spring-doc.cadn.net.cn

CompletableFuture<SendResult<Integer, String>> future = template.send("myTopic", "something");
future.whenComplete((result, ex) -> {
    ...
});

SendResult有两个属性,一个ProducerRecordRecordMetadata. 有关这些对象的信息,请参阅 Kafka API 文档。spring-doc.cadn.net.cn

Throwable可以转换为KafkaProducerException;其producerRecord属性包含失败的记录。spring-doc.cadn.net.cn

如果您希望阻止发送线程以等待结果,您可以调用未来的get()方法;建议使用带超时的方法。 如果您设置了linger.ms,您可能希望调用flush()在等待之前,或者,为了方便起见,模板有一个构造函数,其中有一个autoFlush导致模板flush()每次发送。 仅当您已将linger.msproducer 属性,并希望立即发送部分批次。spring-doc.cadn.net.cn

例子

本节展示了向 Kafka 发送消息的示例:spring-doc.cadn.net.cn

示例 1.非阻塞(异步)
public void sendToKafka(final MyOutputData data) {
    final ProducerRecord<String, String> record = createRecord(data);

    CompletableFuture<SendResult<String, String>> future = template.send(record);
    future.whenComplete((result, ex) -> {
        if (ex == null) {
            handleSuccess(data);
        }
        else {
            handleFailure(data, record, ex);
        }
    });
}
示例 2.阻止(同步)
public void sendToKafka(final MyOutputData data) {
    final ProducerRecord<String, String> record = createRecord(data);

    try {
        template.send(record).get(10, TimeUnit.SECONDS);
        handleSuccess(data);
    }
    catch (ExecutionException e) {
        handleFailure(data, record, e.getCause());
    }
    catch (TimeoutException | InterruptedException e) {
        handleFailure(data, record, e);
    }
}

请注意,原因ExecutionExceptionKafkaProducerException使用producerRecord财产。spring-doc.cadn.net.cn

RoutingKafkaTemplate

从 2.5 版开始,您可以使用RoutingKafkaTemplate在运行时根据目标选择生产者topic名字。spring-doc.cadn.net.cn

路由模板支持事务,execute,flushmetrics作,因为这些作的主题是未知的。

该模板需要java.util.regex.PatternProducerFactory<Object, Object>实例。 此映射应按顺序排列(例如LinkedHashMap)因为它是按顺序遍历的;您应该在开始时添加更具体的模式。spring-doc.cadn.net.cn

以下简单的 Spring Boot 应用程序提供了一个示例,说明如何使用相同的模板发送到不同的主题,每个主题使用不同的值序列化器。spring-doc.cadn.net.cn

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

    @Bean
    public RoutingKafkaTemplate routingTemplate(GenericApplicationContext context,
            ProducerFactory<Object, Object> pf) {

        // Clone the PF with a different Serializer, register with Spring for shutdown
        Map<String, Object> configs = new HashMap<>(pf.getConfigurationProperties());
        configs.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG, ByteArraySerializer.class);
        DefaultKafkaProducerFactory<Object, Object> bytesPF = new DefaultKafkaProducerFactory<>(configs);
        context.registerBean("bytesPF", DefaultKafkaProducerFactory.class, () -> bytesPF);

        Map<Pattern, ProducerFactory<Object, Object>> map = new LinkedHashMap<>();
        map.put(Pattern.compile("two"), bytesPF);
        map.put(Pattern.compile(".+"), pf); // Default PF with StringSerializer
        return new RoutingKafkaTemplate(map);
    }

    @Bean
    public ApplicationRunner runner(RoutingKafkaTemplate routingTemplate) {
        return args -> {
            routingTemplate.send("one", "thing1");
            routingTemplate.send("two", "thing2".getBytes());
        };
    }

}

相应的@KafkaListeners 显示在注释属性中spring-doc.cadn.net.cn

有关实现类似结果的另一种技术,但具有将不同类型发送到同一主题的附加功能,请参阅委托序列化器和反序列化器spring-doc.cadn.net.cn

DefaultKafkaProducerFactory

KafkaTemplate一个ProducerFactory用于创建生产者。spring-doc.cadn.net.cn

当不使用 Transactions 时,默认情况下,DefaultKafkaProducerFactory创建所有客户端使用的单例生产者,如KafkaProducerJavaDocs。 但是,如果您调用flush()在模板上,这可能会导致使用同一生产者的其他线程出现延迟。 从 2.3 版本开始,DefaultKafkaProducerFactory有一个新属性producerPerThread. 当设置为true,工厂将为每个线程创建(并缓存)一个单独的生产者,以避免此问题。spring-doc.cadn.net.cn

什么时候producerPerThreadtrue,用户代码必须调用closeThreadBoundProducer()当不再需要生产者时,在工厂。 这将物理关闭生产者并将其从ThreadLocal. 叫reset()destroy()不会清理这些生产者。

创建DefaultKafkaProducerFactory、键和/或值Serializer可以通过调用仅接受属性 Map 的构造函数从配置中获取类(请参阅中的示例KafkaTemplate),或Serializer实例可以传递给DefaultKafkaProducerFactory构造函数(在这种情况下,所有Producers 共享相同的实例)。 或者,您可以提供Supplier<Serializer>s(从 2.3 版开始),将用于获取单独的Serializer每个实例Producer:spring-doc.cadn.net.cn

@Bean
public ProducerFactory<Integer, CustomValue> producerFactory() {
    return new DefaultKafkaProducerFactory<>(producerConfigs(), null, () -> new CustomValueSerializer());
}

@Bean
public KafkaTemplate<Integer, CustomValue> kafkaTemplate() {
    return new KafkaTemplate<Integer, CustomValue>(producerFactory());
}

从版本 2.5.10 开始,您现在可以在创建工厂后更新生产者属性。 例如,如果必须在凭据更改后更新 SSL 密钥/信任存储位置,这可能很有用。 这些更改不会影响现有的生产者实例;叫reset()关闭任何现有生产者,以便使用新属性创建新生产者。spring-doc.cadn.net.cn

您不能将事务性生产者工厂更改为非事务性工厂,反之亦然。

现在提供了两种新方法:spring-doc.cadn.net.cn

void updateConfigs(Map<String, Object> updates);

void removeConfig(String configKey);

从版本 2.8 开始,如果您将序列化器作为对象提供(在构造函数中或通过 setter),工厂将调用configure()使用配置属性配置它们的方法。spring-doc.cadn.net.cn

ReplyingKafkaTemplate

2.1.3 版本引入了一个子类KafkaTemplate提供请求/回复语义。 该类名为ReplyingKafkaTemplate并且有两种附加方法;下面显示了方法签名:spring-doc.cadn.net.cn

RequestReplyFuture<K, V, R> sendAndReceive(ProducerRecord<K, V> record);

RequestReplyFuture<K, V, R> sendAndReceive(ProducerRecord<K, V> record,
    Duration replyTimeout);

结果是CompletableFuture异步填充结果(或超时的异常)。 结果还有一个sendFuture属性,这是调用KafkaTemplate.send(). 您可以使用此未来来确定发送作的结果。spring-doc.cadn.net.cn

如果使用第一种方法,或者replyTimeout参数是null,模板的defaultReplyTimeout属性(默认为 5 秒)。spring-doc.cadn.net.cn

从 2.8.8 版本开始,模板有一个新方法waitForAssignment. 如果回复容器配置了auto.offset.reset=latest以避免在容器初始化之前发送请求和回复。spring-doc.cadn.net.cn

使用手动分区分配(无组管理)时,等待的持续时间必须大于容器的pollTimeout属性,因为在第一次轮询完成之前不会发送通知。

以下 Spring Boot 应用程序显示了如何使用该功能的示例:spring-doc.cadn.net.cn

@SpringBootApplication
public class KRequestingApplication {

    public static void main(String[] args) {
        SpringApplication.run(KRequestingApplication.class, args).close();
    }

    @Bean
    public ApplicationRunner runner(ReplyingKafkaTemplate<String, String, String> template) {
        return args -> {
            if (!template.waitForAssignment(Duration.ofSeconds(10))) {
                throw new IllegalStateException("Reply container did not initialize");
            }
            ProducerRecord<String, String> record = new ProducerRecord<>("kRequests", "foo");
            RequestReplyFuture<String, String, String> replyFuture = template.sendAndReceive(record);
            SendResult<String, String> sendResult = replyFuture.getSendFuture().get(10, TimeUnit.SECONDS);
            System.out.println("Sent ok: " + sendResult.getRecordMetadata());
            ConsumerRecord<String, String> consumerRecord = replyFuture.get(10, TimeUnit.SECONDS);
            System.out.println("Return value: " + consumerRecord.value());
        };
    }

    @Bean
    public ReplyingKafkaTemplate<String, String, String> replyingTemplate(
            ProducerFactory<String, String> pf,
            ConcurrentMessageListenerContainer<String, String> repliesContainer) {

        return new ReplyingKafkaTemplate<>(pf, repliesContainer);
    }

    @Bean
    public ConcurrentMessageListenerContainer<String, String> repliesContainer(
            ConcurrentKafkaListenerContainerFactory<String, String> containerFactory) {

        ConcurrentMessageListenerContainer<String, String> repliesContainer =
                containerFactory.createContainer("kReplies");
        repliesContainer.getContainerProperties().setGroupId("repliesGroup");
        repliesContainer.setAutoStartup(false);
        return repliesContainer;
    }

    @Bean
    public NewTopic kRequests() {
        return TopicBuilder.name("kRequests")
            .partitions(10)
            .replicas(2)
            .build();
    }

    @Bean
    public NewTopic kReplies() {
        return TopicBuilder.name("kReplies")
            .partitions(10)
            .replicas(2)
            .build();
    }

}

请注意,我们可以使用 Boot 的自动配置容器工厂来创建回复容器。spring-doc.cadn.net.cn

如果将重要的反序列化器用于回复,请考虑使用ErrorHandlingDeserializer委托给配置的反序列化程序。 如此配置后,RequestReplyFuture将异常完成,您可以捕获ExecutionException,替换为DeserializationException在其cause财产。spring-doc.cadn.net.cn

从 2.6.7 版本开始,除了检测DeserializationExceptions,模板将调用replyErrorChecker函数(如果提供)。 如果返回异常,则未来将异常完成。spring-doc.cadn.net.cn

这是一个例子:spring-doc.cadn.net.cn

template.setReplyErrorChecker(record -> {
    Header error = record.headers().lastHeader("serverSentAnError");
    if (error != null) {
        return new MyException(new String(error.value()));
    }
    else {
        return null;
    }
});

...

RequestReplyFuture<Integer, String, String> future = template.sendAndReceive(record);
try {
    future.getSendFuture().get(10, TimeUnit.SECONDS); // send ok
    ConsumerRecord<Integer, String> consumerRecord = future.get(10, TimeUnit.SECONDS);
    ...
}
catch (InterruptedException e) {
    ...
}
catch (ExecutionException e) {
    if (e.getCause() instanceof MyException) {
        ...
    }
}
catch (TimeoutException e) {
    ...
}

该模板设置一个标头(名为KafkaHeaders.CORRELATION_ID默认情况下),必须由服务器端回显。spring-doc.cadn.net.cn

在这种情况下,以下内容@KafkaListener应用程序响应:spring-doc.cadn.net.cn

@SpringBootApplication
public class KReplyingApplication {

    public static void main(String[] args) {
        SpringApplication.run(KReplyingApplication.class, args);
    }

    @KafkaListener(id="server", topics = "kRequests")
    @SendTo // use default replyTo expression
    public String listen(String in) {
        System.out.println("Server received: " + in);
        return in.toUpperCase();
    }

    @Bean
    public NewTopic kRequests() {
        return TopicBuilder.name("kRequests")
            .partitions(10)
            .replicas(2)
            .build();
    }

    @Bean // not required if Jackson is on the classpath
    public MessagingMessageConverter simpleMapperConverter() {
        MessagingMessageConverter messagingMessageConverter = new MessagingMessageConverter();
        messagingMessageConverter.setHeaderMapper(new SimpleKafkaHeaderMapper());
        return messagingMessageConverter;
    }

}

@KafkaListenerinfrastructure 回显关联 ID 并确定回复主题。spring-doc.cadn.net.cn

转发侦听器结果@SendTo了解有关发送回复的更多信息。 模板使用默认标头KafKaHeaders.REPLY_TOPIC以指示回复所指向的主题。spring-doc.cadn.net.cn

从 2.2 版开始,模板会尝试从配置的回复容器中检测回复主题或分区。 如果容器配置为侦听单个主题或单个TopicPartitionOffset,用于设置回复标头。 如果容器以其他方式配置,则用户必须设置回复标头。 在这种情况下,一个INFO日志消息在初始化期间写入。 以下示例使用KafkaHeaders.REPLY_TOPIC:spring-doc.cadn.net.cn

record.headers().add(new RecordHeader(KafkaHeaders.REPLY_TOPIC, "kReplies".getBytes()));

当您配置单个回复时TopicPartitionOffset,您可以对多个模板使用相同的回复主题,只要每个实例在不同的分区上监听即可。 使用单个回复主题进行配置时,每个实例必须使用不同的group.id. 在这种情况下,所有实例都会收到每个回复,但只有发送请求的实例才能找到相关 ID。 这对于自动缩放可能很有用,但会产生额外网络流量的开销,并且丢弃每个不需要的回复的成本很小。 使用此设置时,建议将模板的sharedReplyTopictrue,这降低了对 DEBUG 的意外回复的日志记录级别,而不是默认的 ERROR。spring-doc.cadn.net.cn

以下是配置回复容器以使用同一共享回复主题的示例:spring-doc.cadn.net.cn

@Bean
public ConcurrentMessageListenerContainer<String, String> replyContainer(
        ConcurrentKafkaListenerContainerFactory<String, String> containerFactory) {

    ConcurrentMessageListenerContainer<String, String> container = containerFactory.createContainer("topic2");
    container.getContainerProperties().setGroupId(UUID.randomUUID().toString()); // unique
    Properties props = new Properties();
    props.setProperty(ConsumerConfig.AUTO_OFFSET_RESET_CONFIG, "latest"); // so the new group doesn't get old replies
    container.getContainerProperties().setKafkaConsumerProperties(props);
    return container;
}
如果您有多个客户端实例,并且未按照上一段中所述配置它们,则每个实例都需要一个专用的回复主题。 另一种方法是将KafkaHeaders.REPLY_PARTITION并为每个实例使用专用分区。 这Header包含一个四字节的 int(大端)。 服务器必须使用此标头将回复路由到正确的分区 (@KafkaListener这样做)。 但是,在这种情况下,回复容器不得使用 Kafka 的组管理功能,并且必须配置为在固定分区上监听(通过使用TopicPartitionOffset在其ContainerProperties构造函数)。
JsonKafkaHeaderMapper要求 Jackson 在类路径上(对于@KafkaListener). 如果它不可用,则消息转换器没有标头映射器,因此您必须配置MessagingMessageConverter使用SimpleKafkaHeaderMapper,如前所述。

默认情况下,使用 3 个标头:spring-doc.cadn.net.cn

这些标头名称由@KafkaListener用于路由回复的基础结构。spring-doc.cadn.net.cn

从 2.3 版开始,您可以自定义标头名称 - 模板有 3 个属性correlationHeaderName,replyTopicHeaderNamereplyPartitionHeaderName. 如果您的服务器不是 Spring 应用程序(或不使用@KafkaListener).spring-doc.cadn.net.cn

相反,如果请求应用程序不是 spring 应用程序,并且将相关信息放在不同的标头中,从 3.0 版本开始,您可以配置自定义correlationHeaderName在侦听器容器工厂上,该标头将被回显回来。 以前,侦听器必须回显自定义关联标头。

请求/回复Message<?>s

2.7 版将方法 添加到ReplyingKafkaTemplate发送和接收spring-messagingMessage<?>抽象化:spring-doc.cadn.net.cn

RequestReplyMessageFuture<K, V> sendAndReceive(Message<?> message);

<P> RequestReplyTypedMessageFuture<K, V, P> sendAndReceive(Message<?> message,
        ParameterizedTypeReference<P> returnType);

这些将使用模板的默认值replyTimeout,还有一些重载版本可能会在方法调用中超时。spring-doc.cadn.net.cn

如果消费者的Deserializer或模板的MessageConverter可以在没有任何其他信息的情况下转换有效负载,无论是通过配置还是回复消息中的类型元数据。spring-doc.cadn.net.cn

如果需要为返回类型提供类型信息,请使用第二种方法来协助消息转换器。 这也允许同一个模板接收不同的类型,即使回复中没有类型元数据,例如当服务器端不是 Spring 应用程序时。 以下是后者的示例:spring-doc.cadn.net.cn

模板 Bean
@Bean
ReplyingKafkaTemplate<String, String, String> template(
        ProducerFactory<String, String> pf,
        ConcurrentKafkaListenerContainerFactory<String, String> factory) {

    ConcurrentMessageListenerContainer<String, String> replyContainer =
            factory.createContainer("replies");
    replyContainer.getContainerProperties().setGroupId("request.replies");
    ReplyingKafkaTemplate<String, String, String> template =
            new ReplyingKafkaTemplate<>(pf, replyContainer);
    template.setMessageConverter(new ByteArrayJacksonJsonMessageConverter());
    template.setDefaultTopic("requests");
    return template;
}
@Bean
fun template(
    pf: ProducerFactory<String, String>,
    factory: ConcurrentKafkaListenerContainerFactory<String, String>
): ReplyingKafkaTemplate<String, String, String> {
    val replyContainer = factory.createContainer("replies")
    replyContainer.containerProperties.setGroupId("request.replies")
    val template = ReplyingKafkaTemplate<String, String, String>(pf, replyContainer)
    template.messageConverter = ByteArrayJacksonJsonMessageConverter()
    template.setDefaultTopic("requests")
    return template
}
使用模板
RequestReplyTypedMessageFuture<String, String, Thing> future1 =
        template.sendAndReceive(MessageBuilder.withPayload("getAThing").build(),
                new ParameterizedTypeReference<Thing>() { });
log.info(future1.getSendFuture().get(10, TimeUnit.SECONDS).getRecordMetadata().toString());
Thing thing = future1.get(10, TimeUnit.SECONDS).getPayload();
log.info(thing.toString());

RequestReplyTypedMessageFuture<String, String, List<Thing>> future2 =
        template.sendAndReceive(MessageBuilder.withPayload("getThings").build(),
                new ParameterizedTypeReference<List<Thing>>() { });
log.info(future2.getSendFuture().get(10, TimeUnit.SECONDS).getRecordMetadata().toString());
List<Thing> things = future2.get(10, TimeUnit.SECONDS).getPayload();
things.forEach(thing1 -> log.info(thing1.toString()));
val future1: RequestReplyTypedMessageFuture<String, String, Thing> =
    template.sendAndReceive(MessageBuilder.withPayload("getAThing").build(),
        object : ParameterizedTypeReference<Thing>() {})
log.info(future1.sendFuture?.get(10, TimeUnit.SECONDS)?.recordMetadata.toString())
val thing = future1.get(10, TimeUnit.SECONDS).payload
log.info(thing.toString())

val future2: RequestReplyTypedMessageFuture<String, String, List<Thing>> =
    template.sendAndReceive(MessageBuilder.withPayload("getThings").build(),
        object : ParameterizedTypeReference<List<Thing>>() {})
log.info(future2.sendFuture?.get(10, TimeUnit.SECONDS)?.recordMetadata.toString())
val things = future2.get(10, TimeUnit.SECONDS).payload
things.forEach { thing1 -> log.info(thing1.toString()) }

回复类型 Message<?>

@KafkaListener返回一个Message<?>,对于 2.5 之前的版本,有必要填充回复主题和相关 ID 标头。 在此示例中,我们使用请求中的回复主题标头:spring-doc.cadn.net.cn

@KafkaListener(id = "requestor", topics = "request")
@SendTo
public Message<?> messageReturn(String in) {
    return MessageBuilder.withPayload(in.toUpperCase())
            .setHeader(KafkaHeaders.TOPIC, replyTo)
            .setHeader(KafkaHeaders.KEY, 42)
            .setHeader(KafkaHeaders.CORRELATION_ID, correlation)
            .build();
}

这也显示了如何在回复记录上设置键。spring-doc.cadn.net.cn

从 2.5 版开始,框架将检测这些标头是否丢失,并使用主题填充它们 - 从@SendTo值或传入的KafkaHeaders.REPLY_TOPIC标头(如果存在)。 它还将呼应即将到来的KafkaHeaders.CORRELATION_IDKafkaHeaders.REPLY_PARTITION,如果存在。spring-doc.cadn.net.cn

@KafkaListener(id = "requestor", topics = "request")
@SendTo  // default REPLY_TOPIC header
public Message<?> messageReturn(String in) {
    return MessageBuilder.withPayload(in.toUpperCase())
            .setHeader(KafkaHeaders.KEY, 42)
            .build();
}

原始记录密钥回复

从 3.3 版开始,来自传入请求的 Kafka 记录键(如果存在)将保留在回复记录中。 这仅适用于单条记录请求/回复方案。 当侦听器是批处理的或返回类型是集合时,应用程序可以通过将回复记录包装在Message类型。spring-doc.cadn.net.cn

聚合多个回复

中的模板ReplyingKafkaTemplate严格用于单个请求/回复场景。 对于单个消息的多个接收者返回回复的情况,您可以使用AggregatingReplyingKafkaTemplate. 这是 Scatter-Gather 企业集成模式的客户端实现。spring-doc.cadn.net.cn

ReplyingKafkaTemplateAggregatingReplyingKafkaTemplate构造函数采用生产者工厂和监听器容器来接收回复;它有第三个参数BiPredicate<List<ConsumerRecord<K, R>>, Boolean> releaseStrategy每次收到回复时都会查阅;当谓词返回时true、集合ConsumerRecords 用于完成FuturesendAndReceive方法。spring-doc.cadn.net.cn

还有一个额外的属性returnPartialOnTimeout(默认为 false)。当将其设置为true,而不是用KafkaReplyTimeoutException,部分结果正常完成未来(只要至少收到一条回复记录)。spring-doc.cadn.net.cn

从版本 2.3.5 开始,谓词也会在超时后调用(如果returnPartialOnTimeouttrue). 第一个参数是当前记录列表;二是true如果此调用是由于超时造成的。 谓词可以修改记录列表。spring-doc.cadn.net.cn

AggregatingReplyingKafkaTemplate<Integer, String, String> template =
        new AggregatingReplyingKafkaTemplate<>(producerFactory, container,
                        coll -> coll.size() == releaseSize);
...
RequestReplyFuture<Integer, String, Collection<ConsumerRecord<Integer, String>>> future =
        template.sendAndReceive(record);
future.getSendFuture().get(10, TimeUnit.SECONDS); // send ok
ConsumerRecord<Integer, Collection<ConsumerRecord<Integer, String>>> consumerRecord =
        future.get(30, TimeUnit.SECONDS);

请注意,返回类型是ConsumerRecord其值是ConsumerRecords. “外层”ConsumerRecord不是“真实”记录,它由模板合成,作为请求收到的实际回复记录的持有者。 当发生正常发布(发布策略返回 true)时,主题设置为aggregatedResults;如果returnPartialOnTimeout为 true,并且发生超时(并且至少已收到一条回复记录),则该主题设置为partialResultsAfterTimeout. 该模板为这些“主题”名称提供常量静态变量:spring-doc.cadn.net.cn

/**
 * Pseudo topic name for the "outer" {@link ConsumerRecords} that has the aggregated
 * results in its value after a normal release by the release strategy.
 */
public static final String AGGREGATED_RESULTS_TOPIC = "aggregatedResults";

/**
 * Pseudo topic name for the "outer" {@link ConsumerRecords} that has the aggregated
 * results in its value after a timeout.
 */
public static final String PARTIAL_RESULTS_AFTER_TIMEOUT_TOPIC = "partialResultsAfterTimeout";

真实的ConsumerRecords 在Collection包含接收回复的实际主题。spring-doc.cadn.net.cn

回复的侦听器容器必须配置为AckMode.MANUALAckMode.MANUAL_IMMEDIATE;消费者属性enable.auto.commit必须是false(自 2.3 版以来的默认值)。 为了避免丢失消息的可能性,模板仅在未完成的请求为零时提交偏移量,即当发布策略释放最后一个未完成的请求时。 重新平衡后,可能会重复回复传递;对于任何机上请求,这些请求将被忽略;当收到已发布回复的重复回复时,您可能会看到错误日志消息。
如果您使用ErrorHandlingDeserializer使用此聚合模板,框架不会自动检测DeserializationExceptions. 相反,记录(带有nullvalue) 将完整返回,标头中存在反序列化异常。 建议应用程序调用实用工具方法ReplyingKafkaTemplate.checkDeserialization()方法来确定是否发生反序列化异常。 有关更多信息,请参阅其 JavaDocs。 这replyErrorChecker也没有调用此聚合模板;您应该对回复的每个元素执行检查。