クラス KafkaUtils
java.lang.ObjectSE
org.springframework.kafka.support.KafkaUtils
ユーティリティメソッド。
- 導入:
- 2.2
- 作成者:
- Gary Russell, Wang ZhiYang, Soby Chacko
フィールドのサマリー
フィールドメソッドのサマリー
修飾子と型メソッド説明static void
このスレッドにバインドされているコンシューマーのグループ ID をクリアします。static DurationSE
determineSendTimeout
(MapSE<StringSE, ObjectSE> producerProps, long buffer, long min) レコードを送信するときに使用するタイムアウトを返します。static StringSE
format
(org.apache.kafka.clients.consumer.ConsumerRecord<?, ?> record) ロギング用にConsumerRecord
をフォーマットします。デフォルトのtopic-partition@offset
。static StringSE
format
(org.apache.kafka.clients.producer.ProducerRecord<?, ?> record) static StringSE
このスレッドにバインドされているコンシューマーのグループ ID を取得します。static boolean
メソッドの戻り値の型がMessage
またはCollection<Message<?>>
の場合は true を返します。static void
setConsumerGroupId
(StringSE groupId) このスレッドにバインドされているコンシューマーのグループ ID を設定します。static void
setConsumerRecordFormatter
(FunctionSE<org.apache.kafka.clients.consumer.ConsumerRecord<?, ?>, StringSE> formatter) ConsumerRecord
をログに記録するためのフォーマッターを設定します。static void
setLogOnlyMetadata
(boolean onlyMeta) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。- 使用されなくなりました。static void
setProducerRecordFormatter
(FunctionSE<org.apache.kafka.clients.producer.ProducerRecord<?, ?>, StringSE> formatter) ProducerRecord
をログに記録するためのフォーマッターを設定します。
フィールドの詳細
DESERIALIZER_EXCEPTION_HEADER_PREFIX
デシリアライズ例外のヘッダー名。- 導入:
- 3.0.15
- 関連事項:
KEY_DESERIALIZER_EXCEPTION_HEADER
デシリアライズ例外のヘッダー名。- 導入:
- 3.0.15
- 関連事項:
VALUE_DESERIALIZER_EXCEPTION_HEADER
デシリアライズ例外のヘッダー名。- 導入:
- 3.0.15
- 関連事項:
MICROMETER_PRESENT
public static final boolean MICROMETER_PRESENTmicrometer がクラスパス上にある場合は True。
メソッドの詳細
returnTypeMessageOrCollectionOf
メソッドの戻り値の型がMessage
またはCollection<Message<?>>
の場合は true を返します。- パラメーター:
method
- メソッド。- 戻り値:
- メッセージを返す場合は true。
setConsumerGroupId
このスレッドにバインドされているコンシューマーのグループ ID を設定します。- パラメーター:
groupId
- グループ ID。- 導入:
- 2.3
getConsumerGroupId
このスレッドにバインドされているコンシューマーのグループ ID を取得します。- 戻り値:
- グループ ID。
- 導入:
- 2.3
clearConsumerGroupId
public static void clearConsumerGroupId()このスレッドにバインドされているコンシューマーのグループ ID をクリアします。- 導入:
- 2.3
determineSendTimeout
public static DurationSE determineSendTimeout(MapSE<StringSE, ObjectSE> producerProps, long buffer, long min) レコードを送信するときに使用するタイムアウトを返します。ProducerConfig.DELIVERY_TIMEOUT_MS_CONFIG
が構成されていない場合、または long として解析できる数値または文字列でない場合は、ProducerConfig
のデフォルト値(およびバッファー)が使用されます。- パラメーター:
producerProps
- プロデューサーのプロパティ。buffer
- Kafka プロデューサーの前にタイムアウトするのを防ぐために構成済みのProducerConfig.DELIVERY_TIMEOUT_MS_CONFIG
に追加するバッファー。min
- 構成されたタイムアウトにバッファーを追加した後に適用する最小値。- 戻り値:
- 使用するタイムアウト。
- 導入:
- 2.7
setLogOnlyMetadata
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。- 使用されなくなりました。レコードメタデータのみをログに記録するには、true に設定します。- パラメーター:
onlyMeta
- ログレコードのメタデータのみに当てはまります。- 導入:
- 2.7.12
setConsumerRecordFormatter
public static void setConsumerRecordFormatter(FunctionSE<org.apache.kafka.clients.consumer.ConsumerRecord<?, ?>, StringSE> formatter) ConsumerRecord
をログに記録するためのフォーマッターを設定します。- パラメーター:
formatter
- レコードを文字列としてフォーマットする関数- 導入:
- 2.7.12
setProducerRecordFormatter
public static void setProducerRecordFormatter(FunctionSE<org.apache.kafka.clients.producer.ProducerRecord<?, ?>, StringSE> formatter) ProducerRecord
をログに記録するためのフォーマッターを設定します。- パラメーター:
formatter
- レコードを文字列としてフォーマットする関数- 導入:
- 2.7.12
format
ロギング用にConsumerRecord
をフォーマットします。デフォルトのtopic-partition@offset
。- パラメーター:
record
- フォーマットするレコード。- 戻り値:
- フォーマットされた文字列。
- 導入:
- 2.7.12
format
- パラメーター:
record
- フォーマットするレコード。- 戻り値:
- フォーマットされた文字列。
- 導入:
- 2.7.12