Symfony 5 中实现同步与异步邮件发送的灵活策略

<?php

namespace App\Message;

class EmailAsync
{
    private string $subject;
    private string $bodyHtmlTemplate;
    private ?string $bodyTextTemplate;
    private string $recipient;
    private array $context = [];
    private string $senderEmail; // 添加发件人邮箱

    public function __construct(
        string $senderEmail,
        string $recipient,
        string $subject,
        string $bodyHtmlTemplate,
        ?string $bodyTextTemplate = null,
        array $context = []
    ) {
        $this->senderEmail = $senderEmail;
        $this->recipient = $recipient;
        $this->subject = $subject;
        $this->bodyHtmlTemplate = $bodyHtmlTemplate;
        $this->bodyTextTemplate = $bodyTextTemplate;
        $this->context = $context;
    }

    // 提供所有属性的公共 getter 方法
    public function getSenderEmail(): string
    {
        return $this->senderEmail;
    }

    public function getRecipient(): string
    {
        return $this->recipient;
    }

    public function getSubject(): string
    {
        return $this->subject;
    }

    public function getBodyHtmlTemplate(): string
    {
        return $this->bodyHtmlTemplate;
    }

    public function getBodyTextTemplate(): ?string
    {
        return $this->bodyTextTemplate;
    }

    public function getContext(): array
    {
        return $this->context;
    }
}

<?php

namespace App\MessageHandler;

use App\Message\EmailAsync;
use Symfony\Component\Mime\Address;
use Symfony\Bridge\Twig\Mime\TemplatedEmail;
use Symfony\Component\Mailer\MailerInterface;
use Symfony\Component\Messenger\Handler\MessageHandlerInterface;

class EmailAsyncHandler implements MessageHandlerInterface
{
    protected MailerInterface $mailer;

    public function __construct(MailerInterface $mailer)
    {
        $this->mailer = $mailer;
    }

    public function __invoke(EmailAsync $emailAsync): void
    {
        $emailToSend = (new TemplatedEmail())
            ->from(new Address($emailAsync->getSenderEmail())) // 使用消息中的发件人
            ->to(new Address($emailAsync->getRecipient()))
            ->subject($emailAsync->getSubject())
            ->htmlTemplate($emailAsync->getBodyHtmlTemplate())
            ->context($emailAsync->getContext());

        if ($emailAsync->getBodyTextTemplate()) {
            $emailToSend->textTemplate($emailAsync->getBodyTextTemplate());
        }

        $this->mailer->send($emailToSend);
    }
}

# config/packages/messenger.yaml 或 config/packages/dev/messenger.yaml
framework:
    messenger:
        # 配置异步传输 DSN
        transports:
            async: '%env(MESSENGER_TRANSPORT_DSN)%' # 例如：MESSENGER_TRANSPORT_DSN=amqp://guest:guest@localhost:5672/%2f/messages

        routing:
            # 将 App\Message\EmailAsync 消息路由到 'async' 传输
            'App\Message\EmailAsync': async
            # 如果不希望 Symfony\Component\Mailer\Messenger\SendEmailMessage 被默认异步处理，
            # 确保这里没有为其配置异步路由，或者明确路由到 'sync' (默认行为)
            # 'Symfony\Component\Mailer\Messenger\SendEmailMessage': sync # 显式同步，或不配置

<?php

namespace App\Service;

use App\Message\EmailAsync;
use Symfony\Component\Messenger\MessageBusInterface;

class MailManagerAsync
{
    protected MessageBusInterface $bus;
    private string $defaultSenderEmail; // 假设有一个默认发件人

    public function __construct(MessageBusInterface $bus, string $defaultSenderEmail = 'no-reply@example.com')
    {
        $this->bus = $bus;
        $this->defaultSenderEmail = $defaultSenderEmail;
    }

    /**
     * 发送异步邮件
     */
    public function sendAsyncEmail(
        string $recipient,
        string $subject,
        string $htmlTemplate,
        ?string $textTemplate = null,
        array $context = []
    ): void {
        $emailAsync = new EmailAsync(
            $this->defaultSenderEmail, // 可以从配置或服务中获取
            $recipient,
            $subject,
            $htmlTemplate,
            $textTemplate,
            $context
        );
        $this->bus->dispatch($emailAsync);
    }

    // 其他与异步邮件相关的业务逻辑
}

<?php

namespace App\Service;

use Symfony\Component\Mime\Address;
use Symfony\Bridge\Twig\Mime\TemplatedEmail;
use Symfony\Component\Mailer\MailerInterface;

class MailManagerSync
{
    protected MailerInterface $mailer;
    private string $defaultSenderEmail; // 假设有一个默认发件人

    public function __construct(MailerInterface $mailer, string $defaultSenderEmail = 'no-reply@example.com')
    {
        $this->mailer = $mailer;
        $this->defaultSenderEmail = $defaultSenderEmail;
    }

    /**
     * 发送同步邮件
     */
    public function sendSyncEmail(
        string $recipient,
        string $subject,
        string $htmlTemplate,
        ?string $textTemplate = null,
        array $context = []
    ): void {
        $email = (new TemplatedEmail())
            ->from(new Address($this->defaultSenderEmail))
            ->to(new Address($recipient))
            ->subject($subject)
            ->htmlTemplate($htmlTemplate)
            ->context($context);

        if ($textTemplate) {
            $email->textTemplate($textTemplate);
        }

        $this->mailer->send($email);
    }

    // 其他与同步邮件相关的业务逻辑
}