Appearance
电子邮件验证
介绍
许多 Web 应用程序要求用户在使用应用程序之前验证其电子邮件地址。Laravel 不会强迫您为您创建的每个应用程序手动重新实现此功能,而是提供方便的内置服务来发送和验证电子邮件验证请求。
NOTE
想要快速入门?在新的 Laravel 应用程序中安装其中一个 Laravel 应用程序初学者工具包。初学者工具包将负责构建您的整个身份验证系统,包括电子邮件验证支持。
模型准备
在开始之前,请验证您的 App\Models\User
模型是否实现了 Illuminate\Contracts\Auth\MustVerifyEmail
协定:
php
<?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
事件:
php
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
接口,该链接就会自动通过电子邮件发送给用户:
php
Route::get('/email/verify', function () {
return view('auth.verify-email');
})->middleware('auth')->name('verification.notice');
返回电子邮件验证通知的路由应命名为 verification.notice
。为路由分配这个确切的名称很重要,因为如果用户没有验证他们的电子邮件地址,Laravel 附带的经过验证的
中间件将自动重定向到这个路由名称。
NOTE
手动实施电子邮件验证时,您需要自行定义验证通知视图的内容。如果您想要包含所有必要的身份验证和验证视图的基架,请查看 Laravel 应用程序初学者工具包。
电子邮件验证处理程序
接下来,我们需要定义一个路由,该路由将处理用户单击通过电子邮件发送给他们的电子邮件验证链接时生成的请求。此路由应命名为 verification.verify
并分配 auth
和 signed
中间件:
php
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
模型。验证用户的电子邮件地址后,您可以将他们重定向到您想要的任何地方。
重新发送验证电子邮件
有时,用户可能会放错地方或意外删除电子邮件地址验证电子邮件。为了适应这种情况,您可能希望定义一个路由,以允许用户请求重新发送验证电子邮件。然后,您可以通过在验证通知视图中放置一个简单的表单提交按钮来向此路由发出请求:
php
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 包含一个经过验证的
中间件别名,它是中间件类的 Illuminate\Auth\Middleware\EnsureEmailIsVerified
别名。由于此别名已经由 Laravel 自动注册,因此您需要做的就是将经过验证的
中间件附加到路由定义中。通常,此中间件与 auth
中间件配对:
php
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
方法:
php
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
。如果您手动处理应用程序的电子邮件验证,则可能需要在验证完成后手动调度这些事件。