本文详细介绍了在 symfony 5 应用程序中如何灵活地实现同步和异步邮件发送。通过创建自定义消息类和消息处理器，并结合 symfony messenger 组件的路由配置，开发者可以精确控制哪些邮件通过消息队列异步发送，而哪些邮件则立即同步发送，从而优化应用性能和用户体验。
在现代 Web 应用中，邮件发送是常见的需求，但有时我们需要根据业务场景选择不同的发送模式：对于非关键或耗时较长的邮件（如通知、批量邮件），异步发送可以避免阻塞主线程，提升用户体验；而对于关键或需要即时反馈的邮件（如密码重置），同步发送则更为合适。Symfony 5 结合其 Mailer 和 Messenger 组件，提供了一套强大的机制来实现这种灵活的邮件发送策略。
1. 理解 Symfony Mailer 与 Messenger
- Symfony Mailer: 这是 Symfony 官方推荐的邮件发送组件，它提供了一个统一的接口 MailerInterface 来发送邮件，支持多种传输方式（SMTP, Sendgrid, Mailgun 等）。
- Symfony Messenger: 这是一个消息队列组件，允许应用将耗时任务（如发送邮件、处理图片）异步化。它通过消息总线（Message Bus）、消息（Message）和消息处理器（Message Handler）来工作。
当我们将 Symfony\Component\Mailer\Messenger\SendEmailMessage 路由到异步传输时，所有通过 MailerInterface::send() 方法发送的邮件都会被 Messenger 捕获并推送到队列中。为了实现同步和异步邮件的共存，我们需要更精细的控制。
2. 定义异步邮件消息类
为了让 Messenger 能够处理我们的异步邮件，我们首先需要创建一个自定义的消息类。这个类将封装所有发送邮件所需的数据，如收件人、主题、邮件模板路径和上下文变量等。
<?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;
}
}注意：消息类应只包含数据，不应包含业务逻辑。所有属性都应是私有的，并通过 getter 方法暴露。
3. 实现异步邮件消息处理器
消息处理器负责接收并处理特定类型的消息。在这里，EmailAsyncHandler 将接收 EmailAsync 消息，并使用 MailerInterface 实际发送邮件。
<?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);
}
}注意：
- __invoke() 方法是 Messenger 约定俗成的处理消息的方法。
- 处理器通过构造函数注入 MailerInterface，以便发送邮件。
- 处理器从 EmailAsync 消息中提取所有必要的数据来构建 TemplatedEmail。
4. 配置 Symfony Messenger 路由
现在我们需要告诉 Symfony Messenger，当 EmailAsync 类型的消息被分发时，应该将其路由到异步传输。
# 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 # 显式同步，或不配置注意：
- MESSENGER_TRANSPORT_DSN 环境变量定义了异步消息队列的连接方式（例如 RabbitMQ, Redis, Doctrine 等）。
- 通过将 App\Message\EmailAsync 路由到 async，只有我们明确创建并分发的 EmailAsync 消息才会进入队列。
5. 分发异步邮件
在你的服务中，当你需要发送异步邮件时，不再直接使用 MailerInterface，而是注入 MessageBusInterface，并分发 EmailAsync 消息。
<?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);
}
// 其他与异步邮件相关的业务逻辑
}注意：
- MessageBusInterface 用于将消息推送到总线。
- sendAsyncEmail 方法创建 EmailAsync 实例并将其分发。
6. 发送同步邮件
对于需要同步发送的邮件，你仍然可以直接注入 MailerInterface 并使用它，而无需经过 Messenger。
<?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);
}
// 其他与同步邮件相关的业务逻辑
}注意：
- MailManagerSync 服务直接使用 MailerInterface，不涉及 MessageBusInterface。
- 由于我们在 Messenger 配置中没有将 Symfony\Component\Mailer\Messenger\SendEmailMessage 路由到异步传输，所以这里的 mailer-youjiankuohaophpcnsend() 调用将是同步的。
总结与注意事项
通过上述步骤，我们成功地在 Symfony 5 应用中实现了同步和异步邮件发送的灵活控制：
- 异步邮件：通过创建自定义 EmailAsync 消息和 EmailAsyncHandler，并配置 Messenger 路由，实现邮件的队列化发送。
- 同步邮件：直接使用 MailerInterface 发送邮件，不经过 Messenger，保持同步行为。
重要注意事项：
- Messenger Worker 运行：为了处理异步邮件，你必须在生产环境中运行 Messenger worker 进程。例如：php bin/console messenger:consume async。建议使用 Supervisor 或 Systemd 等工具来管理 worker 进程，确保其持续运行和自动重启。
- 错误处理：Messenger 提供了强大的错误处理机制，包括重试策略和失败消息存储。请根据你的需求配置这些选项。
- 发件人配置：在实际应用中，发件人邮箱通常会从配置文件（如 services.yaml 或 parameters.yaml）中获取，而不是硬编码在服务中。
- 模板路径：邮件模板路径应确保正确，并可被 Twig 渲染器访问。
- DSN 安全：MESSENGER_TRANSPORT_DSN 包含敏感信息，应通过环境变量或 Symfony Secret 管理。
这种方法提供了一个清晰且可维护的解决方案，允许开发者根据邮件的优先级和发送需求，灵活地选择同步或异步发送模式，从而优化应用程序的整体性能和响应速度。
