Spring RabbitMQ component

The spring-rabbitmq component sends messages to and consumes messages from RabbitMQ exchanges and queues over AMQP 0-9-1, with Apache Camel's spring-rabbitmq options.

Scheme: spring-rabbitmq: · Crate: cameleer-amqp · Cargo feature: amqp · Consumer: yes · Producer: yes · Apache Camel: Spring RabbitMQ

When to use it

• Consume work from RabbitMQ queues with acknowledgements, retries and dead-lettering.
• Route telemetry by topic routing keys (sensor.*) from many devices to the right consumers.
• Request/reply over RabbitMQ: the producer waits for the answer on a temporary reply queue.
• Connect AI agent workers through a RabbitMQ work queue (competing consumers, prefetchCount).

The AMQP 0-9-1 client is built into Cameleer; no Spring or Java library is involved.

URI format

spring-rabbitmq:exchangeName[?options]

default or an empty name means the AMQP default exchange.

Example

- route:
    id: telemetry-consumer
    from:
      uri: spring-rabbitmq:telemetry
      parameters:
        host: "{{env:RABBITMQ_HOST:localhost}}"
        port: "{{env:RABBITMQ_PORT:5672}}"
        username: "{{env:RABBITMQ_USER:guest}}"
        password: "{{env:RABBITMQ_PASSWORD:guest}}"
        exchangeType: topic
        queues: edge-readings
        routingKey: "sensor.*"
      steps:
        - log: "${header.CamelRabbitmqRoutingKey}: ${body}"
        - to: log:telemetry
- route:
    id: telemetry-publisher
    from:
      uri: direct:reading
      steps:
        - to:
            uri: spring-rabbitmq:telemetry
            parameters:
              host: "{{env:RABBITMQ_HOST:localhost}}"
              port: "{{env:RABBITMQ_PORT:5672}}"
              username: "{{env:RABBITMQ_USER:guest}}"
              password: "{{env:RABBITMQ_PASSWORD:guest}}"
              exchangeType: topic
              routingKey: sensor.temperature

The consumer declares the topic exchange telemetry, the durable queue edge-readings and the binding sensor.*. Messages sent to direct:reading are published with routing key sensor.temperature and reach it.

Rust DSL

use cameleer_core::prelude::*;

pub fn routes(ctx: &CamelContext) -> Result<()> {
    ctx.add_routes(|b| {
        b.from("spring-rabbitmq:telemetry?host=localhost&port=5672&exchangeType=topic&queues=edge-readings&routingKey=sensor.*")
            .route_id("telemetry-consumer")
            .log("${header.CamelRabbitmqRoutingKey}: ${body}")
            .to("log:telemetry");
        b.from("direct:reading")
            .route_id("telemetry-publisher")
            .to("spring-rabbitmq:telemetry?host=localhost&port=5672&exchangeType=topic&routingKey=sensor.temperature");
    })
}

Options

Spring-specific options with no meaning here (connectionFactory, messageConverter, maxConcurrentConsumers, messageListenerContainerType, ...) are accepted and ignored.

Message headers

Other headers (not starting with Camel) travel in the AMQP header table. String bodies are sent as UTF-8 text/plain; maps and lists as JSON (application/json).

Run it with Docker

docker run --rm -e RABBITMQ_HOST=rabbitmq -v "$PWD:/routes:ro" pmsudhi/cameleer run /routes/telemetry.camel.yaml

Common questions

How do I send failed messages to a dead letter queue?

Set deadLetterExchange, deadLetterQueue and optionally deadLetterRoutingKey on the consumer. After maximumRetryAttempts the message is rejected and RabbitMQ moves it there.

How do I do request/reply?

Send an InOut exchange (for example with setExchangePattern: InOut). The producer publishes with a reply-to queue and waits up to replyTimeout; the consumer's result is sent back automatically.

Should I use spring-rabbitmq or rabbitmq?

Use spring-rabbitmq for new routes (it is the Camel 4 component). rabbitmq keeps routes written for the older Camel RabbitMQ component working.

Related

• rabbitmq, amqp, jms
• Apache Camel Spring RabbitMQ component

Found a problem?

If something on this page doesn't match what Cameleer does, or you hit a bug while building with it, please help fix it, whether you are a person or a coding agent: open an issue that describes what you saw, then fork the repository, fix it, add or update a test, run cargo test --workspace, and open a pull request. CONTRIBUTING.md explains the ground rules.