GuicedEE RabbitMQ Skill

GuicedEE RabbitMQ

Annotation-driven RabbitMQ integration for GuicedEE using the Vert.x RabbitMQ client.

Core Concept

Declare connections, exchanges, queues, consumers, and publishers with annotations — everything is discovered at startup via ClassGraph, wired through Guice, and managed by the Vert.x RabbitMQ client.

Required Flow

Add com.guicedee:rabbitmq dependency.

Define a connection and exchange on package-info.java (or any class):

@Verticle
@RabbitConnectionOptions(
    value = "my-connection",
    host = "localhost",
    user = "guest",
    password = "guest"
)
@QueueExchange(
    value = "my-exchange",
    exchangeType = QueueExchange.ExchangeType.Direct,
    durable = true
)
package com.example.messaging;

Create a consumer:

@QueueDefinition("order-events")
public class OrderConsumer implements QueueConsumer {
    @Override
    public void consume(RabbitMQMessage message) {
        System.out.println("Received: " + message.body());
    }
}

Inject a publisher:

public class OrderService {
    @Inject @Named("order-events")
    private QueuePublisher orderPublisher;

    public void placeOrder(String orderJson) {
        orderPublisher.publish(orderJson);
    }
}

Configure module-info.java:

module my.app {
    requires com.guicedee.rabbit;
    opens my.app.messaging to com.google.guice, com.guicedee.rabbit;
}

Annotations

`@RabbitConnectionOptions`

Connection configuration: host, port, credentials, virtual host, reconnect, publisher confirms.

`@QueueExchange`

Exchange declaration: name, type (Direct, Fanout, Topic, Headers), durability, auto-delete, dead-letter exchange.

`@QueueDefinition`

Queue declaration: name, routing key, bound exchange reference.

`@QueueOptions`

Queue tuning: priority, prefetch count, TTL, durability, auto-ack, single-consumer, exclusive, transacted, consumer count, dedicated channel/connection.

Environment Variable Overrides

Every annotation attribute can be overridden via system properties or environment variables at runtime, scoped by connection/exchange/queue name.

Startup Flow

IGuiceContext.instance().inject()
 └─ RabbitMQPreStartup (annotation scanning)
     ├─ Discovers @RabbitConnectionOptions
     ├─ Discovers @QueueExchange per package
     ├─ Discovers @QueueDefinition consumers
     └─ Registers metadata for binding
 └─ RabbitMQModule (Guice bindings)
     ├─ Creates RabbitMQClient per connection
     ├─ Binds QueueConsumer as singletons
     └─ Binds QueuePublisher as @Named("queue-name")
 └─ RabbitPostStartup (runtime initialization)
     ├─ Starts connections
     ├─ Declares exchanges and queues
     ├─ Binds queues to exchanges
     └─ Starts consumer listeners

Publisher completion

QueuePublisher.publish(String) returns void. Its current implementation handles publish and optional confirm callbacks internally; returning from the method does not report broker acceptance to the caller. Where business logic must await acceptance, use or extend an API exposing that completion rather than wrapping the void call in an already-completed future.

Non-Negotiable Constraints

Module must requires com.guicedee.rabbit;.
Consumer/publisher packages must opens to com.google.guice and com.guicedee.rabbit.
DTO packages must opens to tools.jackson.databind.
SPI implementations must be dual-registered (module-info.java + META-INF/services/).
@RabbitConnectionOptions and @QueueExchange can be placed on package-info.java (preferred) or any class.
Verticle-scoped connections use @Verticle on the package.

Agent Skills: GuicedEE RabbitMQ

Install this agent skill to your local

Skill Files