# php-amqplib/rabbitmqbundle architecture

> Architecture diagram of the GitHub repository php-amqplib/rabbitmqbundle, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-26). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/php-amqplib/rabbitmqbundle
- Repository: https://github.com/php-amqplib/rabbitmqbundle

## Overview

##### Project Type and Purpose
- This is a Symfony-style “bundle” (library) that integrates RabbitMQ messaging into PHP applications via php-amqplib.
- It offers CLI commands (producers, consumers, RPC servers/clients, batch, anonymous, dynamic consumers), a DependencyInjection extension, compiler passes, event hooks, memory and data collectors for Symfony profiler.

##### File‐Structure Analysis
- Top-level “src” equivalent:
- Command/…  – CLI command classes (rabbitmq:consumer, rabbitmq:producer, purge, delete, rpc-server, setup-fabric, etc.).
- RabbitMq/…  – Core message‐driver classes wrapping php-amqplib: connection factory, channel, producer, consumer, RPC client/server, batch, anon, dynamic, multiple consumers, exceptions, QoS, fallback.
- DependencyInjection/…  – Symfony DI Extension and CompilerPass classes to parse YAML config, register “parts” (connections, producers, consumers, RPC endpoints, etc.) into the container.
- Provider/…  – Interfaces for dynamic parameters (ConnectionParametersProvider, QueueOptionsProvider, QueuesProvider).
- DataCollector/… & MemoryChecker/…  – Symfony profiler integrations.
- Event/…  – Event classes fired around message publish/consume (Before/AfterProducerPublishMessageEvent, Before/AfterProcessingMessageEvent, OnConsumeEvent, OnIdleEvent).
- Configuration files: Resources/config/rabbitmq.xml (service definitions), .github workflows, phpunit.xml.dist, composer.json, static analysis config.

##### README Insights
- Describes the bundle’s purpose, installation in Symfony or standalone console app, configuration schema (connections, producers, consumers, rpc_clients/servers, batch, anon, dynamic, multiple), commands, features (lazy, QoS, heartbeat, memory limits, graceful shutdown), events, setup-fabric.

a. Main Components
- Symfony Application / Console App
– Boots Symfony HttpKernel or Console Kernel
– Loads services via DependencyInjection component
- OldSoundRabbitMqBundle (Bundle)
– Extension (OldSoundRabbitMqExtension)
– Compiler Passes (RegisterPartsPass, InjectEventDispatcherPass, ServiceContainerPass)
– Service Container Definitions (connections, producers, consumers, rpc‐clients/servers, batch, dynamic, anon, multiple, bindings)
- CLI Commands
– Command classes invoke RabbitMq services (ConsumerCommand, ProducerCommand, RpcServerCommand, StdInProducerCommand, PurgeConsumerCommand, DeleteCommand, SetupFabricCommand, AnonConsumerCommand, BatchConsumerCommand, DynamicConsumerCommand, MultipleConsumerCommand)
- RabbitMq Driver Layer
– AMQPConnectionFactory → AMQPConnection
– AMQPLoggedChannel
– BaseAmqp, Producer, Consumer, RpcClient/Server, BatchConsumer, AnonConsumer, MultipleConsumer, DynamicConsumer, Fallback, QoS, Binding
- Symfony EventDispatcher
– Hooks into BeforeProducerPublishMessageEvent, AfterProducerPublishMessageEvent, BeforeProcessingMessageEvent, AfterProcessingMessageEvent, OnConsumeEvent, OnIdleEvent
- External RabbitMQ Broker
– Exchanges, Queues, Bindings established by setup-fabric or auto-setup in producers/consumers
- Symfony Profiler / DataCollector
– MessageDataCollector, MemoryConsumptionChecker

b. Interactions & Data Flow
1. During container build, Extension reads YAML config → CompilerPass registers each “part” tag → Service definitions for connections, producers, consumers, RPC clients/servers, etc.
2. On CLI invocation (e.g. `rabbitmq:consumer upload_picture`):
– The Console app resolves ConsumerCommand → invokes Consumer service → uses AMQPConnectionFactory to open connection to RabbitMQ → declares exchange & queue → starts loop receiving AMQPMessage → dispatches Before/AfterProcessingMessageEvent → invokes user callback → ack/nack.
3. On publish (`rabbitmq:producer upload_picture` or via injected ProducerInterface):
– Publisher service builds AMQPMessage → dispatches BeforeProducerPublishMessageEvent → sends to exchange via channel → dispatches AfterProducerPublishMessageEvent.
4. RPC calls: RpcClient adds request(s), listens on reply-to or amq.rabbitmq.reply-to queue → RpcServerCommand listens for requests, dispatches callback, replies.
5. Batch / Multiple / Dynamic / Anonymous consumers follow similar flows with specialized wrapper classes.
6. DataCollector & MemoryChecker services subscribe to events or CLI execution to collect profiling data.

c. Architectural Patterns & Principles
- Dependency Injection + Compiler Passes to auto-register messaging endpoints
- Command Pattern for CLI entry points
- Adapter/Wrapper around php-amqplib for easier use in Symfony
- Event Dispatcher for cross-cutting concerns (logging, metrics, custom hooks)
- Strategy Pattern via Provider interfaces (dynamic parameters, queue options)
- Decoupling producer ↔ consumer via AMQP exchanges/queues (pub-sub)

d. Key Technologies & Frameworks
- Symfony Components: Console, DependencyInjection, Config, EventDispatcher, Twig (for data collector view)
- php-amqplib library for AMQP protocol
- PHPUnit, PHPStan, Scrutinizer for testing & QA
- RabbitMQ broker

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Top Layer: Application
    Kernel["Console Kernel"]:::symfony

    %% Bundle Setup
    subgraph "Bundle Setup"
        BundleEntry["OldSoundRabbitMqBundle"]:::bundle
        Extension["OldSoundRabbitMqExtension"]:::bundle
        ConfigDef["Configuration"]:::bundle
        rabbitmqXML["rabbitmq.xml"]:::bundle
        RegisterPartsPass["RegisterPartsPass"]:::bundle
        InjectEventDispatcherPass["InjectEventDispatcherPass"]:::bundle
        ServiceContainerPass["ServiceContainerPass"]:::bundle
    end

    %% CLI Commands Layer
    subgraph "CLI Commands"
        ConsumerCmd["ConsumerCommand"]:::command
        StdInProducerCmd["StdInProducerCommand"]:::command
        PurgeConsumerCmd["PurgeConsumerCommand"]:::command
        DeleteCmd["DeleteCommand"]:::command
        RpcServerCmd["RpcServerCommand"]:::command
        SetupFabricCmd["SetupFabricCommand"]:::command
        AnonConsumerCmd["AnonConsumerCommand"]:::command
        BatchConsumerCmd["BatchConsumerCommand"]:::command
        DynamicConsumerCmd["DynamicConsumerCommand"]:::command
        MultipleConsumerCmd["MultipleConsumerCommand"]:::command
    end

    %% Driver Layer
    subgraph "RabbitMq Driver"
        AMQPConnectionFactory["AMQPConnectionFactory"]:::driver
        AMQPLoggedChannel["AMQPLoggedChannel"]:::driver
        BaseAmqp["BaseAmqp"]:::driver
        Producer["Producer"]:::driver
        Consumer["Consumer"]:::driver
        RpcClient["RpcClient"]:::driver
        RpcServer["RpcServer"]:::driver
        BatchConsumer["BatchConsumer"]:::driver
        AnonConsumer["AnonConsumer"]:::driver
        DynamicConsumer["DynamicConsumer"]:::driver
        MultipleConsumer["MultipleConsumer"]:::driver
        Binding["Binding"]:::driver
        Fallback["Fallback"]:::driver
    end

    %% External Broker
    RabbitMQ["RabbitMQ Broker"]:::external

    %% Event & Profiler Side
    subgraph "Event & Profiler"
        EventDispatcher["EventDispatcher"]:::symfony
        BeforeProdEvt["BeforeProducerPublishMessageEvent"]:::bundle
        AfterProdEvt["AfterProducerPublishMessageEvent"]:::bundle
        BeforeProcEvt["BeforeProcessingMessageEvent"]:::bundle
        AfterProcEvt["AfterProcessingMessageEvent"]:::bundle
        OnConsumeEvt["OnConsumeEvent"]:::bundle
        OnIdleEvt["OnIdleEvent"]:::bundle
        MessageDataCollector["MessageDataCollector"]:::profiler
        MemoryChecker["MemoryConsumptionChecker"]:::profiler
    end

    %% Connections
    Kernel --> BundleEntry
    BundleEntry --> Extension
    Extension --> ConfigDef
    Extension --> rabbitmqXML
    Extension --> RegisterPartsPass
    Extension --> InjectEventDispatcherPass
    Extension --> ServiceContainerPass

    Kernel --> ConsumerCmd
    Kernel --> StdInProducerCmd
    Kernel --> PurgeConsumerCmd
    Kernel --> DeleteCmd
    Kernel --> RpcServerCmd
    Kernel --> SetupFabricCmd
    Kernel --> AnonConsumerCmd
    Kernel --> BatchConsumerCmd
    Kernel --> DynamicConsumerCmd
    Kernel --> MultipleConsumerCmd

    ConsumerCmd --> Consumer
    StdInProducerCmd --> Producer
    PurgeConsumerCmd --> Consumer
    DeleteCmd --> Producer
    RpcServerCmd --> RpcServer
    SetupFabricCmd --> Binding
    AnonConsumerCmd --> AnonConsumer
    BatchConsumerCmd --> BatchConsumer
    DynamicConsumerCmd --> DynamicConsumer
    MultipleConsumerCmd --> MultipleConsumer

    Producer --> BaseAmqp
    Consumer --> BaseAmqp
    RpcClient --> BaseAmqp
    RpcServer --> BaseAmqp
    BatchConsumer --> BaseAmqp
    AnonConsumer --> BaseAmqp
    DynamicConsumer --> BaseAmqp
    MultipleConsumer --> BaseAmqp

    BaseAmqp --> AMQPConnectionFactory --> AMQPLoggedChannel --> RabbitMQ
    Binding --> AMQPConnectionFactory --> RabbitMQ
    Fallback --> BaseAmqp

    %% Events flow
    Producer --> EventDispatcher
    Consumer --> EventDispatcher
    RpcClient --> EventDispatcher
    RpcServer --> EventDispatcher

    EventDispatcher --> BeforeProdEvt --> MessageDataCollector
    EventDispatcher --> AfterProdEvt --> MessageDataCollector
    EventDispatcher --> BeforeProcEvt --> MemoryChecker
    EventDispatcher --> AfterProcEvt --> MemoryChecker
    EventDispatcher --> OnConsumeEvt --> MessageDataCollector
    EventDispatcher --> OnIdleEvt --> MemoryChecker

    %% Click Events
    click BundleEntry "https://github.com/php-amqplib/rabbitmqbundle/blob/master/OldSoundRabbitMqBundle.php"
    click Extension "https://github.com/php-amqplib/rabbitmqbundle/blob/master/DependencyInjection/OldSoundRabbitMqExtension.php"
    click ConfigDef "https://github.com/php-amqplib/rabbitmqbundle/blob/master/DependencyInjection/Configuration.php"
    click RegisterPartsPass "https://github.com/php-amqplib/rabbitmqbundle/blob/master/DependencyInjection/Compiler/RegisterPartsPass.php"
    click InjectEventDispatcherPass "https://github.com/php-amqplib/rabbitmqbundle/blob/master/DependencyInjection/Compiler/InjectEventDispatcherPass.php"
    click ServiceContainerPass "https://github.com/php-amqplib/rabbitmqbundle/blob/master/DependencyInjection/Compiler/ServiceContainerPass.php"
    click ConsumerCmd "https://github.com/php-amqplib/rabbitmqbundle/blob/master/Command/ConsumerCommand.php"
    click StdInProducerCmd "https://github.com/php-amqplib/rabbitmqbundle/blob/master/Command/StdInProducerCommand.php"
    click PurgeConsumerCmd "https://github.com/php-amqplib/rabbitmqbundle/blob/master/Command/PurgeConsumerCommand.php"
    click DeleteCmd "https://github.com/php-amqplib/rabbitmqbundle/blob/master/Command/DeleteCommand.php"
    click RpcServerCmd "https://github.com/php-amqplib/rabbitmqbundle/blob/master/Command/RpcServerCommand.php"
    click SetupFabricCmd "https://github.com/php-amqplib/rabbitmqbundle/blob/master/Command/SetupFabricCommand.php"
    click AnonConsumerCmd "https://github.com/php-amqplib/rabbitmqbundle/blob/master/Command/AnonConsumerCommand.php"
    click BatchConsumerCmd "https://github.com/php-amqplib/rabbitmqbundle/blob/master/Command/BatchConsumerCommand.php"
    click DynamicConsumerCmd "https://github.com/php-amqplib/rabbitmqbundle/blob/master/Command/DynamicConsumerCommand.php"
    click MultipleConsumerCmd "https://github.com/php-amqplib/rabbitmqbundle/blob/master/Command/MultipleConsumerCommand.php"
    click AMQPConnectionFactory "https://github.com/php-amqplib/rabbitmqbundle/blob/master/RabbitMq/AMQPConnectionFactory.php"
    click AMQPLoggedChannel "https://github.com/php-amqplib/rabbitmqbundle/blob/master/RabbitMq/AMQPLoggedChannel.php"
    click BaseAmqp "https://github.com/php-amqplib/rabbitmqbundle/blob/master/RabbitMq/BaseAmqp.php"
    click Producer "https://github.com/php-amqplib/rabbitmqbundle/blob/master/RabbitMq/Producer.php"
    click Consumer "https://github.com/php-amqplib/rabbitmqbundle/blob/master/RabbitMq/Consumer.php"
    click RpcClient "https://github.com/php-amqplib/rabbitmqbundle/blob/master/RabbitMq/RpcClient.php"
    click RpcServer "https://github.com/php-amqplib/rabbitmqbundle/blob/master/RabbitMq/RpcServer.php"
    click BatchConsumer "https://github.com/php-amqplib/rabbitmqbundle/blob/master/RabbitMq/BatchConsumer.php"
    click AnonConsumer "https://github.com/php-amqplib/rabbitmqbundle/blob/master/RabbitMq/AnonConsumer.php"
    click DynamicConsumer "https://github.com/php-amqplib/rabbitmqbundle/blob/master/RabbitMq/DynamicConsumer.php"
    click MultipleConsumer "https://github.com/php-amqplib/rabbitmqbundle/blob/master/RabbitMq/MultipleConsumer.php"
    click Binding "https://github.com/php-amqplib/rabbitmqbundle/blob/master/RabbitMq/Binding.php"
    click Fallback "https://github.com/php-amqplib/rabbitmqbundle/blob/master/RabbitMq/Fallback.php"
    click MessageDataCollector "https://github.com/php-amqplib/rabbitmqbundle/blob/master/DataCollector/MessageDataCollector.php"
    click MemoryChecker "https://github.com/php-amqplib/rabbitmqbundle/blob/master/MemoryChecker/MemoryConsumptionChecker.php"
    click rabbitmqXML "https://github.com/php-amqplib/rabbitmqbundle/blob/master/Resources/config/rabbitmq.xml"

    %% Styles
    classDef symfony fill:#D0E6FF,stroke:#004085,color:#004085
    classDef bundle fill:#D4EDDA,stroke:#155724,color:#155724
    classDef command fill:#CCE5FF,stroke:#004085,color:#004085
    classDef driver fill:#FFF3CD,stroke:#856404,color:#856404
    classDef external fill:#F8D7DA,stroke:#721C24,color:#721C24
    classDef profiler fill:#E2E3E5,stroke:#383D41,color:#383D41
```
