クラス BatchMessagingMessageListenerAdapter<K,V>
java.lang.ObjectSE
org.springframework.kafka.listener.adapter.MessagingMessageListenerAdapter<K,V>
org.springframework.kafka.listener.adapter.BatchMessagingMessageListenerAdapter<K,V>
- 型パラメーター:
K
- 鍵の型。V
- 値の型。
- 実装されたすべてのインターフェース:
AsyncRepliesAware
、BatchAcknowledgingConsumerAwareMessageListener<K,
、V> BatchMessageListener<K,
、V> ConsumerSeekAware
、GenericMessageListener<ListSE<org.apache.kafka.clients.consumer.ConsumerRecord<K,
V>>>
public class BatchMessagingMessageListenerAdapter<K,V>
extends MessagingMessageListenerAdapter<K,V>
implements BatchAcknowledgingConsumerAwareMessageListener<K,V>
構成可能な
HandlerAdapter
を呼び出す MessageListener
アダプター。リスナーがメッセージのバッチを受信するようにファクトリが構成されている場合に使用されます。 受信 Kafka メッセージを Spring の Message
抽象化にラップします。
元の List<ConsumerRecord>
と Acknowledgment
は追加の引数として提供されているため、必要に応じてこれらをメソッド引数として挿入できます。
- 導入:
- 1.1
- 作成者:
- Stephane Nicoll, Gary Russell, Artem Bilan, Venil Noronha, Wang ZhiYang
ネストされたクラスのサマリー
クラス org.springframework.kafka.listener.adapter.MessagingMessageListenerAdapter から継承されたネストクラス / インターフェース
MessagingMessageListenerAdapter.ReplyExpressionRoot
インターフェース org.springframework.kafka.listener.ConsumerSeekAware から継承されたネストクラス / インターフェース
ConsumerSeekAware.ConsumerSeekCallback
フィールドサマリー
クラス org.springframework.kafka.listener.adapter.MessagingMessageListenerAdapter から継承されたフィールド
logger, NULL_MESSAGE
コンストラクターのサマリー
コンストラクターコンストラクター説明BatchMessagingMessageListenerAdapter
(ObjectSE bean, MethodSE method) 指定されたパラメーターを使用してインスタンスを作成します。BatchMessagingMessageListenerAdapter
(ObjectSE bean, MethodSE method, KafkaListenerErrorHandler errorHandler) 指定されたパラメーターを使用してインスタンスを作成します。メソッドのサマリー
修飾子と型メソッド説明protected final BatchMessageConverter
Message
を変換できるようにして、このリスナーのBatchMessagingMessageConverter
を返します。void
onMessage
(ListSE<org.apache.kafka.clients.consumer.ConsumerRecord<K, V>> records, Acknowledgment acknowledgment, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer) KafkaMessageListener
エントリポイント。void
onMessage
(org.apache.kafka.clients.consumer.ConsumerRecords<K, V> records, Acknowledgment acknowledgment, org.apache.kafka.clients.consumer.Consumer<K, V> consumer) リスナーは、ConsumerRecord
のリストの代わりに、元のConsumerRecords
オブジェクトを受け取ります。void
setBatchMessageConverter
(BatchMessageConverter messageConverter) BatchMessageConverter を設定します。void
setBatchToRecordAdapter
(BatchToRecordAdapter<K, V> batchToRecordAdapter) BatchToRecordAdapter
を設定します。protected Message<?>
toMessagingMessage
(ListSE records, Acknowledgment acknowledgment, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer) boolean
このリスナーがConsumerRecord
のリストの代わりに元のConsumerRecords
オブジェクトを受け取りたい場合は true を返します。クラス org.springframework.kafka.listener.adapter.MessagingMessageListenerAdapter から継承されたメソッド
acknowledge, asyncFailure, asyncSuccess, createMessagingErrorMessage, determineInferredType, getMessageConverter, getReplyHeadersConfigurer, getType, handleException, handleResult, invoke, invokeHandler, isAsyncReplies, isConsumerRecordList, isConsumerRecords, isConversionNeeded, isMessageList, isSplitIterables, onIdleContainer, onPartitionsAssigned, onPartitionsRevoked, registerSeekCallback, sendResponse, setBeanResolver, setCorrelationHeaderName, setFallbackType, setHandlerMethod, setMessageConverter, setMessagingConverter, setReplyHeadersConfigurer, setReplyTemplate, setReplyTopic, setSplitIterables, toMessagingMessage
クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.kafka.listener.BatchAcknowledgingConsumerAwareMessageListener から継承されたメソッド
onMessage
インターフェース org.springframework.kafka.listener.ConsumerSeekAware から継承されたメソッド
onFirstPoll, unregisterSeekCallback
インターフェース org.springframework.kafka.listener.GenericMessageListener から継承されたメソッド
onMessage, onMessage
コンストラクターの詳細
BatchMessagingMessageListenerAdapter
指定されたパラメーターを使用してインスタンスを作成します。- パラメーター:
bean
- リスナー Bean。method
- リスナーメソッド。
BatchMessagingMessageListenerAdapter
public BatchMessagingMessageListenerAdapter(ObjectSE bean, MethodSE method, @Nullable KafkaListenerErrorHandler errorHandler) 指定されたパラメーターを使用してインスタンスを作成します。- パラメーター:
bean
- リスナー Bean。method
- リスナーメソッド。errorHandler
- エラーハンドラー。
メソッドの詳細
setBatchMessageConverter
BatchMessageConverter を設定します。- パラメーター:
messageConverter
- コンバーター。
setBatchToRecordAdapter
BatchToRecordAdapter
を設定します。- パラメーター:
batchToRecordAdapter
- アダプター。- 導入:
- 2.4.2
getBatchMessageConverter
Message
を変換できるようにして、このリスナーのBatchMessagingMessageConverter
を返します。- 戻り値:
- このリスナーの
BatchMessagingMessageConverter
。Message
を変換できます。
wantsPollResult
public boolean wantsPollResult()インターフェースからコピーされた説明:BatchMessageListener
このリスナーがConsumerRecord
のリストの代わりに元のConsumerRecords
オブジェクトを受け取りたい場合は true を返します。- 次で指定:
- インターフェース
BatchMessageListener<K,
のV> wantsPollResult
- 戻り値:
- コンシューマーレコードの場合は true。
onMessage
public void onMessage(org.apache.kafka.clients.consumer.ConsumerRecords<K, V> records, @Nullable Acknowledgment acknowledgment, org.apache.kafka.clients.consumer.Consumer<K, V> consumer) インターフェースからコピーされた説明:BatchMessageListener
リスナーは、ConsumerRecord
のリストの代わりに、元のConsumerRecords
オブジェクトを受け取ります。- 次で指定:
- インターフェース
BatchMessageListener<K,
のV> onMessage
- パラメーター:
records
- 記録。acknowledgment
- 承認 (手動 ACK でない場合は null)consumer
- コンシューマー。
onMessage
public void onMessage(ListSE<org.apache.kafka.clients.consumer.ConsumerRecord<K, V>> records, @Nullable Acknowledgment acknowledgment, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer) KafkaMessageListener
エントリポイント。メッセージ引数を適切に変換して、メッセージをターゲットリスナーメソッドに委譲します。
- 次で指定:
- インターフェース
BatchAcknowledgingConsumerAwareMessageListener<K,
のV> onMessage
- 次で指定:
- インターフェース
GenericMessageListener<K>
のonMessage
- パラメーター:
records
- KafkaConsumerRecord
の受信リスト。acknowledgment
- 承認。consumer
- コンシューマー。
toMessagingMessage
protected Message<?> toMessagingMessage(ListSE records, @Nullable Acknowledgment acknowledgment, org.apache.kafka.clients.consumer.Consumer<?, ?> consumer)