邮箱验证

简介

许多 Web 应用要求用户在使用应用之前验证其电子邮件地址。Laravel 提供了便捷的内置服务来发送和验证电子邮件验证请求，而不是强迫你在每个应用中手动重新实现此功能。

NOTE

想要快速开始？在一个全新的 Laravel 应用中安装一个 Laravel 应用入门套件。入门套件将负责搭建你的整个认证系统，包括邮箱验证支持。

模型准备

在开始之前，请确认你的 App\Models\User 模型实现了 Illuminate\Contracts\Auth\MustVerifyEmail 契约：

php

<?php

namespace App\Models;

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

class User extends Authenticatable implements MustVerifyEmail
{
    use Notifiable;

    // ...
}

将此接口添加到模型后，新注册的用户将自动收到一封包含邮箱验证链接的电子邮件。这是无缝发生的，因为 Laravel 会自动为 Illuminate\Auth\Events\Registered 事件注册 Illuminate\Auth\Listeners\SendEmailVerificationNotification 监听器。

如果你在应用中手动实现注册而不是使用入门套件，你应该确保在用户注册成功后分发 Illuminate\Auth\Events\Registered 事件：

php

use Illuminate\Auth\Events\Registered;

event(new Registered($user));

数据库准备

接下来，你的 users 表必须包含一个 email_verified_at 列来存储用户电子邮件地址被验证的日期和时间。通常，这已包含在 Laravel 默认的 0001_01_01_000000_create_users_table.php 数据库迁移中。

路由

要正确实现邮箱验证，需要定义三个路由。首先，需要一个路由来显示通知，告知用户应点击注册后 Laravel 发送给他们的验证邮件中的邮箱验证链接。

其次，需要一个路由来处理用户点击邮件中的邮箱验证链接时生成的请求。

第三，如果用户不小心丢失了第一个验证链接，则需要一个路由来重新发送验证链接。

邮箱验证通知

如前所述，应定义一个路由，返回一个视图指示用户点击注册后 Laravel 通过电子邮件发送给他们的邮箱验证链接。当用户在未先验证邮箱地址的情况下尝试访问应用的其他部分时，将向他们显示此视图。请记住，只要你的 App\Models\User 模型实现了 MustVerifyEmail 接口，链接就会自动通过电子邮件发送给用户：

php

Route::get('/email/verify', function () {
    return view('auth.verify-email');
})->middleware('auth')->name('verification.notice');

返回邮箱验证通知的路由应命名为 verification.notice。路由必须分配此确切名称非常重要，因为 Laravel 内置的 verified middleware 会在用户未验证邮箱地址时自动重定向到此路由名称。

NOTE

手动实现邮箱验证时，你需要自己定义验证通知视图的内容。如果你希望获得包含所有必要认证和验证视图的脚手架，请查看 Laravel 应用入门套件。

邮箱验证处理器

接下来，我们需要定义一个路由来处理用户点击电子邮件中的邮箱验证链接时生成的请求。此路由应命名为 verification.verify 并分配 auth 和 signed middleware：

php

use Illuminate\Foundation\Auth\EmailVerificationRequest;

Route::get('/email/verify/{id}/{hash}', function (EmailVerificationRequest $request) {
    $request->fulfill();

    return redirect('/home');
})->middleware(['auth', 'signed'])->name('verification.verify');

在继续之前，让我们仔细看看这个路由。首先，你会注意到我们使用的是 EmailVerificationRequest 请求类型而不是典型的 Illuminate\Http\Request 实例。EmailVerificationRequest 是 Laravel 内置的一个表单请求。此请求将自动处理验证请求的 id 和 hash 参数。

接下来，我们可以直接调用请求上的 fulfill 方法。此方法将在已认证用户上调用 markEmailAsVerified 方法并分发 Illuminate\Auth\Events\Verified 事件。markEmailAsVerified 方法通过 Illuminate\Foundation\Auth\User 基类对默认的 App\Models\User 模型可用。一旦用户的邮箱地址已被验证，你可以将他们重定向到任何你希望的地方。

重新发送验证邮件

有时用户可能会丢失或意外删除邮箱地址验证邮件。为了适应这种情况，你可以定义一个路由允许用户请求重新发送验证邮件。然后你可以通过在验证通知视图中放置一个简单的表单提交按钮来发起对此路由的请求：

php

use Illuminate\Http\Request;

Route::post('/email/verification-notification', function (Request $request) {
    $request->user()->sendEmailVerificationNotification();

    return back()->with('message', 'Verification link sent!');
})->middleware(['auth', 'throttle:6,1'])->name('verification.send');

保护路由

路由 middleware 可用于仅允许已验证的用户访问给定路由。Laravel 包含一个 verified middleware 别名，它是 Illuminate\Auth\Middleware\EnsureEmailIsVerified middleware 类的别名。由于此别名已由 Laravel 自动注册，你只需将 verified middleware 附加到路由定义即可。通常，此 middleware 与 auth middleware 配对使用：

php

Route::get('/profile', function () {
    // 只有已验证的用户才能访问此路由...
})->middleware(['auth', 'verified']);

如果未验证的用户尝试访问已分配此 middleware 的路由，他们将自动被重定向到 verification.notice 命名路由。

自定义

验证邮件自定义

虽然默认的邮箱验证通知应该能满足大多数应用的需求，但 Laravel 允许你自定义邮箱验证邮件消息的构建方式。

首先，将闭包传递给 Illuminate\Auth\Notifications\VerifyEmail 通知提供的 toMailUsing 方法。该闭包将接收正在接收通知的可通知模型实例以及用户必须访问以验证其邮箱地址的签名邮箱验证 URL。闭包应返回 Illuminate\Notifications\Messages\MailMessage 的实例。通常，你应该从应用的 AppServiceProvider 类的 boot 方法中调用 toMailUsing 方法：

php

use Illuminate\Auth\Notifications\VerifyEmail;
use Illuminate\Notifications\Messages\MailMessage;

/**
 * 引导任何应用服务。
 */
public function boot(): void
{
    // ...

    VerifyEmail::toMailUsing(function (object $notifiable, string $url) {
        return (new MailMessage)
            ->subject('Verify Email Address')
            ->line('Click the button below to verify your email address.')
            ->action('Verify Email Address', $url);
    });
}

NOTE

要了解更多关于邮件通知的信息，请参阅邮件通知文档。

事件

当使用 Laravel 应用入门套件时，Laravel 会在邮箱验证过程中分发 Illuminate\Auth\Events\Verified 事件。如果你正在为应用手动处理邮箱验证，你可能希望在验证完成后手动分发这些事件。

邮箱验证 ​

简介 ​

模型准备 ​

数据库准备 ​

路由 ​

邮箱验证通知 ​

邮箱验证处理器 ​

重新发送验证邮件 ​

保护路由 ​

自定义 ​

验证邮件自定义 ​

事件 ​

邮箱验证

简介

模型准备

数据库准备

路由

邮箱验证通知

邮箱验证处理器

重新发送验证邮件

保护路由

自定义

验证邮件自定义

事件