vooft/kotlin-kafka-client

Kotlin Multiplatform client written from scratch

kotlin-kafka-client

Kotlin Multiplatform implementation of Kafka client, written from scratch.

This library is at the moment in early development stage and should not be used in production.

Used technologies:

• Kotlin Coroutines
• Network layer
  • net.socket from NodeJS wrapper for JS and WASM
  • ktor-network for other platforms
• Serialization - kotlinx-serialization (with custom serializer for Kafka protocol)

Demo app

There is a demo app built using Compose Multiplatform that runs on Android, iOS and Desktop: kotlin-kafka-client-demo

Quick start

Library is published to Maven Central under name io.github.vooft:kotlin-kafka-client-core.

Add the dependency to your project:

kotlin {
    ...

    sourceSets {
        commonMain.dependencies {
            implementation("io.github.vooft:kotlin-kafka-client-core:<version>")
        }
    }
}

Then in your code, start with class KafkaCluster:

fun main() {
    // define bootstrap servers
    val bootstrapServers = listOf(
      BrokerAddress("localhost", 9092),
      BrokerAddress("localhost", 9093),
      BrokerAddress("localhost", 9094)
    )
    
    // create instance of KafkaCluster
    val cluster = KafkaCluster(bootstrapServers)
    
    // both producer and consumer are bound to a single topic
    
    val producer = cluster.createProducer(KafkaTopic("my-topic"))
    producer.send("my-key", "my-value")
    
    // consumer can be used both with group and without (in this case group is not created and no offset remembered)
    val consumer = cluster.createConsumer(KafkaTopic("my-topic"), GroupId("my-group"))
    
    // low-level API is similar to the kafka-clients implementation, but Flow-based API is on the way
    consumer.consume().forEach {
      println(it)
    }
}

Goals and non-goals

Main goal for this library is to provide a simple library to use for typical Kafka use-cases, such as produce to a topic from one service and consume from it in another, optionally using groups to consume in parallel.

It is not a goal to implement all the features of Kafka protocol, for example to be used in Kafka Streams.

Supported features

At the moment library supports only basic features of Kafka protocol:

• Cluster
  • Multiple bootstrap servers
  • Multiple brokers
• Producer
  • Produce records to a topic with multiple partitions on different brokers
  • Batching records publishing to different servers
  • Using key to determine partition
• Consumer
  • Consume records from a topic with multiple partitions on different brokers
  • Using group to consume records in parallel
  • Heartbeat to maintain group membership