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

时间：2022-12-13 08:11:25

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

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

  1. <?php
  2.  
  3. namespace App\Models;
  4.  
  5. use Illuminate\Notifications\Notifiable;
  6. use Illuminate\Auth\MustVerifyEmail as MustVerifyEmailTrait;
  7. use Illuminate\Foundation\Auth\User as Authenticatable;
  8. use Illuminate\Contracts\Auth\MustVerifyEmail as MustVerifyEmailContract;
  9.  
  10. class User extends Authenticatable implements MustVerifyEmailContract
  11. {
  12. use Notifiable, MustVerifyEmailTrait;
  13.  
  14. /**
  15. * The attributes that are mass assignable.
  16. *
  17. * @var array
  18. */
  19. protected $fillable = [
  20. 'name', 'email', 'password',
  21. ];
  22.  
  23. /**
  24. * The attributes that should be hidden for arrays.
  25. *
  26. * @var array
  27. */
  28. protected $hidden = [
  29. 'password', 'remember_token',
  30. ];
  31.  
  32. /**
  33. * The attributes that should be cast to native types.
  34. *
  35. * @var array
  36. */
  37. protected $casts = [
  38. 'email_verified_at' => 'datetime',
  39. ];
  40. }

代码详解：

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

  1. <?php
  2.  
  3. namespace App\Http\Middleware;
  4.  
  5. use Closure;
  6.  
  7. class EnsureEmailIsVerified
  8. {
  9. public function handle($request, Closure $next)
  10. {
  11. // 三个判断：
  12. // 1. 如果用户已经登录
  13. // 2. 并且还未认证 Email
  14. // 3. 并且访问的不是 email 验证相关 URL 或者退出的 URL。
  15. if ($request->user() &&
  16. ! $request->user()->hasVerifiedEmail() &&
  17. ! $request->is('email/*', 'logout')) {
  18.  
  19. // 根据客户端返回对应的内容
  20. return $request->expectsJson()
  21. ? abort(403, 'Your email address is not verified.')
  22. : redirect()->route('verification.notice');
  23. }
  24.  
  25. return $next($request);
  26. }
  27. }

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

app/Http/Kernel.php

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

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

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

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

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

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

原文链接：https://www.cnblogs.com/sgm4231/p/11017334.html

标签：

相关文章