欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

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

程序员文章站 2023-11-27 15:39:58
本文实例讲述了laravel框架邮箱认证实现方法。分享给大家供大家参考,具体如下: 修改 user 模型,将 laravel 自带的邮箱认证功能集成到我们的程序中 &l...

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

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

<?php

namespace app\models;

use illuminate\notifications\notifiable;
use illuminate\auth\mustverifyemail as mustverifyemailtrait;
use illuminate\foundation\auth\user as authenticatable;
use illuminate\contracts\auth\mustverifyemail 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',
  ];
}

代码详解:

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

加载使用 mustverifyemail trait,打开 vendor/laravel/framework/src/illuminate/auth/mustverifyemail.php 文件,可以看到以下三个方法:

  • hasverifiedemail() 检测用户 email 是否已认证;
  • markemailasverified() 将用户标示为已认证;
  • sendemailverificationnotification() 发送 email 认证的消息通知,触发邮件的发送。

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

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

可以打开 vendor/laravel/framework/src/illuminate/contracts/auth/mustverifyemail.php ,可以看到此文件为 php 的接口类,继承此类将确保 user 遵守契约,拥有上面提到的三个方法。

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

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

此方法处理了用户提交表单后的逻辑,我们把重点放在 event(new registered($user = $this->create($request->all())));,这里使用了 laravel 的事件系统,触发了 registered 事件。

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

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

打开 sendemailverificationnotification 类,阅读其源码:

vendor/laravel/framework/src/illuminate/auth/listeners/sendemailverificationnotification.php

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

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

强制用户认证

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

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

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

php artisan make:middleware ensureemailisverified

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

app/http/middleware/ensureemailisverified.php

<?php

namespace app\http\middleware;

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

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

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

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

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

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