邮箱验证

• 简介
  • 模型准备
  • 数据库准备
• 路由
  • 邮箱验证通知
  • 邮箱验证处理程序
  • 重新发送验证邮件
  • 保护路由
• 自定义
• 事件

简介

许多 Web 应用程序要求用户在使用应用程序之前验证其电子邮件地址。Laravel 没有强迫您为创建的每个应用程序手动重新实现此功能，而是提供了方便的内置服务，用于发送和验证电子邮件验证请求。

模型准备

在开始之前，请验证您的 App\Models\User 模型是否实现了 Illuminate\Contracts\Auth\MustVerifyEmail 契约

<?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 事件

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 接口，该链接就会自动通过电子邮件发送给用户

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

返回电子邮件验证通知的路由应命名为 verification.notice。重要的是该路由被分配此确切名称，因为 Laravel 包含的 verified 中间件会在用户未验证其电子邮件地址时自动重定向到此路由名称。

邮箱验证处理程序

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

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 事件。可以通过 Illuminate\Foundation\Auth\User 基类将 markEmailAsVerified 方法提供给默认的 App\Models\User 模型。验证用户电子邮件地址后，您可以将他们重定向到任何您希望的位置。

重新发送验证邮件

有时用户可能会放错位置或意外删除电子邮件地址验证电子邮件。为了适应这一点，您可能希望定义一个路由，以允许用户请求重新发送验证电子邮件。然后，您可以通过在您的 验证通知视图 中放置一个简单的表单提交按钮来向此路由发出请求

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');

保护路由

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

Route::get('/profile', function () {
    // Only verified users may access this route...
})->middleware(['auth', 'verified']);

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

自定义

验证电子邮件自定义

虽然默认的电子邮件验证通知应满足大多数应用程序的要求，但 Laravel 允许您自定义电子邮件验证邮件消息的构造方式。

要开始，请将闭包传递给 Illuminate\Auth\Notifications\VerifyEmail 通知提供的 toMailUsing 方法。该闭包将接收正在接收通知的可通知模型实例以及用户必须访问以验证其电子邮件地址的已签名电子邮件验证 URL。该闭包应返回 Illuminate\Notifications\Messages\MailMessage 的实例。通常，您应该从应用程序的 AppServiceProvider 类的 boot 方法中调用 toMailUsing 方法

use Illuminate\Auth\Notifications\VerifyEmail;
use Illuminate\Notifications\Messages\MailMessage;
 
/**
 * Bootstrap any application services.
 */
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);
    });
}

事件

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