クラス EmbeddedKafkaKraftBroker
java.lang.ObjectSE
org.springframework.kafka.test.EmbeddedKafkaKraftBroker
- 実装されたすべてのインターフェース:
DisposableBean
、InitializingBean
、EmbeddedKafkaBroker
KRaft を使用した組み込み Kafka ブローカー。このクラスは単体テストで使用することを目的としています。
- 導入:
- 3.1
- 作成者:
- Marius Bogoevici, Artem Bilan, Gary Russell, Kamill Sokol, Elliot Kennedy, Nakul Mishra, Pawel Lozinski, Adrian Chlebosz
フィールドサマリー
フィールド修飾子と型フィールド説明static final StringSE
このプロパティの値を、"spring.embedded.kafka.brokers" の代わりに埋め込みブローカーアドレスのリストに設定する必要があるプロパティ名に設定します。static final int
インターフェース org.springframework.kafka.test.EmbeddedKafkaBroker から継承されたフィールド
BEAN_NAME, BROKER_NEEDED, LOOPBACK, SPRING_EMBEDDED_KAFKA_BROKERS
コンストラクターのサマリー
コンストラクターコンストラクター説明EmbeddedKafkaKraftBroker
(int count, int partitions, StringSE... topics) ランダムポートでリッスンする組み込み Kafka ブローカーを作成します。メソッドのサマリー
修飾子と型メソッド説明void
構成された数のパーティションを使用して、既存のブローカーにトピックを追加します。void
addTopics
(org.apache.kafka.clients.admin.NewTopic... topicsToAdd) 既存のブローカーにトピックを追加します。addTopicsWithResults
(StringSE... topicsToAdd) 構成された数のパーティションを使用して、既存のブローカーにトピックを追加します。addTopicsWithResults
(org.apache.kafka.clients.admin.NewTopic... topicsToAdd) トピックを既存のブローカーに追加し、結果のマップを返します。adminTimeout
(int adminTimeout) 管理操作のタイムアウトを秒単位で設定します (例:void
brokerListProperty
(StringSE brokerListProperty) この名前のシステムプロパティをブローカーアドレスのリストに設定します。brokerProperties
(MapSE<StringSE, StringSE> properties) 開始前に Kafka ブローカーを構成するためのプロパティを指定します。brokerProperty
(StringSE property, ObjectSE value) ブローカープロパティを指定します。void
consumeFromAllEmbeddedTopics
(org.apache.kafka.clients.consumer.Consumer<?, ?> consumer) すべての埋め込みトピックにコンシューマーをサブスクライブします。void
consumeFromAllEmbeddedTopics
(org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, boolean seekToEnd) すべての埋め込みトピックにコンシューマーをサブスクライブします。void
consumeFromAnEmbeddedTopic
(org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, boolean seekToEnd, StringSE topic) 埋め込みトピックの 1 つにコンシューマーをサブスクライブします。void
consumeFromAnEmbeddedTopic
(org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, StringSE topic) 埋め込みトピックの 1 つにコンシューマーをサブスクライブします。void
consumeFromEmbeddedTopics
(org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, boolean seekToEnd, StringSE... topicsToConsume) 1 つ以上の埋め込みトピックにコンシューマーをサブスクライブします。void
consumeFromEmbeddedTopics
(org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, StringSE... topicsToConsume) 1 つ以上の埋め込みトピックにコンシューマーをサブスクライブします。void
destroy()
void
doWithAdmin
(ConsumerSE<org.apache.kafka.clients.admin.AdminClient> callback) AdminClient
を作成します。コールバックを呼び出し、管理者を確実に閉じます。<T> T
doWithAdminFunction
(FunctionSE<org.apache.kafka.clients.admin.AdminClient, T> callback) AdminClient
を作成します。コールバックを呼び出し、管理者を確実に閉じます。ブートストラップサーバーのアドレスを文字列として取得します。kafka.testkit.KafkaClusterTestKit
int
トピックごとに構成されたパーティション数を取得します。トピックを取得します。kafkaPorts
(int... ports) IMPORTANT: KRaft ベースの EmbeddedKafka を使用する場合、カスタムポートを構成することはできません。void
setAdminTimeout
(int adminTimeout) 管理操作のタイムアウトを秒単位で設定します (例:
フィールドの詳細
BROKER_LIST_PROPERTY
このプロパティの値を、"spring.embedded.kafka.brokers" の代わりに埋め込みブローカーアドレスのリストに設定する必要があるプロパティ名に設定します。- 関連事項:
DEFAULT_ADMIN_TIMEOUT
public static final int DEFAULT_ADMIN_TIMEOUT- 関連事項:
コンストラクターの詳細
EmbeddedKafkaKraftBroker
ランダムポートでリッスンする組み込み Kafka ブローカーを作成します。- パラメーター:
count
- ブローカーの数。partitions
- トピックごとのパーティション。topics
- 作成するトピック。
メソッドの詳細
brokerProperties
開始する前に、Kafka ブローカーを構成するためのプロパティを指定します。auto.create.topics.enable
、transaction.state.log.replication.factor
など。- 次で指定:
- インターフェース
EmbeddedKafkaBroker
のbrokerProperties
- パラメーター:
properties
- Kafka ブローカーの構成に使用するプロパティ。- 戻り値:
- これはチェーン構成用です。
- 関連事項:
KafkaConfig
brokerProperty
ブローカープロパティを指定します。- パラメーター:
property
- プロパティ名。value
- 値。- 戻り値:
EmbeddedKafkaKraftBroker
kafkaPorts
IMPORTANT: KRaft ベースの EmbeddedKafka を使用する場合、カスタムポートを構成することはできません。KafkaClusterTestKit
は現時点ではカスタムポートの設定をサポートしていません。このプロパティは使用されません。Kafka ブローカーがリッスンする明示的なポートを設定します。他のプロセスからアクセスする組み込みブローカーを実行する場合に便利です。- 次で指定:
- インターフェース
EmbeddedKafkaBroker
のkafkaPorts
- パラメーター:
ports
- ポート。- 戻り値:
EmbeddedKafkaKraftBroker
brokerListProperty
この名前のシステムプロパティをブローカーアドレスのリストに設定します。- 次で指定:
- インターフェース
EmbeddedKafkaBroker
のbrokerListProperty
- パラメーター:
brokerListProperty
- 設定する brokerListProperty- 戻り値:
- このブローカー。
- 導入:
- 2.3
adminTimeout
管理操作(トピックの作成、閉じるなど)のタイムアウトを秒単位で設定します。- パラメーター:
adminTimeout
- タイムアウト。- 戻り値:
EmbeddedKafkaKraftBroker
- 導入:
- 2.8.5
setAdminTimeout
public void setAdminTimeout(int adminTimeout) 管理操作(トピックの作成、閉じるなど)のタイムアウトを秒単位で設定します。デフォルトは 10 秒です。- パラメーター:
adminTimeout
- タイムアウト。- 導入:
- 2.2
afterPropertiesSet
public void afterPropertiesSet()- 次で指定:
- インターフェース
EmbeddedKafkaBroker
のafterPropertiesSet
- 次で指定:
- インターフェース
InitializingBean
のafterPropertiesSet
destroy
public void destroy()- 次で指定:
- インターフェース
DisposableBean
のdestroy
- 次で指定:
- インターフェース
EmbeddedKafkaBroker
のdestroy
addTopics
構成された数のパーティションを使用して、既存のブローカーにトピックを追加します。ブローカーが実行されている必要があります。- 次で指定:
- インターフェース
EmbeddedKafkaBroker
のaddTopics
- パラメーター:
topicsToAdd
- トピック。
addTopics
public void addTopics(org.apache.kafka.clients.admin.NewTopic... topicsToAdd) 既存のブローカーにトピックを追加します。ブローカーが実行されている必要があります。- 次で指定:
- インターフェース
EmbeddedKafkaBroker
のaddTopics
- パラメーター:
topicsToAdd
- トピック。- 導入:
- 2.2
addTopicsWithResults
構成された数のパーティションを使用して、既存のブローカーにトピックを追加します。ブローカーが実行されている必要があります。- 次で指定:
- インターフェース
EmbeddedKafkaBroker
のaddTopicsWithResults
- パラメーター:
topicsToAdd
- トピック。- 戻り値:
- 結果 ; null 値は成功を示します。
- 導入:
- 2.5.4
addTopicsWithResults
public MapSE<StringSE,ExceptionSE> addTopicsWithResults(org.apache.kafka.clients.admin.NewTopic... topicsToAdd) 既存のブローカーにトピックを追加し、結果のマップを返します。ブローカーが実行されている必要があります。- 次で指定:
- インターフェース
EmbeddedKafkaBroker
のaddTopicsWithResults
- パラメーター:
topicsToAdd
- トピック。- 戻り値:
- 結果 ; null 値は成功を示します。
- 導入:
- 2.5.4
doWithAdmin
AdminClient
を作成します。コールバックを呼び出し、管理者を確実に閉じます。- パラメーター:
callback
- コールバック。
doWithAdminFunction
AdminClient
を作成します。コールバックを呼び出し、管理者を確実に閉じます。- 型パラメーター:
T
- 関数の戻り型。- パラメーター:
callback
- コールバック。- 戻り値:
- 結果のマップ。
- 導入:
- 2.5.4
getTopics
インターフェースからコピーされた説明:EmbeddedKafkaBroker
トピックを取得します。- 次で指定:
- インターフェース
EmbeddedKafkaBroker
のgetTopics
- 戻り値:
- トピック。
getPartitionsPerTopic
public int getPartitionsPerTopic()インターフェースからコピーされた説明:EmbeddedKafkaBroker
トピックごとに構成されたパーティション数を取得します。- 次で指定:
- インターフェース
EmbeddedKafkaBroker
のgetPartitionsPerTopic
- 戻り値:
- パーティション数。
getBrokersAsString
インターフェースからコピーされた説明:EmbeddedKafkaBroker
ブートストラップサーバーのアドレスを文字列として取得します。- 次で指定:
- インターフェース
EmbeddedKafkaBroker
のgetBrokersAsString
- 戻り値:
- ブートストラップサーバー。
getCluster
public kafka.testkit.KafkaClusterTestKit getCluster()consumeFromAllEmbeddedTopics
public void consumeFromAllEmbeddedTopics(org.apache.kafka.clients.consumer.Consumer<?, ?> consumer) すべての埋め込みトピックにコンシューマーをサブスクライブします。- 次で指定:
- インターフェース
EmbeddedKafkaBroker
のconsumeFromAllEmbeddedTopics
- パラメーター:
consumer
- コンシューマー。
consumeFromAllEmbeddedTopics
public void consumeFromAllEmbeddedTopics(org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, boolean seekToEnd) すべての埋め込みトピックにコンシューマーをサブスクライブします。- 次で指定:
- インターフェース
EmbeddedKafkaBroker
のconsumeFromAllEmbeddedTopics
- パラメーター:
seekToEnd
- 最初ではなく最後まで追求するのは本当です。consumer
- コンシューマー。- 導入:
- 2.8.2
consumeFromAnEmbeddedTopic
public void consumeFromAnEmbeddedTopic(org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, StringSE topic) 埋め込みトピックの 1 つにコンシューマーをサブスクライブします。- 次で指定:
- インターフェース
EmbeddedKafkaBroker
のconsumeFromAnEmbeddedTopic
- パラメーター:
consumer
- コンシューマー。topic
- トピック。
consumeFromAnEmbeddedTopic
public void consumeFromAnEmbeddedTopic(org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, boolean seekToEnd, StringSE topic) 埋め込みトピックの 1 つにコンシューマーをサブスクライブします。- 次で指定:
- インターフェース
EmbeddedKafkaBroker
のconsumeFromAnEmbeddedTopic
- パラメーター:
consumer
- コンシューマー。seekToEnd
- 最初ではなく最後まで追求するのは本当です。topic
- トピック。- 導入:
- 2.8.2
consumeFromEmbeddedTopics
public void consumeFromEmbeddedTopics(org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, StringSE... topicsToConsume) 1 つ以上の埋め込みトピックにコンシューマーをサブスクライブします。- 次で指定:
- インターフェース
EmbeddedKafkaBroker
のconsumeFromEmbeddedTopics
- パラメーター:
consumer
- コンシューマー。topicsToConsume
- トピック。- 例外:
IllegalStateExceptionSE
- 埋め込まれたトピックのリストにないトピックから消費しようとした場合(2.3.4 以降)。
consumeFromEmbeddedTopics
public void consumeFromEmbeddedTopics(org.apache.kafka.clients.consumer.Consumer<?, ?> consumer, boolean seekToEnd, StringSE... topicsToConsume) 1 つ以上の埋め込みトピックにコンシューマーをサブスクライブします。- 次で指定:
- インターフェース
EmbeddedKafkaBroker
のconsumeFromEmbeddedTopics
- パラメーター:
consumer
- コンシューマー。topicsToConsume
- トピック。seekToEnd
- 最初ではなく最後まで追求するのは本当です。- 例外:
IllegalStateExceptionSE
- 埋め込まれたトピックのリストにないトピックから消費しようとした場合。- 導入:
- 2.8.2