邮件验证
简介
许多 Web 应用程序要求用户在使用应用程序之前验证其电子邮件地址。Laravel 提供了便捷的内置服务用于发送和验证邮件验证请求,而不是强迫你为每个创建的应用程序手动重新实现此功能。
NOTE
想快速上手?在一个新的 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 中间件将自动重定向到此路由名称。
NOTE
手动实现邮件验证时,你需要自己定义验证通知视图的内容。如果你希望包含所有必需的身份验证和验证视图的脚手架,请查看 Laravel 应用程序入门套件。
邮件验证处理程序
接下来,我们需要定义一个路由来处理用户点击通过电子邮件发送给他们的邮件验证链接时生成的请求。此路由应命名为 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 事件。默认的 App\Models\User 模型通过 Illuminate\Foundation\Auth\User 基类可以使用 markEmailAsVerified 方法。一旦用户的电子邮件地址被验证,你可以将它们重定向到任何你想要的地方。
重新发送验证邮件
有时用户可能会误放或意外删除邮件地址验证邮件。为了解决这个问题,你可能希望定义一个路由以允许用户请求重新发送验证邮件。然后,你可以通过在 验证通知视图 中放置一个简单的表单提交按钮来向此路由发出请求:
use Illuminate\Http\Request;
Route::post('/email/verification-notification', function (Request $request) {
$request->user()->sendEmailVerificationNotification();
return back()->with('message', '验证链接已发送!');
})->middleware(['auth', 'throttle:6,1'])->name('verification.send');保护路由
路由中间件 可用于仅允许已验证用户访问给定路由。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);
});
}NOTE
要了解有关邮件通知的更多信息,请查阅 邮件通知文档。
事件
当使用 Laravel 应用程序入门套件 时,Laravel 在邮件验证过程中会分发一个 Illuminate\Auth\Events\Verified 事件。如果你正在手动为你的应用程序处理邮件验证,你可能希望在验证完成后手动分发此事件。