跳至内容

电子邮件验证

介绍

许多 Web 应用程序要求用户在使用前验证其电子邮件地址。Laravel 提供了便捷的内置服务来发送和验证电子邮件地址验证请求,而无需您为每个应用程序手动重新实现此功能。

想要快速上手?在全新的 Laravel 应用中安装一个Laravel 应用入门套件。该入门套件将负责搭建整个身份验证系统,包括电子邮件验证支持。

模型准备

在开始之前,请验证您的App\Models\User模型是否实现了Illuminate\Contracts\Auth\MustVerifyEmailContracts:

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 MustVerifyEmail
10{
11 use Notifiable;
12 
13 // ...
14}

将此接口添加到模型后,新注册的用户将自动收到一封包含邮箱验证链接的邮件。由于 Laravel 会自动注册该事件的Illuminate\Auth\Listeners\SendEmailVerificationNotification 监听器Illuminate\Auth\Events\Registered,因此整个过程无缝衔接。

如果您在应用程序中手动实现注册而不是使用入门套件,则应确保在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数据库迁移中。

路由

为了正确实现电子邮件验证,需要定义三个路由。首先,需要一个路由向用户显示一条通知,Prompts用户在注册后点击 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 自带的表单请求。该请求会自动验证请求的内容idhash参数。

fulfill接下来,我们可以直接在请求中调用该方法。该方法将调用markEmailAsVerified已验证用户的方法并派发Illuminate\Auth\Events\Verified事件。该markEmailAsVerified方法可App\Models\User通过Illuminate\Foundation\Auth\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 允许您自定义电子邮件验证邮件消息的构造方式。

首先,将一个闭包传递给通知toMailUsing提供的方法Illuminate\Auth\Notifications\VerifyEmail。该闭包将接收接收通知的可通知模型实例,以及用户必须访问以验证其电子邮件地址的签名电子邮件验证 URL。闭包应返回一个 实例Illuminate\Notifications\Messages\MailMessage。通常,您应该toMailUsingboot应用程序AppServiceProvider类的方法中调用该方法:

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}

要了解有关邮件通知的更多信息,请查阅邮件通知文档

Events

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