许多 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\Listeners\SendEmailVerificationNotification 监听器,用于 Illuminate\Auth\Events\Registered 事件。
如果您正在应用程序中手动实现注册功能而不是使用入门套件,您应该确保在用户注册成功后分发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。路由被赋予这个确切名称很重要因为 verified 中间件 Laravel 中包含的 将自动重定向到此路由名称如果用户尚未验证其电子邮件地址。
[!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 事件。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');路由中间件 可用于只允许已验证用户访问给定路由。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);
});
}[!NOTE]
要了解更多关于邮件通知的信息,请查阅邮件通知文档。
当使用 Laravel 应用程序入门套件,Laravel 会分发一个 Illuminate\Auth\Events\Verified 事件 在电子邮件验证过程中。如果你的应用程序正在手动处理电子邮件验证,你可能希望在验证完成后手动分发这些事件。