laravel框架邮箱认证实现方法详解

时间:2022-07-27
本文章向大家介绍laravel框架邮箱认证实现方法详解,主要内容包括其使用实例、应用技巧、基本知识点总结和需要注意事项,具有一定的参考价值,需要的朋友可以参考一下。

本文实例讲述了laravel框架邮箱认证实现方法。分享给大家供大家参考,具体如下:

修改 User 模型,将 Laravel 自带的邮箱认证功能集成到我们的程序中

<?php

namespace AppModels;

use IlluminateNotificationsNotifiable;
use IlluminateAuthMustVerifyEmail as MustVerifyEmailTrait;
use IlluminateFoundationAuthUser as Authenticatable;
use IlluminateContractsAuthMustVerifyEmail as MustVerifyEmailContract;

class User extends Authenticatable implements MustVerifyEmailContract
{
  use Notifiable, MustVerifyEmailTrait;

  /**
   * The attributes that are mass assignable.
   *
   * @var array
   */
  protected $fillable = [
    'name', 'email', 'password',
  ];

  /**
   * The attributes that should be hidden for arrays.
   *
   * @var array
   */
  protected $hidden = [
    'password', 'remember_token',
  ];

  /**
   * The attributes that should be cast to native types.
   *
   * @var array
   */
  protected $casts = [
    'email_verified_at' =  'datetime',
  ];
}

代码详解:

加载使用MustVerifyEmailtrait,打开vendor/laravel/framework/src/Illuminate/Auth/MustVerifyEmail.php文件,可以看到以下三个方法:

  • hasVerifiedEmail()检测用户 Email 是否已认证;
  • markEmailAsVerified()将用户标示为已认证;
  • sendEmailVerificationNotification()发送 Email 认证的消息通知,触发邮件的发送。

得益于 PHP 的 trait 功能,User 模型在use以后,即可使用以上三个方法。

可以打开vendor/laravel/framework/src/Illuminate/Contracts/Auth/MustVerifyEmail.php,可以看到此文件为 PHP 的接口类,继承此类将确保 User 遵守契约,拥有上面提到的三个方法。

如果我们使用了 Laravel 自带的RegisterController,控制器通过加载IlluminateFoundationAuthRegistersUserstrait 来引入框架的注册功能,此时我们打开此 trait 来翻阅源码并定位到register(Request $request)方法:

此方法处理了用户提交表单后的逻辑,我们把重点放在event(new Registered(user = this- create(

打开app/Providers/EventServiceProvider.php文件,此文件的$listen属性里我们可以看到注册了Registered事件的监听器:

打开SendEmailVerificationNotification类,阅读其源码:

vendor/laravel/framework/src/Illuminate/Auth/Listeners/SendEmailVerificationNotification.php

可以看出 Laravel 默认已经为我们设置了邮件发送的逻辑

强制用户认证

我们希望用户认证邮箱后,才能使用网站。

我们将使用Laravel 中间件来过滤用户的所有请求,如果用户未认证的话,就跳转到邮件认证提醒的页面中

可以使用以下命令来新建一个中间件:

php artisan make:middleware EnsureEmailIsVerified

打开生成的文件并代入以下内容:

app/Http/Middleware/EnsureEmailIsVerified.php

<?php

namespace AppHttpMiddleware;

use Closure;

class EnsureEmailIsVerified
{
  public function handle($request, Closure $next)
  {
    // 三个判断:
    // 1. 如果用户已经登录
    // 2. 并且还未认证 Email
    // 3. 并且访问的不是 email 验证相关 URL 或者退出的 URL。
    if ($request- user() &&
      ! $request- user()- hasVerifiedEmail() &&
      ! $request- is('email/*', 'logout')) {

      // 根据客户端返回对应的内容
      return $request- expectsJson()
            ? abort(403, 'Your email address is not verified.')
            : redirect()- route('verification.notice');
    }

    return $next($request);
  }
}

接下来注册中间件,注册的时机确保在StartSession后面即可:

app/Http/Kernel.php

此时如果我们没有认证邮箱就会看到认证提醒,并且除了我们上面代码中设置的 URL 外都会进入此页面:

内置邮箱认证还有个小功能,当你点击点击多次『重新发送 Email』后,系统会自动做限额处理,可以有效防止用户消耗太多资源。你可以在VerificationController中配置相应的信息:

更多关于Laravel相关内容感兴趣的读者可查看本站专题:《Laravel框架入门与进阶教程》、《php优秀开发框架总结》、《php面向对象程序设计入门教程》、《php+mysql数据库操作入门教程》及《php常见数据库操作技巧汇总》

希望本文所述对大家基于Laravel框架的PHP程序设计有所帮助。