邮箱验证
简介
许多 Web 应用要求用户在使用应用前验证其邮箱地址。Laravel 提供了一套便捷的内置服务来发送和验证邮箱验证请求,无需您为每个创建的应用手动重复实现此功能。
想要快速开始?在一个全新的 Laravel 应用中安装 Laravel 应用入门套件。这些入门套件将为您搭建完整的身份验证系统,包括对邮箱验证的支持。
模型准备
开始之前,请确保您的 App\Models\User 模型实现了 Illuminate\Contracts\Auth\MustVerifyEmail 契约。
1<?php 2 3namespace App\Models; 4 5use Illuminate\Contracts\Auth\MustVerifyEmail; 6use Illuminate\Foundation\Auth\User as Authenticatable; 7use Illuminate\Notifications\Notifiable; 8 9class User extends Authenticatable implements MustVerifyEmail10{11 use Notifiable;12 13 // ...14}
一旦将此接口添加到模型中,新注册的用户将自动收到一封包含邮箱验证链接的邮件。这是因为 Laravel 会自动为 Illuminate\Auth\Events\Registered 事件注册 Illuminate\Auth\Listeners\SendEmailVerificationNotification 监听器,从而无缝地完成此过程。
如果您没有使用 入门套件,而是手动在应用中实现注册逻辑,则应确保在用户注册成功后分发 Illuminate\Auth\Events\Registered 事件。
1use Illuminate\Auth\Events\Registered;2 3event(new Registered($user));
数据库准备
接下来,您的 users 表必须包含一个 email_verified_at 字段,用于存储用户邮箱地址被验证的日期和时间。通常情况下,这已包含在 Laravel 默认的 0001_01_01_000000_create_users_table.php 数据库迁移文件中。
路由
为了正确实现邮箱验证,需要定义三个路由。首先,需要一个路由来向用户显示通知,告知他们点击 Laravel 在注册后发送的验证邮件中的验证链接。
其次,需要一个路由来处理用户点击邮件中验证链接时生成的请求。
第三,需要一个路由,以便在用户不慎丢失验证链接时重新发送验证链接。
邮箱验证通知
如前所述,应定义一个路由,该路由返回一个视图,指导用户点击 Laravel 在注册后发送的验证链接。当用户在未验证邮箱的情况下尝试访问应用的其他部分时,将向他们显示此视图。请记住,只要您的 App\Models\User 模型实现了 MustVerifyEmail 接口,该链接就会自动发送给用户。
1Route::get('/email/verify', function () {2 return view('auth.verify-email');3})->middleware('auth')->name('verification.notice');
返回邮箱验证通知的路由应命名为 verification.notice。为该路由分配此确切名称非常重要,因为 Laravel 内置的 verified 中间件在用户未验证邮箱时会自动重定向到此路由名称。
手动实现邮箱验证时,您需要自行定义验证通知视图的内容。如果您需要包含所有必要身份验证和验证视图的脚手架,请查看 Laravel 应用入门套件。
邮箱验证处理
接下来,我们需要定义一个路由来处理用户点击邮件中的验证链接时触发的请求。该路由应命名为 verification.verify,并分配 auth 和 signed 中间件。
1use Illuminate\Foundation\Auth\EmailVerificationRequest;2 3Route::get('/email/verify/{id}/{hash}', function (EmailVerificationRequest $request) {4 $request->fulfill();5 6 return redirect('/home');7})->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 模型。一旦用户的邮箱地址被验证,您就可以将他们重定向到您希望的任何位置。
重新发送验证邮件
有时用户可能会丢失或不小心删除了邮箱验证邮件。为了应对这种情况,您可能希望定义一个路由,允许用户请求重新发送验证邮件。您可以通过在您的 验证通知视图 中放置一个简单的表单提交按钮来向该路由发送请求。
1use Illuminate\Http\Request;2 3Route::post('/email/verification-notification', function (Request $request) {4 $request->user()->sendEmailVerificationNotification();5 6 return back()->with('message', 'Verification link sent!');7})->middleware(['auth', 'throttle:6,1'])->name('verification.send');
保护路由
路由中间件 可用于仅允许已验证的用户访问特定路由。Laravel 包含一个 verified 中间件别名,它是 Illuminate\Auth\Middleware\EnsureEmailIsVerified 中间件类的别名。由于此别名已由 Laravel 自动注册,您只需将 verified 中间件附加到路由定义中即可。通常,此中间件会与 auth 中间件配合使用。
1Route::get('/profile', function () {2 // Only verified users may access this route...3})->middleware(['auth', 'verified']);
如果未验证的用户尝试访问分配了此中间件的路由,他们将自动被重定向到 verification.notice 命名路由。
自定义
验证邮件自定义
虽然默认的邮箱验证通知应能满足大多数应用的需求,但 Laravel 允许您自定义邮件验证消息的构建方式。
首先,将闭包传递给 Illuminate\Auth\Notifications\VerifyEmail 通知提供的 toMailUsing 方法。该闭包将接收正在接收通知的可通知模型实例以及用户必须访问的签名邮箱验证 URL。闭包应返回 Illuminate\Notifications\Messages\MailMessage 的实例。通常,您应该在应用 AppServiceProvider 类的 boot 方法中调用 toMailUsing 方法。
1use Illuminate\Auth\Notifications\VerifyEmail; 2use Illuminate\Notifications\Messages\MailMessage; 3 4/** 5 * Bootstrap any application services. 6 */ 7public function boot(): void 8{ 9 // ...10 11 VerifyEmail::toMailUsing(function (object $notifiable, string $url) {12 return (new MailMessage)13 ->subject('Verify Email Address')14 ->line('Click the button below to verify your email address.')15 ->action('Verify Email Address', $url);16 });17}
要了解有关邮件通知的更多信息,请参阅 邮件通知文档。
活动
使用 Laravel 应用入门套件 时,Laravel 会在邮箱验证过程中分发 Illuminate\Auth\Events\Verified 事件。如果您正在手动为应用处理邮箱验证,则可能需要在验证完成后手动分发这些事件。