电子邮件验证

简介

许多 Web 应用程序要求用户在使用应用程序之前验证其电子邮件地址。Laravel 提供了方便的内置服务,用于发送和验证电子邮件验证请求,这样你就不必为每个创建的应用程序手动重新实现这个功能。

想要快速开始吗?在一个新的 Laravel 应用程序中安装其中一个 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 中间件会在用户尚未验证其电子邮件地址时自动重定向到此路由名称。

在手动实现电子邮件验证时,您需要自行定义验证通知视图的内容。如果您希望获取包含所有必要身份验证和验证视图的脚手架,可以查看 【Laravel 的应用程序启动包】。

电子邮件验证处理器

接下来,我们需要定义一个路由,用于处理当用户点击通过电子邮件发送的验证链接时生成的请求。此路由应命名为 verification.verify,并分配 authsigned 中间件:

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 自带的【表单请求】类。这个请求会自动处理验证请求中的 idhash 参数。

接下来,我们可以直接调用请求上的 fulfill 方法。该方法会调用已验证用户的 markEmailAsVerified 方法,并触发 Illuminate\Auth\Events\Verified 事件。markEmailAsVerified 方法可以通过 Illuminate\Foundation\Auth\User 基类在默认的 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');

在这个例子中,路由通过 post 请求来处理重新发送验证邮件的操作。sendEmailVerificationNotification 方法会重新发送验证邮件。此路由应用了 auth 中间件以确保用户已登录,并且使用了 throttle:6,1 中间件限制每分钟最多请求 6 次,以防止滥用。

当请求成功时,用户会被重定向回上一页,并附带一个消息,告知他们验证链接已经重新发送。

保护路由

【路由中间件】可以用来仅允许已验证的用户访问某个路由。Laravel 包含了一个 verified 【中间件别名】,它是 Illuminate\Auth\Middleware\EnsureEmailIsVerified 中间件类的别名。由于这个别名已经由 Laravel 自动注册,因此您只需要将 verified 中间件附加到路由定义中。通常,这个中间件与 auth 中间件一起使用:

Route::get('/profile', function () {
    // 只有已验证的用户才能访问此路由...
})->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;

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

    VerifyEmail::toMailUsing(function (object $notifiable, string $url) {
        return (new MailMessage)
            ->subject('验证电子邮件地址')
            ->line('点击下面的按钮验证您的电子邮件地址。')
            ->action('验证电子邮件地址', $url);
    });
}

要了解更多关于邮件通知的信息,请查阅【邮件通知文档】。

事件

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