クラス DefaultKafkaConsumerFactory<K,V>
java.lang.ObjectSE
org.springframework.kafka.core.KafkaResourceFactory
org.springframework.kafka.core.DefaultKafkaConsumerFactory<K,V>
- 型パラメーター:
K- 鍵の型。V- 値の型。
- 実装されているすべてのインターフェース:
Aware、BeanNameAware、ApplicationContextAware、ConsumerFactory<K,V>
public class DefaultKafkaConsumerFactory<K,V>
extends KafkaResourceFactory
implements ConsumerFactory<K,V>, BeanNameAware, ApplicationContextAware
ConsumerFactory.createConsumer() 呼び出しごとに、提供された MapSE configs およびオプションの Deserializer の新しい Consumer インスタンスを生成する ConsumerFactory 実装。 引数のないコンストラクターがあり、セットアップを必要としない Deserializer を使用している場合は、DefaultKafkaConsumerFactory コンストラクターに渡される configs の ConsumerConfig.KEY_DESERIALIZER_CLASS_CONFIG および ConsumerConfig.VALUE_DESERIALIZER_CLASS_CONFIG キーに対して Deserializer クラスを指定するのが最も簡単です。
それが不可能であるが、すべての Consumer インスタンス間で共有される可能性のある Deserializer を使用している場合 (特に、それらの close() メソッドがノーオペレーションである場合)、キーと値の一方または両方の Deserializer インスタンスを渡すことができます。デシリアライザ。
上記のいずれにも当てはまらない場合は、ファクトリで Consumer が作成されるたびに Deserializer を取得するために使用される Deserializer の一方または両方に SupplierSE を指定できます。
- 作成者:
- Gary Russell, Murali Reddy, Artem Bilan, Chris Gilbert, Adrian Gygax, Yaniv Nahoum, Sanghyeok An, Borahm Lee, Soby Chacko
ネストされたクラスの要約
ネストされたクラスインターフェース org.springframework.kafka.core.ConsumerFactory から継承されたネストクラス / インターフェース
ConsumerFactory.Listener<K,V> コンストラクターの概要
コンストラクターコンストラクター説明DefaultKafkaConsumerFactory(MapSE<StringSE, ObjectSE> configs) 提供された構成でファクトリを構築します。DefaultKafkaConsumerFactory(MapSE<StringSE, ObjectSE> configs, @Nullable SupplierSE<@Nullable org.apache.kafka.common.serialization.Deserializer<K>> keyDeserializerSupplier, @Nullable SupplierSE<@Nullable org.apache.kafka.common.serialization.Deserializer<V>> valueDeserializerSupplier) 提供された構成とデシリアライザーのサプライヤーを使用してファクトリを構築します。DefaultKafkaConsumerFactory(MapSE<StringSE, ObjectSE> configs, @Nullable SupplierSE<@Nullable org.apache.kafka.common.serialization.Deserializer<K>> keyDeserializerSupplier, @Nullable SupplierSE<@Nullable org.apache.kafka.common.serialization.Deserializer<V>> valueDeserializerSupplier, boolean configureDeserializers) 提供された構成とデシリアライザーのサプライヤーを使用してファクトリを構築します。DefaultKafkaConsumerFactory(MapSE<StringSE, ObjectSE> configs, @Nullable org.apache.kafka.common.serialization.Deserializer<K> keyDeserializer, @Nullable org.apache.kafka.common.serialization.Deserializer<V> valueDeserializer) 提供された構成とデシリアライザーを使用してファクトリを構築します。DefaultKafkaConsumerFactory(MapSE<StringSE, ObjectSE> configs, @Nullable org.apache.kafka.common.serialization.Deserializer<K> keyDeserializer, @Nullable org.apache.kafka.common.serialization.Deserializer<V> valueDeserializer, boolean configureDeserializers) 提供された構成とデシリアライザーを使用してファクトリを構築します。メソッドのサマリー
修飾子と型メソッド説明voidaddListener(int index, ConsumerFactory.Listener<K, V> listener) 特定のインデックスにリスナーを追加します。voidaddListener(ConsumerFactory.Listener<K, V> listener) リスナーを追加します。voidaddPostProcessor(ConsumerPostProcessor<K, V> postProcessor) ポストプロセッサーを追加します。createConsumer(@Nullable StringSE groupId, @Nullable StringSE clientIdPrefix, @Nullable StringSE clientIdSuffixArg, @Nullable PropertiesSE properties) 明示的なグループ ID でコンシューマーを作成します。さらに、クライアント ID サフィックスが clientIdPrefix に追加され、存在する場合はclient.idプロパティをオーバーライドします。createKafkaConsumer(@Nullable StringSE groupId, @Nullable StringSE clientIdPrefixArg, @Nullable StringSE clientIdSuffixArg, @Nullable PropertiesSE properties) createKafkaConsumer(MapSE<StringSE, ObjectSE> configProps) createRawConsumer(MapSE<StringSE, ObjectSE> configProps) Consumerを作成します。このファクトリの構成マップへの変更不可能な参照を返します。@Nullable org.apache.kafka.common.serialization.Deserializer<K> 構成されたキーデシリアライザーを返します (プロパティでクラス名の代わりにオブジェクトとして提供されている場合)。リスナーの現在のリストを取得します。ポストプロセッサーの現在のリストを取得します。@Nullable org.apache.kafka.common.serialization.Deserializer<V> 構成された値のデシリアライザーを返します (プロパティでクラス名の代わりにオブジェクトとして提供されている場合)。booleanこのファクトリによって作成されたコンシューマーが自動コミットを使用する場合は true を返します。voidremoveConfig(StringSE configKey) 指定されたキーを構成マップから削除します。booleanremoveListener(ConsumerFactory.Listener<K, V> listener) リスナーを削除します。booleanremovePostProcessor(ConsumerPostProcessor<K, V> postProcessor) ポストプロセッサーを取り外します。voidsetApplicationContext(ApplicationContext applicationContext) voidsetBeanName(StringSE name) voidsetConfigureDeserializers(boolean configureDeserializers) プログラムで提供されるデシリアライザー (コンストラクターまたは setter 経由) がコンシューマー構成を使用して構成されないようにするには、false (デフォルトは true) に設定します。例:voidsetKeyDeserializer(@Nullable org.apache.kafka.common.serialization.Deserializer<K> keyDeserializer) キーデシリアライザを設定します。voidsetKeyDeserializerSupplier(@Nullable SupplierSE<@Nullable org.apache.kafka.common.serialization.Deserializer<K>> keyDeserializerSupplier) キーデシリアライザーのインスタンスを提供するようにサプライヤーを設定します。voidsetValueDeserializer(@Nullable org.apache.kafka.common.serialization.Deserializer<V> valueDeserializer) 値デシリアライザーを設定します。voidsetValueDeserializerSupplier(@Nullable SupplierSE<@Nullable org.apache.kafka.common.serialization.Deserializer<V>> valueDeserializerSupplier) 値デシリアライザーのインスタンスを提供するようにサプライヤーを設定します。voidupdateConfigs(MapSE<StringSE, ObjectSE> updates) コンシューマー構成マップを更新します。資格情報のローテーションなどの状況で役立ちます。クラス org.springframework.kafka.core.KafkaResourceFactory から継承されたメソッド
checkBootstrap, getBootstrapServers, setBootstrapServersSupplierクラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSEインターフェース org.springframework.kafka.core.ConsumerFactory から継承されたメソッド
createConsumer, createConsumer, createConsumer, createConsumer
コンストラクターの詳細
DefaultKafkaConsumerFactory
DefaultKafkaConsumerFactory
public DefaultKafkaConsumerFactory(MapSE<StringSE, ObjectSE> configs, @Nullable org.apache.kafka.common.serialization.Deserializer<K> keyDeserializer, @Nullable org.apache.kafka.common.serialization.Deserializer<V> valueDeserializer) 提供された構成とデシリアライザーを使用してファクトリを構築します。デシリアライザーのconfigure()メソッドは、構成マップを使用して呼び出されます。- パラメーター:
configs- 構成。keyDeserializer- キーDeserializer。valueDeserializer- 値Deserializer。
DefaultKafkaConsumerFactory
public DefaultKafkaConsumerFactory(MapSE<StringSE, ObjectSE> configs, @Nullable org.apache.kafka.common.serialization.Deserializer<K> keyDeserializer, @Nullable org.apache.kafka.common.serialization.Deserializer<V> valueDeserializer, boolean configureDeserializers) 提供された構成とデシリアライザーを使用してファクトリを構築します。デシリアライザーのconfigure()メソッドは、configureDeserializersが false でない限り、構成マップを使用して呼び出されます。- パラメーター:
configs- 構成。keyDeserializer- キーDeserializer。valueDeserializer- 値Deserializer。configureDeserializers- デシリアライザーを構成しない場合は false。- 導入:
- 2.8.7
DefaultKafkaConsumerFactory
public DefaultKafkaConsumerFactory(MapSE<StringSE, ObjectSE> configs, @Nullable SupplierSE<@Nullable org.apache.kafka.common.serialization.Deserializer<K>> keyDeserializerSupplier, @Nullable SupplierSE<@Nullable org.apache.kafka.common.serialization.Deserializer<V>> valueDeserializerSupplier) 提供された構成およびデシリアライザーのサプライヤーを使用してファクトリを構築します。インスタンスを取得するためにサプライヤーが呼び出されると、デシリアライザのconfigure()メソッドが構成マップとともに呼び出されます。- パラメーター:
configs- 構成。keyDeserializerSupplier- キーDeserializerサプライヤー関数。valueDeserializerSupplier- 値Deserializerサプライヤー関数。- 導入:
- 2.3
DefaultKafkaConsumerFactory
public DefaultKafkaConsumerFactory(MapSE<StringSE, ObjectSE> configs, @Nullable SupplierSE<@Nullable org.apache.kafka.common.serialization.Deserializer<K>> keyDeserializerSupplier, @Nullable SupplierSE<@Nullable org.apache.kafka.common.serialization.Deserializer<V>> valueDeserializerSupplier, boolean configureDeserializers) 提供された構成およびデシリアライザーのサプライヤーを使用してファクトリを構築します。インスタンスを取得するためにサプライヤーが呼び出されると、configureDeserializersが false でない限り、デシリアライザのconfigure()メソッドが構成マップとともに呼び出されます。- パラメーター:
configs- 構成。keyDeserializerSupplier- キーDeserializerサプライヤー関数。valueDeserializerSupplier- 値Deserializerサプライヤー関数。configureDeserializers- デシリアライザーを構成しない場合は false。- 導入:
- 2.8.7
メソッドの詳細
setBeanName
- 次で指定:
- インターフェース
BeanNameAwareのsetBeanName
setKeyDeserializer
public void setKeyDeserializer(@Nullable org.apache.kafka.common.serialization.Deserializer<K> keyDeserializer) キーデシリアライザーを設定します。デシリアライザーは、configureDeserializersが false でない限り、コンシューマー構成を使用して構成されます。- パラメーター:
keyDeserializer- デシリアライザー。
setValueDeserializer
public void setValueDeserializer(@Nullable org.apache.kafka.common.serialization.Deserializer<V> valueDeserializer) デシリアライザーの値を設定します。デシリアライザーは、configureDeserializersが false でない限り、コンシューマー構成を使用して構成されます。- パラメーター:
valueDeserializer- 値デシリアライザー。
setKeyDeserializerSupplier
public void setKeyDeserializerSupplier(@Nullable SupplierSE<@Nullable org.apache.kafka.common.serialization.Deserializer<K>> keyDeserializerSupplier) キーデシリアライザーのインスタンスを提供するようにサプライヤーを設定します。デシリアライザーは、configureDeserializersが false でない限り、コンシューマー構成を使用して構成されます。- パラメーター:
keyDeserializerSupplier- サプライヤー。- 導入:
- 2.8
setValueDeserializerSupplier
public void setValueDeserializerSupplier(@Nullable SupplierSE<@Nullable org.apache.kafka.common.serialization.Deserializer<V>> valueDeserializerSupplier) 値デシリアライザーのインスタンスを提供するようにサプライヤーを設定します。デシリアライザーは、configureDeserializersが false でない限り、コンシューマー構成を使用して構成されます。- パラメーター:
valueDeserializerSupplier- サプライヤー。- 導入:
- 2.8
setConfigureDeserializers
public void setConfigureDeserializers(boolean configureDeserializers) デシリアライザーがすでに完全に構成されている場合など、プログラムで提供されるデシリアライザー (コンストラクターまたは setter 経由) がコンシューマー構成を使用して構成されるのを防ぐには、false (デフォルトは true) に設定します。- パラメーター:
configureDeserializers- 構成しない場合は false。- 導入:
- 2.8.7
- 関連事項:
getConfigurationProperties
インターフェースからコピーされた説明:ConsumerFactoryこのファクトリの構成マップへの変更不可能な参照を返します。類似のファクトリを作るためのクローン作成に便利です。- 次で指定:
- インターフェース
ConsumerFactory<K,のV> getConfigurationProperties - 戻り値:
- 構成。
getKeyDeserializer
インターフェースからコピーされた説明:ConsumerFactory構成されたキーデシリアライザーを返します (プロパティでクラス名の代わりにオブジェクトとして提供されている場合)。- 次で指定:
- インターフェース
ConsumerFactory<K,のV> getKeyDeserializer - 戻り値:
- デシリアライザー。
getValueDeserializer
インターフェースからコピーされた説明:ConsumerFactory構成された値のデシリアライザーを返します (プロパティでクラス名の代わりにオブジェクトとして提供されている場合)。- 次で指定:
- インターフェース
ConsumerFactory<K,のV> getValueDeserializer - 戻り値:
- デシリアライザー。
getListeners
リスナーの現在のリストを取得します。- 次で指定:
- インターフェース
ConsumerFactory<K,のV> getListeners - 戻り値:
- リスナー。
- 導入:
- 2.5
getPostProcessors
インターフェースからコピーされた説明:ConsumerFactoryポストプロセッサーの現在のリストを取得します。- 次で指定:
- インターフェース
ConsumerFactory<K,のV> getPostProcessors - 戻り値:
- ポストプロセッサー。
addListener
リスナーを追加します。- 次で指定:
- インターフェース
ConsumerFactory<K,のV> addListener - パラメーター:
listener- リスナー。- 導入:
- 2.5
addListener
特定のインデックスにリスナーを追加します。- 次で指定:
- インターフェース
ConsumerFactory<K,のV> addListener - パラメーター:
index- インデックス (リストの位置)。listener- リスナー。- 導入:
- 2.5
addPostProcessor
インターフェースからコピーされた説明:ConsumerFactoryポストプロセッサーを追加します。- 次で指定:
- インターフェース
ConsumerFactory<K,のV> addPostProcessor - パラメーター:
postProcessor- ポストプロセッサー。
removePostProcessor
インターフェースからコピーされた説明:ConsumerFactoryポストプロセッサーを取り外します。- 次で指定:
- インターフェース
ConsumerFactory<K,のV> removePostProcessor - パラメーター:
postProcessor- ポストプロセッサー。- 戻り値:
- 削除された場合は true。
removeListener
リスナーを削除します。- 次で指定:
- インターフェース
ConsumerFactory<K,のV> removeListener - パラメーター:
listener- リスナー。- 戻り値:
- 削除された場合は true。
- 導入:
- 2.5
updateConfigs
インターフェースからコピーされた説明:ConsumerFactoryコンシューマー構成マップを更新します。資格情報のローテーションなどの状況で役立ちます。- 次で指定:
- インターフェース
ConsumerFactory<K,のV> updateConfigs - パラメーター:
updates- 更新する構成プロパティ。
removeConfig
インターフェースからコピーされた説明:ConsumerFactory指定されたキーを構成マップから削除します。- 次で指定:
- インターフェース
ConsumerFactory<K,のV> removeConfig - パラメーター:
configKey- 削除するキー。
createConsumer
public org.apache.kafka.clients.consumer.Consumer<K,V> createConsumer(@Nullable StringSE groupId, @Nullable StringSE clientIdPrefix, @Nullable StringSE clientIdSuffixArg, @Nullable PropertiesSE properties) インターフェースからコピーされた説明:ConsumerFactory明示的なグループ ID でコンシューマーを作成します。さらに、クライアント ID サフィックスが clientIdPrefix に追加され、存在する場合はclient.idプロパティをオーバーライドします。さらに、ファクトリ実装がサポートしている場合は、コンシューマープロパティをオーバーライドできます。- 次で指定:
- インターフェース
ConsumerFactory<K,のV> createConsumer - パラメーター:
groupId- グループ ID。clientIdPrefix- プレフィックス。clientIdSuffixArg- 接尾辞。properties- オーバーライドするプロパティ。- 戻り値:
- コンシューマー。
createKafkaConsumer
createKafkaConsumer
createRawConsumer
protected org.apache.kafka.clients.consumer.Consumer<K,V> createRawConsumer(MapSE<StringSE, ObjectSE> configProps) Consumerを作成します。デフォルトでは、このメソッドは、このlistenersに提供されたことを認識する内部DefaultKafkaConsumerFactory<K,を返します。そのため、カスタムV>.ExtendedKafkaConsumer Consumerにlistenersがまだ関与している場合は、そのクラスを継承することをお勧めします。- パラメーター:
configProps- 構成プロパティ。- 戻り値:
- コンシューマー。
- 導入:
- 2.5
isAutoCommit
public boolean isAutoCommit()インターフェースからコピーされた説明:ConsumerFactoryこのファクトリによって作成されたコンシューマーが自動コミットを使用する場合は true を返します。- 次で指定:
- インターフェース
ConsumerFactory<K,のV> isAutoCommit - 戻り値:
- 自動コミットの場合は true。
setApplicationContext
- 次で指定:
- インターフェース
ApplicationContextAwareのsetApplicationContext - 例外:
BeansException