通知

介绍
生成通知
发送通知
邮件通知
Markdown 邮件通知
数据库通知
广播通知
短信通知
Slack 通知
本地化通知
测试
通知事件
自定义渠道

介绍

除了支持发送电子邮件，Laravel 还支持通过多种传递渠道发送通知，包括电子邮件、SMS（通过 Vonage，以前称为 Nexmo）和 Slack。此外，已经创建了各种社区构建的通知渠道，可以通过数十种不同的渠道发送通知！通知还可以存储在数据库中，以便在您的 Web 界面中显示。

通常，通知应该是简短的信息性消息，通知用户应用程序中发生的事情。例如，如果您正在编写一个计费应用程序，您可能会通过电子邮件和 SMS 渠道向用户发送“发票已支付”通知。

生成通知

在 Laravel 中，每个通知由一个单独的类表示，通常存储在 app/Notifications 目录中。如果您在应用程序中没有看到此目录，请不要担心 - 当您运行 make:notification Artisan 命令时，它将为您创建：

shell

php artisan make:notification InvoicePaid

此命令将在您的 app/Notifications 目录中放置一个新的通知类。每个通知类都包含一个 via 方法和可变数量的消息构建方法，例如 toMail 或 toDatabase，这些方法将通知转换为针对特定渠道定制的消息。

发送通知

使用 Notifiable Trait

通知可以通过两种方式发送：使用 Notifiable trait 的 notify 方法或使用 Notification facade。Notifiable trait 默认包含在应用程序的 App\Models\User 模型中：

php

<?php

namespace App\Models;

use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable
{
    use Notifiable;
}

此 trait 提供的 notify 方法期望接收一个通知实例：

php

use App\Notifications\InvoicePaid;

$user->notify(new InvoicePaid($invoice));

NOTE

请记住，您可以在任何模型上使用 Notifiable trait。您不必仅限于将其包含在 User 模型上。

使用 Notification Facade

或者，您可以通过 Notification facade 发送通知。当您需要向多个可通知实体（例如用户集合）发送通知时，此方法很有用。要使用 facade 发送通知，请将所有可通知实体和通知实例传递给 send 方法：

php

use Illuminate\Support\Facades\Notification;

Notification::send($users, new InvoicePaid($invoice));

您还可以使用 sendNow 方法立即发送通知。即使通知实现了 ShouldQueue 接口，此方法也会立即发送通知：

php

Notification::sendNow($developers, new DeploymentCompleted($deployment));

指定传递渠道

每个通知类都有一个 via 方法，用于确定通知将在哪些渠道上传递。通知可以通过 mail、database、broadcast、vonage 和 slack 渠道发送。

NOTE

如果您想使用其他传递渠道，例如 Telegram 或 Pusher，请查看社区驱动的 Laravel Notification Channels 网站。

via 方法接收一个 $notifiable 实例，该实例将是发送通知的类的实例。您可以使用 $notifiable 来确定通知应在哪些渠道上传递：

php

/**
 * 获取通知的传递渠道。
 *
 * @return array<int, string>
 */
public function via(object $notifiable): array
{
    return $notifiable->prefers_sms ? ['vonage'] : ['mail', 'database'];
}

队列通知

WARNING

在队列通知之前，您应该配置队列并启动工作程序。

发送通知可能需要时间，尤其是当渠道需要进行外部 API 调用以传递通知时。为了加快应用程序的响应时间，可以通过在类中添加 ShouldQueue 接口和 Queueable trait 来让通知排队。接口和 trait 已经为使用 make:notification 命令生成的所有通知导入，因此您可以立即将它们添加到通知类中：

php

<?php

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Notification;

class InvoicePaid extends Notification implements ShouldQueue
{
    use Queueable;

    // ...
}

一旦将 ShouldQueue 接口添加到通知中，您可以像往常一样发送通知。Laravel 将检测类上的 ShouldQueue 接口并自动将通知的传递排队：

php

$user->notify(new InvoicePaid($invoice));

在队列通知时，将为每个接收者和渠道组合创建一个队列作业。例如，如果您的通知有三个接收者和两个渠道，将有六个作业被派发到队列中。

延迟通知

如果您想延迟通知的传递，可以在通知实例化时链接 delay 方法：

php

$delay = now()->addMinutes(10);

$user->notify((new InvoicePaid($invoice))->delay($delay));

您可以将数组传递给 delay 方法，以为特定渠道指定延迟时间：

php

$user->notify((new InvoicePaid($invoice))->delay([
    'mail' => now()->addMinutes(5),
    'sms' => now()->addMinutes(10),
]));

或者，您可以在通知类本身上定义一个 withDelay 方法。withDelay 方法应返回一个包含渠道名称和延迟值的数组：

php

/**
 * 确定通知的传递延迟。
 *
 * @return array<string, \Illuminate\Support\Carbon>
 */
public function withDelay(object $notifiable): array
{
    return [
        'mail' => now()->addMinutes(5),
        'sms' => now()->addMinutes(10),
    ];
}

自定义通知队列连接

默认情况下，队列通知将使用应用程序的默认队列连接进行排队。如果您想为特定通知指定应使用的不同连接，可以从通知的构造函数中调用 onConnection 方法：

php

<?php

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Notification;

class InvoicePaid extends Notification implements ShouldQueue
{
    use Queueable;

    /**
     * 创建一个新的通知实例。
     */
    public function __construct()
    {
        $this->onConnection('redis');
    }
}

或者，如果您想为通知支持的每个通知渠道指定应使用的特定队列连接，可以在通知中定义一个 viaConnections 方法。此方法应返回一个包含渠道名称/队列连接名称对的数组：

php

/**
 * 确定每个通知渠道应使用的连接。
 *
 * @return array<string, string>
 */
public function viaConnections(): array
{
    return [
        'mail' => 'redis',
        'database' => 'sync',
    ];
}

自定义通知渠道队列

如果您想为通知支持的每个通知渠道指定应使用的特定队列，可以在通知中定义一个 viaQueues 方法。此方法应返回一个包含渠道名称/队列名称对的数组：

php

/**
 * 确定每个通知渠道应使用的队列。
 *
 * @return array<string, string>
 */
public function viaQueues(): array
{
    return [
        'mail' => 'mail-queue',
        'slack' => 'slack-queue',
    ];
}

自定义队列通知任务属性

您可以通过在通知类上定义属性来自定义底层队列任务的行为。这些属性将由发送通知的队列任务继承：

php

<?php

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Notification;

class InvoicePaid extends Notification implements ShouldQueue
{
    use Queueable;

    /**
     * 通知的最大尝试次数。
     *
     * @var int
     */
    public $tries = 5;

    /**
     * 通知超时前可运行的秒数。
     *
     * @var int
     */
    public $timeout = 120;

    /**
     * 失败前允许的未处理异常的最大数量。
     *
     * @var int
     */
    public $maxExceptions = 3;

    // ...
}

如果您希望通过加密确保队列通知数据的隐私性和完整性，请在您的通知类上添加 ShouldBeEncrypted 接口：

php

<?php

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldBeEncrypted;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Notification;

class InvoicePaid extends Notification implements ShouldQueue, ShouldBeEncrypted
{
    use Queueable;

    // ...
}

除了直接在通知类上定义这些属性外，您还可以定义 backoff 和 retryUntil 方法来指定队列通知任务的退避策略和重试超时时间：

php

use DateTime;

/**
 * 计算重试通知前需要等待的秒数。
 */
public function backoff(): int
{
    return 3;
}

/**
 * 确定通知应超时的时间。
 */
public function retryUntil(): DateTime
{
    return now()->addMinutes(5);
}

NOTE

有关这些任务属性和方法的更多信息，请查阅关于队列任务的文档。

队列通知中间件

队列通知可以像队列作业一样定义中间件[(/queues#job-middleware)]。要开始，请在通知类上定义一个 middleware 方法。middleware 方法将接收 $notifiable 和 $channel 变量，这允许您根据通知的目的地自定义返回的中间件：

php

use Illuminate\Queue\Middleware\RateLimited;

/**
 * 获取通知作业应通过的中间件。
 *
 * @return array<int, object>
 */
public function middleware(object $notifiable, string $channel)
{
    return match ($channel) {
        'mail' => [new RateLimited('postmark')],
        'slack' => [new RateLimited('slack')],
        default => [],
    };
}

队列通知和数据库事务

当队列通知在数据库事务中被派发时，它们可能会在数据库事务提交之前被队列处理。当这种情况发生时，您在数据库事务期间对模型或数据库记录所做的任何更新可能尚未反映在数据库中。此外，在事务中创建的任何模型或数据库记录可能不存在于数据库中。如果您的通知依赖于这些模型，当处理发送队列通知的作业时，可能会发生意外错误。

如果您的队列连接的 after_commit 配置选项设置为 false，您仍然可以通过在发送通知时调用 afterCommit 方法来指示特定的队列通知应在所有打开的数据库事务提交后派发：

php

use App\Notifications\InvoicePaid;

$user->notify((new InvoicePaid($invoice))->afterCommit());

或者，您可以从通知的构造函数中调用 afterCommit 方法：

php

<?php

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Notification;

class InvoicePaid extends Notification implements ShouldQueue
{
    use Queueable;

    /**
     * 创建一个新的通知实例。
     */
    public function __construct()
    {
        $this->afterCommit();
    }
}

NOTE

要了解更多关于解决这些问题的信息，请查看有关队列作业和数据库事务的文档。

确定是否应发送队列通知

在队列通知被派发到队列进行后台处理后，通常会被队列工作程序接受并发送给其预期的接收者。

然而，如果您希望在队列工作程序处理后最终确定是否应发送队列通知，可以在通知类上定义一个 shouldSend 方法。如果此方法返回 false，则不会发送通知：

php

/**
 * 确定是否应发送通知。
 */
public function shouldSend(object $notifiable, string $channel): bool
{
    return $this->invoice->isPaid();
}

按需通知

有时您可能需要向未存储为应用程序“用户”的人发送通知。使用 Notification facade 的 route 方法，您可以在发送通知之前指定临时通知路由信息：

php

use Illuminate\Broadcasting\Channel;
use Illuminate\Support\Facades\Notification;

Notification::route('mail', 'taylor@example.com')
    ->route('vonage', '5555555555')
    ->route('slack', '#slack-channel')
    ->route('broadcast', [new Channel('channel-name')])
    ->notify(new InvoicePaid($invoice));

如果您希望在将按需通知发送到 mail 路由时提供收件人的姓名，可以提供一个数组，其中包含电子邮件地址作为键，姓名作为数组第一个元素的值：

php

Notification::route('mail', [
    'barrett@example.com' => 'Barrett Blair',
])->notify(new InvoicePaid($invoice));

使用 routes 方法，您可以一次为多个通知渠道提供临时路由信息：

php

Notification::routes([
    'mail' => ['barrett@example.com' => 'Barrett Blair'],
    'vonage' => '5555555555',
])->notify(new InvoicePaid($invoice));

邮件通知

格式化邮件消息

如果通知支持以电子邮件形式发送，您应该在通知类上定义一个 toMail 方法。此方法将接收一个 $notifiable 实体，并应返回一个 Illuminate\Notifications\Messages\MailMessage 实例。

MailMessage 类包含一些简单的方法来帮助您构建事务性电子邮件消息。邮件消息可以包含文本行以及“行动呼吁”。让我们来看一个 toMail 方法的示例：

php

/**
 * 获取通知的邮件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    $url = url('/invoice/'.$this->invoice->id);

    return (new MailMessage)
        ->greeting('Hello!')
        ->line('One of your invoices has been paid!')
        ->lineIf($this->amount > 0, "Amount paid: {$this->amount}")
        ->action('View Invoice', $url)
        ->line('Thank you for using our application!');
}

NOTE

请注意，我们在 toMail 方法中使用 $this->invoice->id。您可以将通知生成消息所需的任何数据传递到通知的构造函数中。

在此示例中，我们注册了一个问候语、一行文本、一个行动呼吁，然后是另一行文本。MailMessage 对象提供的方法使格式化小型事务性电子邮件变得简单快捷。邮件渠道将把消息组件转换为一个美观、响应式的 HTML 电子邮件模板，并带有纯文本副本。以下是 mail 渠道生成的电子邮件示例：

NOTE

发送邮件通知时，请务必在 config/app.php 配置文件中设置 name 配置选项。此值将用于邮件通知消息的页眉和页脚。

错误消息

某些通知会通知用户错误，例如发票支付失败。您可以通过在构建消息时调用 error 方法来指示邮件消息与错误有关。在邮件消息上使用 error 方法时，行动呼吁按钮将是红色而不是黑色：

php

/**
 * 获取通知的邮件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)
        ->error()
        ->subject('Invoice Payment Failed')
        ->line('...');
}

其他邮件通知格式选项

您可以使用 view 方法指定应使用的自定义模板来渲染通知电子邮件，而不是在通知类中定义文本的“行”：

php

/**
 * 获取通知的邮件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)->view(
        'mail.invoice.paid', ['invoice' => $this->invoice]
    );
}

您可以通过将视图名称作为数组的第二个元素传递给 view 方法，为邮件消息指定纯文本视图：

php

/**
 * 获取通知的邮件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)->view(
        ['mail.invoice.paid', 'mail.invoice.paid-text'],
        ['invoice' => $this->invoice]
    );
}

或者，如果您的消息只有一个纯文本视图，您可以使用 text 方法：

php

/**
 * 获取通知的邮件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)->text(
        'mail.invoice.paid-text', ['invoice' => $this->invoice]
    );
}

自定义发件人

默认情况下，电子邮件的发件人/发件地址在 config/mail.php 配置文件中定义。但是，您可以使用 from 方法为特定通知指定发件地址：

php

/**
 * 获取通知的邮件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)
        ->from('barrett@example.com', 'Barrett Blair')
        ->line('...');
}

自定义收件人

通过 mail 渠道发送通知时，通知系统将自动查找可通知实体上的 email 属性。您可以通过在可通知实体上定义一个 routeNotificationForMail 方法来自定义用于传递通知的电子邮件地址：

php

<?php

namespace App\Models;

use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Illuminate\Notifications\Notification;

class User extends Authenticatable
{
    use Notifiable;

    /**
     * 为邮件渠道路由通知。
     *
     * @return  array<string, string>|string
     */
    public function routeNotificationForMail(Notification $notification): array|string
    {
        // 仅返回电子邮件地址...
        return $this->email_address;

        // 返回电子邮件地址和姓名...
        return [$this->email_address => $this->name];
    }
}

自定义主题

默认情况下，电子邮件的主题是通知类名格式化为“标题大小写”。因此，如果您的通知类名为 InvoicePaid，电子邮件的主题将是 Invoice Paid。如果您想为消息指定不同的主题，可以在构建消息时调用 subject 方法：

php

/**
 * 获取通知的邮件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)
        ->subject('Notification Subject')
        ->line('...');
}

自定义邮件程序

默认情况下，电子邮件通知将使用 config/mail.php 配置文件中定义的默认邮件程序发送。但是，您可以通过在构建消息时调用 mailer 方法来在运行时指定不同的邮件程序：

php

/**
 * 获取通知的邮件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)
        ->mailer('postmark')
        ->line('...');
}

自定义模板

您可以通过发布通知包的资源来修改邮件通知使用的 HTML 和纯文本模板。运行此命令后，邮件通知模板将位于 resources/views/vendor/notifications 目录中：

shell

php artisan vendor:publish --tag=laravel-notifications

附件

要向电子邮件通知添加附件，请在构建消息时使用 attach 方法。attach 方法接受文件的绝对路径作为其第一个参数：

php

/**
 * 获取通知的邮件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)
        ->greeting('Hello!')
        ->attach('/path/to/file');
}

NOTE

通知邮件消息提供的 attach 方法还接受可附加对象。请查阅全面的可附加对象文档以了解更多信息。

在将文件附加到消息时，您还可以通过将 array 作为第二个参数传递给 attach 方法来指定显示名称和/或 MIME 类型：

php

/**
 * 获取通知的邮件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)
        ->greeting('Hello!')
        ->attach('/path/to/file', [
            'as' => 'name.pdf',
            'mime' => 'application/pdf',
        ]);
}

与在可邮寄对象中附加文件不同，您不能使用 attachFromStorage 直接从存储磁盘附加文件。您应该使用 attach 方法，并提供文件在存储磁盘上的绝对路径。或者，您可以从 toMail 方法返回一个可邮寄对象：

php

use App\Mail\InvoicePaid as InvoicePaidMailable;

/**
 * 获取通知的邮件表示。
 */
public function toMail(object $notifiable): Mailable
{
    return (new InvoicePaidMailable($this->invoice))
        ->to($notifiable->email)
        ->attachFromStorage('/path/to/file');
}

在必要时，可以使用 attachMany 方法将多个文件附加到消息中：

php

/**
 * 获取通知的邮件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)
        ->greeting('Hello!')
        ->attachMany([
            '/path/to/forge.svg',
            '/path/to/vapor.svg' => [
                'as' => 'Logo.svg',
                'mime' => 'image/svg+xml',
            ],
        ]);
}

原始数据附件

attachData 方法可用于将原始字节字符串作为附件附加。在调用 attachData 方法时，您应提供应分配给附件的文件名：

php

/**
 * 获取通知的邮件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)
        ->greeting('Hello!')
        ->attachData($this->pdf, 'name.pdf', [
            'mime' => 'application/pdf',
        ]);
}

添加标签和元数据

某些第三方电子邮件提供商（如 Mailgun 和 Postmark）支持消息“标签”和“元数据”，可用于分组和跟踪应用程序发送的电子邮件。您可以通过 tag 和 metadata 方法向电子邮件消息添加标签和元数据：

php

/**
 * 获取通知的邮件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)
        ->greeting('Comment Upvoted!')
        ->tag('upvote')
        ->metadata('comment_id', $this->comment->id);
}

如果您的应用程序正在使用 Mailgun 驱动程序，您可以查阅 Mailgun 的文档以获取有关标签和元数据的更多信息。同样，您也可以查阅 Postmark 的文档，了解其对标签和元数据的支持。

如果您的应用程序使用 Amazon SES 发送电子邮件，您应该使用 metadata 方法将 SES “标签”附加到消息中。

自定义 Symfony 消息

MailMessage 类的 withSymfonyMessage 方法允许您注册一个闭包，该闭包将在发送消息之前使用 Symfony Message 实例调用。这使您有机会在消息发送之前对其进行深度自定义：

php

use Symfony\Component\Mime\Email;

/**
 * 获取通知的邮件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)
        ->withSymfonyMessage(function (Email $message) {
            $message->getHeaders()->addTextHeader(
                'Custom-Header', 'Header Value'
            );
        });
}

使用 Mailables

如果需要，您可以从通知的 toMail 方法返回一个完整的可邮寄对象。当返回 Mailable 而不是 MailMessage 时，您需要使用可邮寄对象的 to 方法指定消息接收者：

php

use App\Mail\InvoicePaid as InvoicePaidMailable;
use Illuminate\Mail\Mailable;

/**
 * 获取通知的邮件表示。
 */
public function toMail(object $notifiable): Mailable
{
    return (new InvoicePaidMailable($this->invoice))
        ->to($notifiable->email);
}

Mailables 和按需通知

如果您正在发送按需通知，传递给 toMail 方法的 $notifiable 实例将是 Illuminate\Notifications\AnonymousNotifiable 的实例，该实例提供了一个 routeNotificationFor 方法，可用于检索按需通知应发送到的电子邮件地址：

php

use App\Mail\InvoicePaid as InvoicePaidMailable;
use Illuminate\Notifications\AnonymousNotifiable;
use Illuminate\Mail\Mailable;

/**
 * 获取通知的邮件表示。
 */
public function toMail(object $notifiable): Mailable
{
    $address = $notifiable instanceof AnonymousNotifiable
        ? $notifiable->routeNotificationFor('mail')
        : $notifiable->email;

    return (new InvoicePaidMailable($this->invoice))
        ->to($address);
}

预览邮件通知

在设计邮件通知模板时，可以方便地在浏览器中快速预览渲染的邮件消息，就像典型的 Blade 模板一样。为此，Laravel 允许您直接从路由闭包或控制器返回邮件通知生成的任何邮件消息。当返回 MailMessage 时，它将被渲染并显示在浏览器中，允许您快速预览其设计，而无需将其发送到实际的电子邮件地址：

php

use App\Models\Invoice;
use App\Notifications\InvoicePaid;

Route::get('/notification', function () {
    $invoice = Invoice::find(1);

    return (new InvoicePaid($invoice))
        ->toMail($invoice->user);
});

Markdown 邮件通知

Markdown 邮件通知允许您利用邮件通知的预构建模板，同时为您提供更多自由来撰写更长的自定义消息。由于消息是用 Markdown 编写的，Laravel 能够为消息渲染美观、响应式的 HTML 模板，同时自动生成纯文本副本。

生成消息

要生成带有相应 Markdown 模板的通知，您可以使用 make:notification Artisan 命令的 --markdown 选项：

shell

php artisan make:notification InvoicePaid --markdown=mail.invoice.paid

与所有其他邮件通知一样，使用 Markdown 模板的通知应在其通知类上定义一个 toMail 方法。然而，您应该使用 markdown 方法来指定应使用的 Markdown 模板的名称，而不是使用 line 和 action 方法来构建通知。您希望提供给模板的数据数组可以作为方法的第二个参数传递：

php

/**
 * 获取通知的邮件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    $url = url('/invoice/'.$this->invoice->id);

    return (new MailMessage)
        ->subject('Invoice Paid')
        ->markdown('mail.invoice.paid', ['url' => $url]);
}

撰写消息

Markdown 邮件通知使用 Blade 组件和 Markdown 语法的组合，允许您在利用 Laravel 的预制通知组件的同时轻松构建通知：

blade

<x-mail::message>
# Invoice Paid

Your invoice has been paid!

<x-mail::button :url="$url">
View Invoice
</x-mail::button>

Thanks,<br>
{{ config('app.name') }}
</x-mail::message>

NOTE

撰写 Markdown 电子邮件时，请勿使用过多缩进。根据 Markdown 标准，Markdown 解析器会将缩进内容渲染为代码块。

按钮组件

按钮组件渲染一个居中的按钮链接。该组件接受两个参数，一个 url 和一个可选的 color。支持的颜色有 primary、green 和 red。您可以根据需要向通知中添加任意数量的按钮组件：

blade

<x-mail::button :url="$url" color="green">
View Invoice
</x-mail::button>

面板组件

面板组件将给定的文本块渲染在一个面板中，该面板的背景颜色与通知的其余部分略有不同。这使您可以将注意力集中在给定的文本块上：

blade

<x-mail::panel>
This is the panel content.
</x-mail::panel>

表格组件

表格组件允许您将 Markdown 表格转换为 HTML 表格。该组件接受 Markdown 表格作为其内容。表格列对齐支持使用默认的 Markdown 表格对齐语法：

blade

<x-mail::table>
| Laravel       | Table         | Example       |
| ------------- | :-----------: | ------------: |
| Col 2 is      | Centered      | $10           |
| Col 3 is      | Right-Aligned | $20           |
</x-mail::table>

自定义组件

您可以将所有 Markdown 通知组件导出到您自己的应用程序中进行自定义。要导出组件，请使用 vendor:publish Artisan 命令发布 laravel-mail 资产标签：

shell

php artisan vendor:publish --tag=laravel-mail

此命令会将 Markdown 邮件组件发布到 resources/views/vendor/mail 目录中。mail 目录将包含一个 html 和一个 text 目录，每个目录都包含其各自的可用组件表示。您可以根据需要自由自定义这些组件。

自定义 CSS

导出组件后，resources/views/vendor/mail/html/themes 目录将包含一个 default.css 文件。您可以自定义此文件中的 CSS，您的样式将自动内联到 Markdown 通知的 HTML 表示中。

如果您想为 Laravel 的 Markdown 组件构建一个全新的主题，可以在 html/themes 目录中放置一个 CSS 文件。命名并保存您的 CSS 文件后，更新 mail 配置文件的 theme 选项以匹配新主题的名称。

要为单个通知自定义主题，您可以在构建通知的邮件消息时调用 theme 方法。theme 方法接受发送通知时应使用的主题名称：

php

/**
 * 获取通知的邮件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)
        ->theme('invoice')
        ->subject('Invoice Paid')
        ->markdown('mail.invoice.paid', ['url' => $url]);
}

数据库通知

先决条件

database 通知渠道将通知信息存储在数据库表中。此表将包含通知类型以及描述通知的 JSON 数据结构。

您可以查询该表以在应用程序的用户界面中显示通知。但是，在此之前，您需要创建一个数据库表来保存通知。您可以使用 make:notifications-table 命令生成一个具有正确表模式的迁移：

shell

php artisan make:notifications-table

php artisan migrate

NOTE

如果您的可通知模型使用 UUID 或 ULID 主键，您应该在通知表迁移中将 morphs 方法替换为 uuidMorphs 或 ulidMorphs。

格式化数据库通知

如果通知支持存储在数据库表中，您应该在通知类上定义一个 toDatabase 或 toArray 方法。此方法将接收一个 $notifiable 实体，并应返回一个简单的 PHP 数组。返回的数组将被编码为 JSON 并存储在 notifications 表的 data 列中。让我们来看一个 toArray 方法的示例：

php

/**
 * 获取通知的数组表示。
 *
 * @return array<string, mixed>
 */
public function toArray(object $notifiable): array
{
    return [
        'invoice_id' => $this->invoice->id,
        'amount' => $this->invoice->amount,
    ];
}

当通知存储在应用程序的数据库中时，type 列将默认设置为通知的类名，而 read_at 列将为 null。但是，您可以通过在通知类中定义 databaseType 和 initialDatabaseReadAtValue 方法来自定义此行为：

php

use Illuminate\Support\Carbon;

/**
 * 获取通知的数据库类型。
 */
public function databaseType(object $notifiable): string
{
    return 'invoice-paid';
}

/**
 * 获取“read_at”列的初始值。
 */
public function initialDatabaseReadAtValue(): ?Carbon
{
    return null;
}

`toDatabase` vs. `toArray`

toArray 方法也被 broadcast 渠道用来确定要广播到 JavaScript 前端的数据。如果您希望为 database 和 broadcast 渠道提供两个不同的数组表示，您应该定义一个 toDatabase 方法而不是 toArray 方法。

访问通知

一旦通知存储在数据库中，您需要一种方便的方法从可通知实体中访问它们。Illuminate\Notifications\Notifiable trait 包含在 Laravel 的默认 App\Models\User 模型中，包含一个 notifications Eloquent 关系，返回实体的通知。要获取通知，您可以像访问其他 Eloquent 关系一样访问此方法。默认情况下，通知将按 created_at 时间戳排序，最新的通知位于集合的开头：

php

$user = App\Models\User::find(1);

foreach ($user->notifications as $notification) {
    echo $notification->type;
}

如果您只想检索“未读”通知，可以使用 unreadNotifications 关系。同样，这些通知将按 created_at 时间戳排序，最新的通知位于集合的开头：

php

$user = App\Models\User::find(1);

foreach ($user->unreadNotifications as $notification) {
    echo $notification->type;
}

如果您只想获取“已读”通知，可以使用 readNotifications 关系：

php

$user = App\Models\User::find(1);

foreach ($user->readNotifications as $notification) {
    echo $notification->type;
}

NOTE

要从 JavaScript 客户端访问通知，您应该为应用程序定义一个通知控制器，该控制器返回可通知实体（例如当前用户）的通知。然后，您可以从 JavaScript 客户端向该控制器的 URL 发出 HTTP 请求。

标记通知为已读

通常，您会希望在用户查看通知时将其标记为“已读”。Illuminate\Notifications\Notifiable trait 提供了一个 markAsRead 方法，该方法会更新通知数据库记录的 read_at 列：

php

$user = App\Models\User::find(1);

foreach ($user->unreadNotifications as $notification) {
    $notification->markAsRead();
}

但是，您可以直接在通知集合上使用 markAsRead 方法，而不是遍历每个通知：

php

$user->unreadNotifications->markAsRead();

您还可以使用批量更新查询将所有通知标记为已读，而无需从数据库中检索它们：

php

$user = App\Models\User::find(1);

$user->unreadNotifications()->update(['read_at' => now()]);

您可以 delete 通知以将其从表中完全删除：

php

$user->notifications()->delete();

广播通知

先决条件

在广播通知之前，您应该配置并熟悉 Laravel 的事件广播服务。事件广播提供了一种从 JavaScript 前端响应服务器端 Laravel 事件的方法。

格式化广播通知

broadcast 渠道使用 Laravel 的事件广播服务广播通知，允许您的 JavaScript 前端实时捕获通知。如果通知支持广播，您可以在通知类上定义一个 toBroadcast 方法。此方法将接收一个 $notifiable 实体，并应返回一个 BroadcastMessage 实例。如果不存在 toBroadcast 方法，将使用 toArray 方法来收集应广播的数据。返回的数据将被编码为 JSON 并广播到您的 JavaScript 前端。让我们来看一个 toBroadcast 方法的示例：

php

use Illuminate\Notifications\Messages\BroadcastMessage;

/**
 * 获取通知的广播表示。
 */
public function toBroadcast(object $notifiable): BroadcastMessage
{
    return new BroadcastMessage([
        'invoice_id' => $this->invoice->id,
        'amount' => $this->invoice->amount,
    ]);
}

广播队列配置

所有广播通知都被排队进行广播。如果您想配置用于排队广播操作的队列连接或队列名称，可以使用 BroadcastMessage 的 onConnection 和 onQueue 方法：

php

return (new BroadcastMessage($data))
    ->onConnection('sqs')
    ->onQueue('broadcasts');

自定义通知类型

除了您指定的数据，所有广播通知还具有一个 type 字段，包含通知的完整类名。如果您想自定义通知 type，可以在通知类上定义一个 broadcastType 方法：

php

/**
 * 获取广播的通知类型。
 */
public function broadcastType(): string
{
    return 'broadcast.message';
}

监听通知

通知将在格式为 {notifiable}.{id} 的私有频道上广播。因此，如果您向 ID 为 1 的 App\Models\User 实例发送通知，通知将广播到 App.Models.User.1 私有频道。使用 Laravel Echo 时，您可以使用 notification 方法轻松监听频道上的通知：

Echo.private('App.Models.User.' + userId)
    .notification((notification) => {
        console.log(notification.type);
    });

使用 React 或 Vue

Laravel Echo 提供了 React 和 Vue 的 hooks，让你可以轻松监听通知。要开始使用，只需调用 useEchoNotification hook，它用于监听通知。useEchoNotification hook 会在组件卸载时自动离开频道：

ReactVue

import { useEchoNotification } from "@laravel/echo-react";

useEchoNotification(
    `App.Models.User.${userId}`,
    (notification) => {
        console.log(notification.type);
    },
);

vue

<script setup lang="ts">
import { useEchoNotification } from "@laravel/echo-vue";

useEchoNotification(
    `App.Models.User.${userId}`,
    (notification) => {
        console.log(notification.type);
    },
);
</script>

默认情况下，该 hook 会监听所有通知。要指定你想要监听的通知类型，可以向 useEchoNotification 提供一个字符串或类型数组：

ReactVue

import { useEchoNotification } from "@laravel/echo-react";

useEchoNotification(
    `App.Models.User.${userId}`,
    (notification) => {
        console.log(notification.type);
    },
    'App.Notifications.InvoicePaid',
);

vue

<script setup lang="ts">
import { useEchoNotification } from "@laravel/echo-vue";

useEchoNotification(
    `App.Models.User.${userId}`,
    (notification) => {
        console.log(notification.type);
    },
    'App.Notifications.InvoicePaid',
);
</script>

你还可以指定通知负载数据的类型，以获得更好的类型安全和编辑便利性：

type InvoicePaidNotification = {
    invoice_id: number;
    created_at: string;
};

useEchoNotification<InvoicePaidNotification>(
    `App.Models.User.${userId}`,
    (notification) => {
        console.log(notification.invoice_id);
        console.log(notification.created_at);
        console.log(notification.type);
    },
    'App.Notifications.InvoicePaid',
);

自定义通知频道

如果您想自定义实体的广播通知广播的频道，可以在可通知实体上定义一个 receivesBroadcastNotificationsOn 方法：

php

<?php

namespace App\Models;

use Illuminate\Broadcasting\PrivateChannel;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable
{
    use Notifiable;

    /**
     * 用户接收通知广播的频道。
     */
    public function receivesBroadcastNotificationsOn(): string
    {
        return 'users.'.$this->id;
    }
}

短信通知

先决条件

在 Laravel 中发送短信通知由 Vonage（以前称为 Nexmo）提供支持。在通过 Vonage 发送通知之前，您需要安装 laravel/vonage-notification-channel 和 guzzlehttp/guzzle 包：

shell

composer require laravel/vonage-notification-channel guzzlehttp/guzzle

该包包含一个配置文件。但是，您不需要将此配置文件导出到您自己的应用程序。您可以简单地使用 VONAGE_KEY 和 VONAGE_SECRET 环境变量来定义您的 Vonage 公钥和密钥。

定义密钥后，您应该设置一个 VONAGE_SMS_FROM 环境变量，该变量定义默认情况下应从哪个电话号码发送您的短信。您可以在 Vonage 控制面板中生成此电话号码：

ini

VONAGE_SMS_FROM=15556666666

格式化短信通知

如果通知支持以短信形式发送，您应该在通知类上定义一个 toVonage 方法。此方法将接收一个 $notifiable 实体，并应返回一个 Illuminate\Notifications\Messages\VonageMessage 实例：

php

use Illuminate\Notifications\Messages\VonageMessage;

/**
 * 获取 Vonage / SMS 表示的通知。
 */
public function toVonage(object $notifiable): VonageMessage
{
    return (new VonageMessage)
        ->content('Your SMS message content');
}

Unicode 内容

如果您的短信消息将包含 Unicode 字符，您应该在构建 VonageMessage 实例时调用 unicode 方法：

php

use Illuminate\Notifications\Messages\VonageMessage;

/**
 * 获取 Vonage / SMS 表示的通知。
 */
public function toVonage(object $notifiable): VonageMessage
{
    return (new VonageMessage)
        ->content('Your unicode message')
        ->unicode();
}

自定义“发件人”号码

如果您希望从与 VONAGE_SMS_FROM 环境变量指定的电话号码不同的电话号码发送某些通知，可以在 VonageMessage 实例上调用 from 方法：

php

use Illuminate\Notifications\Messages\VonageMessage;

/**
 * 获取 Vonage / SMS 表示的通知。
 */
public function toVonage(object $notifiable): VonageMessage
{
    return (new VonageMessage)
        ->content('Your SMS message content')
        ->from('15554443333');
}

添加客户端参考

如果您希望跟踪每个用户、团队或客户端的成本，可以向通知添加“客户端参考”。Vonage 将允许您使用此客户端参考生成报告，以便更好地了解特定客户的短信使用情况。客户端参考可以是最多 40 个字符的任何字符串：

php

use Illuminate\Notifications\Messages\VonageMessage;

/**
 * 获取 Vonage / SMS 表示的通知。
 */
public function toVonage(object $notifiable): VonageMessage
{
    return (new VonageMessage)
        ->clientReference((string) $notifiable->id)
        ->content('Your SMS message content');
}

路由短信通知

要将 Vonage 通知路由到正确的电话号码，请在可通知实体上定义一个 routeNotificationForVonage 方法：

php

<?php

namespace App\Models;

use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Illuminate\Notifications\Notification;

class User extends Authenticatable
{
    use Notifiable;

    /**
     * 为 Vonage 渠道路由通知。
     */
    public function routeNotificationForVonage(Notification $notification): string
    {
        return $this->phone_number;
    }
}

Slack 通知

先决条件

在发送 Slack 通知之前，您应该通过 Composer 安装 Slack 通知渠道：

shell

composer require laravel/slack-notification-channel

此外，您必须为您的 Slack 工作区创建一个 Slack App。

如果你只需要将通知发送到创建该应用的同一个 Slack 工作区中，你应确保你的应用具有 chat:write、chat:write.public 和 chat:write.customize 这几个权限范围。这些权限范围可以在 Slack 的 "OAuth & Permissions" 应用管理标签页中添加。

接下来，复制 App 的“Bot User OAuth Token”并将其放在应用程序的 services.php 配置文件中的 slack 配置数组中。此令牌可以在 Slack 的“OAuth & Permissions”选项卡中找到：

php

'slack' => [
    'notifications' => [
        'bot_user_oauth_token' => env('SLACK_BOT_USER_OAUTH_TOKEN'),
        'channel' => env('SLACK_BOT_USER_DEFAULT_CHANNEL'),
    ],
],

App 分发

如果您的应用程序将向由应用程序用户拥有的外部 Slack 工作区发送通知，您需要通过 Slack“分发”您的 App。App 分发可以从 Slack 的“Manage Distribution”选项卡中进行管理。一旦您的 App 被分发，您可以使用 Socialite 来代表应用程序用户获取 Slack Bot 令牌。

格式化 Slack 通知

如果通知支持以 Slack 消息形式发送，您应该在通知类上定义一个 toSlack 方法。此方法将接收一个 $notifiable 实体，并应返回一个 Illuminate\Notifications\Slack\SlackMessage 实例。您可以使用 Slack 的 Block Kit API 构建丰富的通知。以下示例可以在 Slack 的 Block Kit builder 中预览：

php

use Illuminate\Notifications\Slack\BlockKit\Blocks\ContextBlock;
use Illuminate\Notifications\Slack\BlockKit\Blocks\SectionBlock;
use Illuminate\Notifications\Slack\SlackMessage;

/**
 * 获取通知的 Slack 表示。
 */
public function toSlack(object $notifiable): SlackMessage
{
    return (new SlackMessage)
        ->text('One of your invoices has been paid!')
        ->headerBlock('Invoice Paid')
        ->contextBlock(function (ContextBlock $block) {
            $block->text('Customer #1234');
        })
        ->sectionBlock(function (SectionBlock $block) {
            $block->text('An invoice has been paid.');
            $block->field("*Invoice No:*\n1000")->markdown();
            $block->field("*Invoice Recipient:*\ntaylor@laravel.com")->markdown();
        })
        ->dividerBlock()
        ->sectionBlock(function (SectionBlock $block) {
            $block->text('Congratulations!');
        });
}

使用 Slack 的 Block Kit Builder 模板

您可以提供由 Slack 的 Block Kit Builder 生成的原始 JSON 负载给 usingBlockKitTemplate 方法，而不是使用流畅的消息构建器方法来构建您的 Block Kit 消息：

php

use Illuminate\Notifications\Slack\SlackMessage;
use Illuminate\Support\Str;

/**
 * 获取通知的 Slack 表示。
 */
public function toSlack(object $notifiable): SlackMessage
{
    $template = <<<JSON
        {
          "blocks": [
            {
              "type": "header",
              "text": {
                "type": "plain_text",
                "text": "Team Announcement"
              }
            },
            {
              "type": "section",
              "text": {
                "type": "plain_text",
                "text": "We are hiring!"
              }
            }
          ]
        }
    JSON;

    return (new SlackMessage)
        ->usingBlockKitTemplate($template);
}

Slack 交互性

Slack 的 Block Kit 通知系统提供了强大的功能来处理用户交互。要利用这些功能，您的 Slack App 应启用“交互性”并配置一个“请求 URL”，该 URL 指向由您的应用程序提供的 URL。这些设置可以从 Slack 的“Interactivity & Shortcuts”App 管理选项卡中进行管理。

在以下示例中，使用 actionsBlock 方法，Slack 将向您的“请求 URL”发送一个 POST 请求，其中包含点击按钮的 Slack 用户、点击按钮的 ID 等的负载。您的应用程序可以根据负载确定要采取的操作。您还应该验证请求是由 Slack 发出的：

php

use Illuminate\Notifications\Slack\BlockKit\Blocks\ActionsBlock;
use Illuminate\Notifications\Slack\BlockKit\Blocks\ContextBlock;
use Illuminate\Notifications\Slack\BlockKit\Blocks\SectionBlock;
use Illuminate\Notifications\Slack\SlackMessage;

/**
 * 获取通知的 Slack 表示。
 */
public function toSlack(object $notifiable): SlackMessage
{
    return (new SlackMessage)
        ->text('One of your invoices has been paid!')
        ->headerBlock('Invoice Paid')
        ->contextBlock(function (ContextBlock $block) {
            $block->text('Customer #1234');
        })
        ->sectionBlock(function (SectionBlock $block) {
            $block->text('An invoice has been paid.');
        })
        ->actionsBlock(function (ActionsBlock $block) {
             // ID 默认为 "button_acknowledge_invoice"...
            $block->button('Acknowledge Invoice')->primary();

            // 手动配置 ID...
            $block->button('Deny')->danger()->id('deny_invoice');
        });
}

确认模态框

如果您希望用户在执行操作之前需要确认，可以在定义按钮时调用 confirm 方法。confirm 方法接受一个消息和一个接收 ConfirmObject 实例的闭包：

php

use Illuminate\Notifications\Slack\BlockKit\Blocks\ActionsBlock;
use Illuminate\Notifications\Slack\BlockKit\Blocks\ContextBlock;
use Illuminate\Notifications\Slack\BlockKit\Blocks\SectionBlock;
use Illuminate\Notifications\Slack\BlockKit\Composites\ConfirmObject;
use Illuminate\Notifications\Slack\SlackMessage;

/**
 * 获取通知的 Slack 表示。
 */
public function toSlack(object $notifiable): SlackMessage
{
    return (new SlackMessage)
        ->text('One of your invoices has been paid!')
        ->headerBlock('Invoice Paid')
        ->contextBlock(function (ContextBlock $block) {
            $block->text('Customer #1234');
        })
        ->sectionBlock(function (SectionBlock $block) {
            $block->text('An invoice has been paid.');
        })
        ->actionsBlock(function (ActionsBlock $block) {
            $block->button('Acknowledge Invoice')
                ->primary()
                ->confirm(
                    'Acknowledge the payment and send a thank you email?',
                    function (ConfirmObject $dialog) {
                        $dialog->confirm('Yes');
                        $dialog->deny('No');
                    }
                );
        });
}

检查 Slack 块

如果您想快速检查您正在构建的块，可以在 SlackMessage 实例上调用 dd 方法。dd 方法将生成并转储一个 URL 到 Slack 的 Block Kit Builder，在您的浏览器中显示负载和通知的预览。您可以将 true 传递给 dd 方法以转储原始负载：

php

return (new SlackMessage)
    ->text('One of your invoices has been paid!')
    ->headerBlock('Invoice Paid')
    ->dd();

路由 Slack 通知

要将 Slack 通知定向到适当的 Slack 团队和频道，请在可通知模型上定义一个 routeNotificationForSlack 方法。此方法可以返回以下三种值之一：

null - 将路由推迟到通知本身中配置的频道。您可以在构建 SlackMessage 时使用 to 方法在通知中配置频道。
指定要发送通知的 Slack 频道的字符串，例如 #support-channel。
一个 SlackRoute 实例，允许您指定 OAuth 令牌和频道名称，例如 SlackRoute::make($this->slack_channel, $this->slack_token)。此方法应用于向外部工作区发送通知。

例如，从 routeNotificationForSlack 方法返回 #support-channel 将通知发送到与应用程序的 services.php 配置文件中的 Bot User OAuth 令牌关联的工作区中的 #support-channel 频道：

php

<?php

namespace App\Models;

use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Illuminate\Notifications\Notification;

class User extends Authenticatable
{
    use Notifiable;

    /**
     * 为 Slack 渠道路由通知。
     */
    public function routeNotificationForSlack(Notification $notification): mixed
    {
        return '#support-channel';
    }
}

通知外部 Slack 工作区

NOTE

在向外部 Slack 工作区发送通知之前，您的 Slack App 必须分发。

当然，您通常希望向应用程序用户拥有的 Slack 工作区发送通知。为此，您首先需要为用户获取一个 Slack OAuth 令牌。幸运的是，Laravel Socialite 包含一个 Slack 驱动程序，允许您轻松地使用 Slack 验证应用程序用户并获取 bot 令牌。

一旦您获得了 bot 令牌并将其存储在应用程序的数据库中，您可以使用 SlackRoute::make 方法将通知路由到用户的工作区。此外，您的应用程序可能需要提供一个机会让用户指定应将通知发送到哪个频道：

php

<?php

namespace App\Models;

use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Illuminate\Notifications\Notification;
use Illuminate\Notifications\Slack\SlackRoute;

class User extends Authenticatable
{
    use Notifiable;

    /**
     * 为 Slack 渠道路由通知。
     */
    public function routeNotificationForSlack(Notification $notification): mixed
    {
        return SlackRoute::make($this->slack_channel, $this->slack_token);
    }
}

本地化通知

Laravel 允许您以 HTTP 请求的当前语言环境以外的语言环境发送通知，并且即使通知被排队，也会记住此语言环境。

为此，Illuminate\Notifications\Notification 类提供了一个 locale 方法来设置所需的语言。当通知被评估时，应用程序将更改为此语言环境，然后在评估完成后恢复到先前的语言环境：

php

$user->notify((new InvoicePaid($invoice))->locale('es'));

通过 Notification facade 也可以实现多个可通知条目的本地化：

php

Notification::locale('es')->send(
    $users, new InvoicePaid($invoice)
);

用户首选语言环境

有时，应用程序会存储每个用户的首选语言环境。通过在可通知模型上实现 HasLocalePreference 合约，您可以指示 Laravel 在发送通知时使用此存储的语言环境：

php

use Illuminate\Contracts\Translation\HasLocalePreference;

class User extends Model implements HasLocalePreference
{
    /**
     * 获取用户的首选语言环境。
     */
    public function preferredLocale(): string
    {
        return $this->locale;
    }
}

一旦您实现了接口，Laravel 将在向模型发送通知和可邮寄对象时自动使用首选语言环境。因此，在使用此接口时无需调用 locale 方法：

php

$user->notify(new InvoicePaid($invoice));

测试

您可以使用 Notification facade 的 fake 方法来防止通知被发送。通常，发送通知与您实际测试的代码无关。最有可能的是，只需断言 Laravel 被指示发送给定的通知即可。

在调用 Notification facade 的 fake 方法后，您可以断言通知被指示发送给用户，甚至检查通知接收到的数据：

PestPHPUnit

php

<?php

use App\Notifications\OrderShipped;
use Illuminate\Support\Facades\Notification;

test('orders can be shipped', function () {
    Notification::fake();

    // 执行订单发货...

    // 断言没有发送通知...
    Notification::assertNothingSent();

    // 断言通知已发送给指定用户...
    Notification::assertSentTo(
        [$user], OrderShipped::class
    );

    // 断言未发送通知...
    Notification::assertNotSentTo(
        [$user], AnotherNotification::class
    );

    // 断言某个通知被发送了两次...
    Notification::assertSentTimes(WeeklyReminder::class, 2);

    // 断言发送了给定数量的通知...
    Notification::assertCount(3);
});

php

<?php

namespace Tests\Feature;

use App\Notifications\OrderShipped;
use Illuminate\Support\Facades\Notification;
use Tests\TestCase;

class ExampleTest extends TestCase
{
    public function test_orders_can_be_shipped(): void
    {
        Notification::fake();

        // 执行订单发货...

        // 断言没有发送通知...
        Notification::assertNothingSent();

        // 断言通知已发送给指定用户...
        Notification::assertSentTo(
            [$user], OrderShipped::class
        );

        // 断言未发送通知...
        Notification::assertNotSentTo(
            [$user], AnotherNotification::class
        );

        // 断言某个通知被发送了两次...
        Notification::assertSentTimes(WeeklyReminder::class, 2);

        // 断言发送了给定数量的通知...
        Notification::assertCount(3);
    }
}

您可以将闭包传递给 assertSentTo 或 assertNotSentTo 方法，以断言发送了通过给定“真值测试”的通知。如果至少发送了一条通过给定真值测试的通知，则断言将成功：

php

Notification::assertSentTo(
    $user,
    function (OrderShipped $notification, array $channels) use ($order) {
        return $notification->order->id === $order->id;
    }
);

按需通知

如果您正在测试的代码发送按需通知，您可以通过 assertSentOnDemand 方法测试按需通知是否已发送：

php

Notification::assertSentOnDemand(OrderShipped::class);

通过将闭包作为第二个参数传递给 assertSentOnDemand 方法，您可以确定按需通知是否已发送到正确的“路由”地址：

php

Notification::assertSentOnDemand(
    OrderShipped::class,
    function (OrderShipped $notification, array $channels, object $notifiable) use ($user) {
        return $notifiable->routes['mail'] === $user->email;
    }
);

通知事件

通知发送事件

当通知正在发送时，通知系统会调度 Illuminate\Notifications\Events\NotificationSending 事件。这包含“可通知”实体和通知实例本身。您可以在应用程序中为此事件创建事件监听器：

php

use Illuminate\Notifications\Events\NotificationSending;

class CheckNotificationStatus
{
    /**
     * 处理事件。
     */
    public function handle(NotificationSending $event): void
    {
        // ...
    }
}

如果 NotificationSending 事件的事件监听器返回 false，则不会发送通知：

php

/**
 * 处理事件。
 */
public function handle(NotificationSending $event): bool
{
    return false;
}

在事件监听器中，您可以访问事件上的 notifiable、notification 和 channel 属性，以了解有关通知接收者或通知本身的更多信息：

php

/**
 * 处理事件。
 */
public function handle(NotificationSending $event): void
{
    // $event->channel
    // $event->notifiable
    // $event->notification
}

通知已发送事件

当通知已发送时，通知系统会调度 Illuminate\Notifications\Events\NotificationSent 事件。这包含“可通知”实体和通知实例本身。您可以在应用程序中为此事件创建事件监听器：

php

use Illuminate\Notifications\Events\NotificationSent;

class LogNotification
{
    /**
     * 处理事件。
     */
    public function handle(NotificationSent $event): void
    {
        // ...
    }
}

在事件监听器中，您可以访问事件上的 notifiable、notification、channel 和 response 属性，以了解有关通知接收者或通知本身的更多信息：

php

/**
 * 处理事件。
 */
public function handle(NotificationSent $event): void
{
    // $event->channel
    // $event->notifiable
    // $event->notification
    // $event->response
}

自定义渠道

Laravel 附带了一些通知渠道，但您可能希望编写自己的驱动程序以通过其他渠道传递通知。Laravel 使其变得简单。要开始，请定义一个包含 send 方法的类。该方法应接收两个参数：一个 $notifiable 和一个 $notification。

在 send 方法中，您可以调用通知上的方法以检索您的渠道理解的消息对象，然后将通知发送给 $notifiable 实例，无论您希望如何：

php

<?php

namespace App\Notifications;

use Illuminate\Notifications\Notification;

class VoiceChannel
{
    /**
     * 发送给定的通知。
     */
    public function send(object $notifiable, Notification $notification): void
    {
        $message = $notification->toVoice($notifiable);

        // 将通知发送给 $notifiable 实例...
    }
}

一旦定义了通知渠道类，您可以从任何通知的 via 方法返回类名。在此示例中，通知的 toVoice 方法可以返回您选择的任何对象来表示语音消息。例如，您可以定义自己的 VoiceMessage 类来表示这些消息：

php

<?php

namespace App\Notifications;

use App\Notifications\Messages\VoiceMessage;
use App\Notifications\VoiceChannel;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Notification;

class InvoicePaid extends Notification
{
    use Queueable;

    /**
     * 获取通知渠道。
     */
    public function via(object $notifiable): string
    {
        return VoiceChannel::class;
    }

    /**
     * 获取通知的语音表示。
     */
    public function toVoice(object $notifiable): VoiceMessage
    {
        // ...
    }
}

通知 ​

介绍 ​

生成通知 ​

发送通知 ​

使用 Notifiable Trait ​

使用 Notification Facade ​

指定传递渠道 ​

队列通知 ​

延迟通知 ​

自定义通知队列连接 ​

自定义通知渠道队列 ​

自定义队列通知任务属性 ​

队列通知中间件 ​

队列通知和数据库事务 ​

确定是否应发送队列通知 ​

按需通知 ​

邮件通知 ​

格式化邮件消息 ​

错误消息 ​

其他邮件通知格式选项 ​

自定义发件人 ​

自定义收件人 ​

自定义主题 ​

自定义邮件程序 ​

自定义模板 ​

附件 ​

原始数据附件 ​

添加标签和元数据 ​

自定义 Symfony 消息 ​

使用 Mailables ​

Mailables 和按需通知 ​

预览邮件通知 ​

Markdown 邮件通知 ​

生成消息 ​

撰写消息 ​

按钮组件 ​

面板组件 ​

表格组件 ​

自定义组件 ​

自定义 CSS ​

数据库通知 ​

先决条件 ​

格式化数据库通知 ​

toDatabase vs. toArray ​

访问通知 ​

标记通知为已读 ​

广播通知 ​

先决条件 ​

格式化广播通知 ​

广播队列配置 ​

自定义通知类型 ​

监听通知 ​

使用 React 或 Vue ​

自定义通知频道 ​

短信通知 ​

先决条件 ​

格式化短信通知 ​

Unicode 内容 ​

自定义“发件人”号码 ​

添加客户端参考 ​

路由短信通知 ​

Slack 通知 ​

先决条件 ​

App 分发 ​

格式化 Slack 通知 ​

使用 Slack 的 Block Kit Builder 模板 ​

Slack 交互性 ​

确认模态框 ​

检查 Slack 块 ​

路由 Slack 通知 ​

通知外部 Slack 工作区 ​

本地化通知 ​

用户首选语言环境 ​

测试 ​

按需通知 ​

通知事件 ​

通知发送事件 ​

通知已发送事件 ​

自定义渠道 ​

通知

介绍

生成通知

发送通知

使用 Notifiable Trait

使用 Notification Facade

指定传递渠道

队列通知

延迟通知

自定义通知队列连接

自定义通知渠道队列

自定义队列通知任务属性

队列通知中间件

队列通知和数据库事务

确定是否应发送队列通知

按需通知

邮件通知

格式化邮件消息

错误消息

其他邮件通知格式选项

自定义发件人

自定义收件人

自定义主题

自定义邮件程序

自定义模板

附件

原始数据附件

添加标签和元数据

自定义 Symfony 消息

使用 Mailables

Mailables 和按需通知

预览邮件通知

Markdown 邮件通知

生成消息

撰写消息

按钮组件

面板组件

表格组件

自定义组件

自定义 CSS

数据库通知

先决条件

格式化数据库通知

`toDatabase` vs. `toArray`

访问通知

标记通知为已读

广播通知

先决条件

格式化广播通知

广播队列配置

自定义通知类型

监听通知

使用 React 或 Vue

自定义通知频道

短信通知

先决条件

格式化短信通知

Unicode 内容

自定义“发件人”号码

添加客户端参考

路由短信通知

Slack 通知

先决条件

App 分发

格式化 Slack 通知

使用 Slack 的 Block Kit Builder 模板

Slack 交互性

确认模态框

检查 Slack 块

路由 Slack 通知

通知外部 Slack 工作区

本地化通知

用户首选语言环境

测试

按需通知

通知事件

通知发送事件

通知已发送事件

自定义渠道