org.springframework.kafka.listener.adapter.BatchMessagingMessageListenerAdapter Maven / Gradle / Ivy
/*
* Copyright 2016-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.kafka.listener.adapter;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;
import org.apache.kafka.clients.consumer.Consumer;
import org.apache.kafka.clients.consumer.ConsumerRecord;
import org.apache.kafka.clients.consumer.ConsumerRecords;
import org.springframework.kafka.listener.BatchAcknowledgingConsumerAwareMessageListener;
import org.springframework.kafka.listener.KafkaListenerErrorHandler;
import org.springframework.kafka.listener.ListenerExecutionFailedException;
import org.springframework.kafka.support.Acknowledgment;
import org.springframework.kafka.support.converter.BatchMessageConverter;
import org.springframework.kafka.support.converter.BatchMessagingMessageConverter;
import org.springframework.messaging.Message;
import org.springframework.messaging.support.GenericMessage;
import org.springframework.messaging.support.MessageBuilder;
/**
* A {@link org.springframework.kafka.listener.MessageListener MessageListener}
* adapter that invokes a configurable {@link HandlerAdapter}; used when the factory is
* configured for the listener to receive batches of messages.
*
* Wraps the incoming Kafka Message to Spring's {@link Message} abstraction.
*
*
The original {@code List} and
* the {@link Acknowledgment} are provided as additional arguments so that these can
* be injected as method arguments if necessary.
*
* @param the key type.
* @param the value type.
*
* @author Stephane Nicoll
* @author Gary Russell
* @author Artem Bilan
* @author Venil Noronha
* @since 1.1
*/
public class BatchMessagingMessageListenerAdapter extends MessagingMessageListenerAdapter
implements BatchAcknowledgingConsumerAwareMessageListener {
private BatchMessageConverter batchMessageConverter = new BatchMessagingMessageConverter();
private KafkaListenerErrorHandler errorHandler;
private BatchToRecordAdapter batchToRecordAdapter;
/**
* Create an instance with the provided parameters.
* @param bean the listener bean.
* @param method the listener method.
*/
public BatchMessagingMessageListenerAdapter(Object bean, Method method) {
this(bean, method, null);
}
/**
* Create an instance with the provided parameters.
* @param bean the listener bean.
* @param method the listener method.
* @param errorHandler the error handler.
*/
public BatchMessagingMessageListenerAdapter(Object bean, Method method, KafkaListenerErrorHandler errorHandler) {
super(bean, method);
this.errorHandler = errorHandler;
}
/**
* Set the BatchMessageConverter.
* @param messageConverter the converter.
*/
public void setBatchMessageConverter(BatchMessageConverter messageConverter) {
this.batchMessageConverter = messageConverter;
if (messageConverter.getRecordMessageConverter() != null) {
setMessageConverter(messageConverter.getRecordMessageConverter());
}
}
/**
* Set a {@link BatchToRecordAdapter}.
* @param batchToRecordAdapter the adapter.
* @since 2.4.2
*/
public void setBatchToRecordAdapter(BatchToRecordAdapter batchToRecordAdapter) {
this.batchToRecordAdapter = batchToRecordAdapter;
}
/**
* Return the {@link BatchMessagingMessageConverter} for this listener,
* being able to convert {@link org.springframework.messaging.Message}.
* @return the {@link BatchMessagingMessageConverter} for this listener,
* being able to convert {@link org.springframework.messaging.Message}.
*/
protected final BatchMessageConverter getBatchMessageConverter() {
return this.batchMessageConverter;
}
@Override
public boolean wantsPollResult() {
return isConsumerRecords();
}
@Override
public void onMessage(ConsumerRecords records, Acknowledgment acknowledgment, Consumer consumer) {
invoke(records, acknowledgment, consumer, NULL_MESSAGE);
}
/**
* Kafka {@link org.springframework.kafka.listener.MessageListener} entry point.
*
* Delegate the message to the target listener method, with appropriate conversion of
* the message argument.
* @param records the incoming list of Kafka {@link ConsumerRecord}.
* @param acknowledgment the acknowledgment.
* @param consumer the consumer.
*/
@Override
public void onMessage(List> records, Acknowledgment acknowledgment, Consumer consumer) {
Message message;
if (!isConsumerRecordList()) {
if (isMessageList() || this.batchToRecordAdapter != null) {
List> messages = new ArrayList<>(records.size());
for (ConsumerRecord record : records) {
messages.add(toMessagingMessage(record, acknowledgment, consumer));
}
if (this.batchToRecordAdapter == null) {
message = MessageBuilder.withPayload(messages).build();
}
else {
logger.debug(() -> "Processing " + messages);
this.batchToRecordAdapter.adapt(messages, records, acknowledgment, consumer, this::invoke);
return;
}
}
else {
message = toMessagingMessage(records, acknowledgment, consumer);
}
}
else {
message = NULL_MESSAGE; // optimization since we won't need any conversion to invoke
}
logger.debug(() -> "Processing [" + message + "]");
invoke(records, acknowledgment, consumer, message);
}
protected void invoke(Object records, Acknowledgment acknowledgment, Consumer consumer,
final Message messageArg) {
Message message = messageArg;
try {
Object result = invokeHandler(records, acknowledgment, message, consumer);
if (result != null) {
handleResult(result, records, message);
}
}
catch (ListenerExecutionFailedException e) { // NOSONAR ex flow control
if (this.errorHandler != null) {
try {
if (message.equals(NULL_MESSAGE)) {
message = new GenericMessage<>(records);
}
Object result = this.errorHandler.handleError(message, e, consumer);
if (result != null) {
handleResult(result, records, message);
}
}
catch (Exception ex) {
throw new ListenerExecutionFailedException(createMessagingErrorMessage(// NOSONAR stack trace loss
"Listener error handler threw an exception for the incoming message",
message.getPayload()), ex);
}
}
else {
throw e;
}
}
}
@SuppressWarnings({ "unchecked", "rawtypes" })
protected Message toMessagingMessage(List records, Acknowledgment acknowledgment, Consumer consumer) {
return getBatchMessageConverter().toMessage(records, acknowledgment, consumer, getType());
}
}