Cover of the book Symfony 5: The Fast Track

Symfony 5: The Fast Track is the best book to learn modern Symfony development, from zero to production. +300 pages showcasing Symfony with Docker, APIs, queues & async tasks, Webpack, SPAs, etc.

  1. Home
  2. Documentation
  3. Messenger
  4. Multiple Buses
WARNING: You are browsing the documentation for Symfony 4.2 which is not maintained anymore. Consider upgrading your projects to Symfony 5.2.

Multiple Buses

4.2 version
Maintained
4.4 5.1 5.2 current 5.3 dev
Unmaintained
4.1 4.2 4.3 5.0

Multiple Buses

A common architecture when building applications is to separate commands from queries. Commands are actions that do something and queries fetch data. This is called CQRS (Command Query Responsibility Segregation). See Martin Fowler’s article about CQRS to learn more. This architecture could be used together with the Messenger component by defining multiple buses.

A command bus is a little different from a query bus. For example, command buses usually don’t provide any results and query buses are rarely asynchronous. You can configure these buses and their rules by using middleware.

It might also be a good idea to separate actions from reactions by introducing an event bus. The event bus could have zero or more subscribers.

  • YAML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
    framework:
    messenger:
        # The bus that is going to be injected when injecting MessageBusInterface
        default_bus: messenger.bus.commands
        buses:
            messenger.bus.commands:
                middleware:
                    - validation
                    - doctrine_transaction
            messenger.bus.queries:
                middleware:
                    - validation
            messenger.bus.events:
                default_middleware: allow_no_handlers
                middleware:
                    - validation
  • XML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
    <!-- config/packages/messenger.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:framework="http://symfony.com/schema/dic/symfony"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/symfony
        https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

    <framework:config>
        <!-- The bus that is going to be injected when injecting MessageBusInterface -->
        <framework:messenger default-bus="messenger.bus.commands">
            <framework:bus name="messenger.bus.commands">
                <framework:middleware id="validation"/>
                <framework:middleware id="doctrine_transaction"/>
            <framework:bus>
            <framework:bus name="messenger.bus.queries">
                <framework:middleware id="validation"/>
            <framework:bus>
            <framework:bus name="messenger.bus.events" default-middleware="allow_no_handlers">
                <framework:middleware id="validation"/>
            <framework:bus>
        </framework:messenger>
    </framework:config>
</container>
  • PHP
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
    // config/packages/messenger.php
$container->loadFromExtension('framework', [
    'messenger' => [
        // The bus that is going to be injected when injecting MessageBusInterface
        'default_bus' => 'messenger.bus.commands',
        'buses' => [
            'messenger.bus.commands' => [
                'middleware' => [
                    'validation',
                    'doctrine_transaction',
                ],
            ],
            'messenger.bus.queries' => [
                'middleware' => [
                    'validation',
                ],
            ],
            'messenger.bus.events' => [
                'default_middleware' => 'allow_no_handlers',
                'middleware' => [
                    'validation',
                ],
            ],
        ],
    ],
]);

This will generate the messenger.bus.commands, messenger.bus.queries and messenger.bus.events services that you can inject in your services.

Type-hints and Auto-wiring

Auto-wiring is a great feature that allows you to reduce the amount of configuration required for your service container to be created. By using MessageBusInterface as argument type-hint in your services, the default configured bus will be injected (i.e messenger.bus.commands in above examples).

When working with multiple buses, you can use the DependencyInjection component’s binding capabilities to clarify which bus will be injected based on the argument’s name:

  • YAML
    1
2
3
4
5
6
7
8
9
    # config/services.yaml
services:
    _defaults:
        # ...

        bind:
            $commandBus: '@messenger.bus.commands'
            $queryBus: '@messenger.bus.queries'
            $eventBus: '@messenger.bus.events'
  • XML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
    <!-- config/services.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd">

    <services>
        <defaults>
           <bind key="$commandBus" type="service" id="messenger.bus.commands"/>
           <bind key="$queryBus" type="service" id="messenger.bus.queries"/>
           <bind key="$eventBus" type="service" id="messenger.bus.events"/>
        </defaults>
    </services>
</container>
  • PHP
    1
2
3
4
    // config/services.php
$container->bind('$commandBus', 'messenger.bus.commands');
$container->bind('$queryBus', 'messenger.bus.queries');
$container->bind('$eventBus', 'messenger.bus.events');

Restrict Handlers per Bus

By default, each handler will be available to handle messages on all of your buses. To prevent dispatching a message to the wrong bus without an error, you can restrict each handler to a specific bus using the messenger.message_handler tag:

  • YAML
    1
2
3
4
    # config/services.yaml
services:
    App\MessageHandler\SomeCommandHandler:
        tags: [{ name: messenger.message_handler, bus: messenger.bus.commands }]
  • XML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
    <!-- config/services.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd">

    <services>
        <service id="App\MessageHandler\SomeCommandHandler">
            <tag name="messenger.message_handler" bus="messenger.bus.commands"/>
        </service>
    </services>
</container>
  • PHP
    1
2
3
4
    // config/services.php
$container->services()
    ->set(App\MessageHandler\SomeCommandHandler::class)
    ->tag('messenger.message_handler', ['bus' => 'messenger.bus.commands']);

This way, the App\MessageHandler\SomeCommandHandler handler will only be known by the messenger.bus.commands bus.

Tip

If you manually restrict handlers be sure to have autoconfigure disabled, or not implement the Symfony\Component\Messenger\Handler\MessageHandlerInterface as this might cause your handler to be registered twice.

See service autoconfiguration for more information.

You can also automatically add this tag to a number of classes by following a naming convention and registering all of the handler services by name with the correct tag:

  • YAML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
    # config/services.yaml

# put this after the "App\" line that registers all your services
command_handlers:
    namespace: App\MessageHandler\
    resource: '%kernel.project_dir%/src/MessageHandler/*CommandHandler.php'
    autoconfigure: false
    tags:
        - { name: messenger.message_handler, bus: messenger.bus.commands }

query_handlers:
    namespace: App\MessageHandler\
    resource: '%kernel.project_dir%/src/MessageHandler/*QueryHandler.php'
    autoconfigure: false
    tags:
        - { name: messenger.message_handler, bus: messenger.bus.queries }
  • XML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
    <!-- config/services.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd">

    <services>
        <!-- command handlers -->
        <prototype namespace="App\MessageHandler\" resource="%kernel.project_dir%/src/MessageHandler/*CommandHandler.php" autoconfigure="false">
            <tag name="messenger.message_handler" bus="messenger.bus.commands"/>
        </service>
        <!-- query handlers -->
        <prototype namespace="App\MessageHandler\" resource="%kernel.project_dir%/src/MessageHandler/*QueryHandler.php" autoconfigure="false">
            <tag name="messenger.message_handler" bus="messenger.bus.queries"/>
        </service>
    </services>
</container>
  • PHP
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
    // config/services.php

// Command handlers
$container->services()
    ->load('App\MessageHandler\\', '%kernel.project_dir%/src/MessageHandler/*CommandHandler.php')
    ->autoconfigure(false)
    ->tag('messenger.message_handler', ['bus' => 'messenger.bus.commands']);

// Query handlers
$container->services()
    ->load('App\MessageHandler\\', '%kernel.project_dir%/src/MessageHandler/*QueryHandler.php')
    ->autoconfigure(false)
    ->tag('messenger.message_handler', ['bus' => 'messenger.bus.queries']);

Debugging the Buses

The debug:messenger command lists available messages & handlers per bus. You can also restrict the list to a specific bus by providing its name as argument.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
$ php bin/console debug:messenger

  Messenger
  =========

  messenger.bus.commands
  ----------------------

   The following messages can be dispatched:

   ---------------------------------------------------------------------------------------
    App\Message\DummyCommand
        handled by App\MessageHandler\DummyCommandHandler
    App\Message\MultipleBusesMessage
        handled by App\MessageHandler\MultipleBusesMessageHandler
   ---------------------------------------------------------------------------------------

  messenger.bus.queries
  ---------------------

   The following messages can be dispatched:

   ---------------------------------------------------------------------------------------
    App\Message\DummyQuery
        handled by App\MessageHandler\DummyQueryHandler
    App\Message\MultipleBusesMessage
        handled by App\MessageHandler\MultipleBusesMessageHandler
   ---------------------------------------------------------------------------------------

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.