Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Symfony : le composant Messenger

Messenger est le bus de messages de Symfony. La mĂȘme abstraction sert aux tĂąches de fond, comme les files de Laravel, et au dialogue entre les parties d’une application ou entre services distincts, Ă  travers une seule interface.

composer require symfony/messenger
final class SendWelcomeEmail
{
    public function __construct(public readonly int $userId) {}
}

#[AsMessageHandler]
final class SendWelcomeEmailHandler
{
    public function __invoke(SendWelcomeEmail $message): void
    {
        $user = $this->users->find($message->userId);
        $this->mailer->send(new WelcomeEmail($user));
    }
}

// dispatching it, anywhere in the app
$this->bus->dispatch(new SendWelcomeEmail($user->getId()));
# config/packages/messenger.yaml
framework:
  messenger:
    transports:
      async: '%env(MESSENGER_TRANSPORT_DSN)%'
    routing:
      App\Message\SendWelcomeEmail: async
php bin/console messenger:consume async

Les messages et leurs handlers ne se rencontrent que par le bus. Le mĂȘme message SendWelcomeEmail pourra plus tard partir vers un autre transport, disons une file partagĂ©e avec un autre service, en changeant la configuration et non le code de l’application.

Quand le choisir

Toute application Symfony qui a besoin de traitements en arriĂšre-plan, et surtout celle qui pourrait un jour avoir besoin d’échanger des messages entre services. Le mĂȘme composant fait les deux, sans second outil.

Quand ce n’est pas le bon outil

Un petit script isolĂ© qui fait une chose lente de temps en temps. Un bus de messages complet pour une tĂąche cron, c’est plus de cĂ©rĂ©monie que le problĂšme n’en mĂ©rite ; une simple commande Console lancĂ©e par le cron suffit.

Sous le capot : Messenger route les messages vers leurs handlers grĂące au systĂšme de types de PHP. L’attribut #[AsMessageHandler] et le type dĂ©clarĂ© sur __invoke() indiquent Ă  Symfony quels messages un handler accepte ; ajouter un type de message revient Ă  dĂ©finir une classe, pas Ă  l’inscrire Ă  la main dans une table de correspondance.