Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/damirdenis-tudor/ktor-server-rabbitmq
Official RabbitMQ plugin for Ktor framework.
https://github.com/damirdenis-tudor/ktor-server-rabbitmq
intellij-idea kabbitmq kotlin ktor-framework ktor-plugin ktor-server-rabbitmq rabbitmq
Last synced: 4 days ago
JSON representation
Official RabbitMQ plugin for Ktor framework.
- Host: GitHub
- URL: https://github.com/damirdenis-tudor/ktor-server-rabbitmq
- Owner: DamirDenis-Tudor
- License: apache-2.0
- Created: 2024-12-11T12:27:53.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-01-21T13:34:37.000Z (6 days ago)
- Last Synced: 2025-01-21T14:24:16.077Z (6 days ago)
- Topics: intellij-idea, kabbitmq, kotlin, ktor-framework, ktor-plugin, ktor-server-rabbitmq, rabbitmq
- Language: Kotlin
- Homepage: https://central.sonatype.com/artifact/io.github.damirdenis-tudor/ktor-server-rabbitmq
- Size: 261 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [abbitMQ](https://central.sonatype.com/artifact/io.github.damirdenis-tudor/ktor-server-rabbitmq)  [Official Ktor plugin](https://start.ktor.io/settings)
 
### Overview
- `Plugin` that provides access to major core functionalities of the `com.rabbitmq:amqp-client` library.
### Features
- Integrated with coroutines and has a separate dispatcher.
- Seamlessly integrates with the Kotlin DSL, making it readable, maintainable, and easy to use.
- Includes a built-in connection/channel management system.
- Provides a built-in mechanism for validating property combinations.
- Gives the possibility to interact directly with the java library.
---
### Table of Contents
1. [Installation](#installation)
2. [Queue Binding Example](#queue-binding-example)
3. [Producer Example](#producer-example)
4. [Consumer Example](#consumer-example)
5. [Advanced Consumer Example](#advanced-consumer-example)
6. [Library Calls Example](#library-calls-example)
7. [Dead Letter Queue Example](#dead-letter-queue-example)
8. [Logging](#logging)
### Installation
```kotlin
install(KabbitMQ) {
uri = "amqp://:@
:"
defaultConnectionName = ""
connectionAttempts = 20
attemptDelay = 10
dispatcherThreadPollSize = 2
tlsEnabled = true
tlsKeystorePath = ""
tlsKeystorePassword = ""
tlsTruststorePath = ""
tlsTruststorePassword = ""
}
```
### Queue Binding Example
```kotlin
rabbitmq {
queueBind {
queue = "demo-queue"
exchange = "demo-exchange"
routingKey = "demo-routing-key"
queueDeclare {
queue = "demo-queue"
durable = true
}
exchangeDeclare {
exchange = "demo-exchange"
type = "direct"
}
}
}
```
### Producer Example
```kotlin
rabbitmq {
repeat(10) {
basicPublish {
exchange = "demo-exchange"
routingKey = "demo-routing-key"
message { "Hello World!" }
}
}
}
```
### Consumer Example
```kotlin
rabbitmq {
basicConsume {
autoAck = true
queue = "demo-queue"
deliverCallback { tag, message ->
logger.info("Received message: $message")
}
}
}
```
# Advanced Consumer Example
```kotlin
rabbitmq {
repeat(1_000_000) {
basicPublish {
exchange = "demo-exchange"
routingKey = "demo-routing-key"
message { "Hello World!" }
}
}
}
rabbitmq {
connection(id = "consume") {
basicConsume {
autoAck = true
queue = "demo-queue"
dispacher = Dispacher.IO
coroutinePollSize = 1_000
deliverCallback { tag, message ->
logger.info("Received message: $message")
delay(30)
}
}
}
}
or
rabbitmq {
connection(id = "consume") {
repeat(5) {
basicConsume {
autoAck = true
queue = "demo-queue"
dispacher = Dispacher.IO
deliverCallback { tag, message ->
launch {
logger.info("Received message: $message")
delay(30)
}
}
}
}
}
}
```
### Library Calls Example
```kotlin
rabbitmq {
libChannel(id = 1) {
basicPublish("demo-queue", "demo-routing-key", null, "Hello!".toByteArray())
val consumer = object : DefaultConsumer(channel) {
override fun handleDelivery(
consumerTag: String?,
envelope: Envelope?,
properties: AMQP.BasicProperties?,
body: ByteArray?
) {
}
}
basicConsume("demo-queue", true, consumer)
}
}
```
### Dead Letter Queue Example
```kotlin
@Serializable
data class Message(
var content: String
)
fun Application.module() {
install(RabbitMQ) {
uri = "amqp://guest:guest@localhost:5672"
dispatcherThreadPollSize = 3
}
rabbitmq {
queueBind {
queue = "dlq"
exchange = "dlx"
routingKey = "dlq-dlx"
queueDeclare {
queue = "dlq"
durable = true
}
exchangeDeclare {
exchange = "dlx"
type = "direct"
}
}
queueBind {
queue = "test-queue"
exchange = "test-exchange"
queueDeclare {
queue = "test-queue"
arguments = mapOf(
"x-dead-letter-exchange" to "dlx",
"x-dead-letter-routing-key" to "dlq-dlx"
)
}
exchangeDeclare {
exchange = "test-exchange"
type = "fanout"
}
}
}
rabbitmq {
repeat(100) {
basicPublish {
exchange = "test-exchange"
message {
Message(content = "Hello world!")
}
}
}
}
rabbitmq {
basicConsume {
queue = "test-queue"
autoAck = false
deliverCallback { tag, message ->
basicReject {
deliveryTag = tag
requeue = false
}
}
}
basicConsume {
queue = "dlq"
autoAck = true
deliverCallback { tag, message ->
println("Received message in dead letter queue: $message")
}
}
}
}
```
### Logging
- In order to set a logging level to this library add this line in `logback.xml` file:
```xml
```