跳到内容

邮箱验证

简介

许多 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 MustVerifyEmail
10{
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,并分配 authsigned 中间件

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 方法通过 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 事件。如果您正在为您的应用程序手动处理邮箱验证,您可能希望在验证完成后手动调度这些事件。

Laravel 是构建最有效率的方式,用于
构建、部署和监控软件。