DEFAULT_KEY_SERDE_CLASS_CONFIG in Kafka
The DEFAULT_KEY_SERDE_CLASS_CONFIG
is a configuration property in Apache Kafka Streams. It specifies the default serializer/deserializer (Serde) to be used for the keys of messages in your Kafka Streams application.
What Is a Serde?
A Serde is a combination of a serializer and a deserializer:
- Serializer: Converts objects into a byte array to send over Kafka.
- Deserializer: Converts the byte array back into an object.
Kafka Streams requires Serdes to know how to handle data when reading from and writing to topics.
Usage of DEFAULT_KEY_SERDE_CLASS_CONFIG
This property allows you to specify the default Serde class for the key of messages processed by Kafka Streams. For example, if your keys are strings, you would set the default key Serde to Serdes.String()
.
Example Configuration in Java:
Properties props = new Properties();
props.put(StreamsConfig.DEFAULT_KEY_SERDE_CLASS_CONFIG, Serdes.String().getClass());
props.put(StreamsConfig.DEFAULT_VALUE_SERDE_CLASS_CONFIG, Serdes.String().getClass());
Example Configuration in application.yml
:
spring:
kafka:
streams:
properties:
default.key.serde: org.apache.kafka.common.serialization.Serdes$StringSerde
default.value.serde: org.apache.kafka.common.serialization.Serdes$StringSerde
Common Serdes in Kafka Streams
Kafka Streams provides built-in Serdes for common data types:
- StringSerde: For string keys/values.
org.apache.kafka.common.serialization.Serdes.StringSerde
- IntegerSerde: For integer keys/values.
org.apache.kafka.common.serialization.Serdes.IntegerSerde
- LongSerde: For long keys/values.
org.apache.kafka.common.serialization.Serdes.LongSerde
- DoubleSerde: For double keys/values.
org.apache.kafka.common.serialization.Serdes.DoubleSerde
- ByteArraySerde: For raw binary data.
org.apache.kafka.common.serialization.Serdes.ByteArraySerde
Why Use DEFAULT_KEY_SERDE_CLASS_CONFIG
?
- Convenience: Sets a global default, so you don't need to specify the Serde for every stream/table.
- Consistency: Ensures that all keys are handled the same way unless overridden.
Overriding the Default Serde
If you need to process data differently for a specific stream, you can override the default Serde when defining the stream:
KStream<Integer, String> stream = builder.stream(
"source-topic",
Consumed.with(Serdes.Integer(), Serdes.String()) // Custom key/value Serdes
);
Let me know if you'd like to explore custom Serdes!
댓글
댓글 쓰기