Laravel认证原理以及完全自定义认证详解

前言

Laravel 默认的 auth 功能已经是很全面了，但是我们也经常会碰到一些需要自定义的一些情况，比如验证的字段和默认的不匹配，比如需要能够同时满足 user name 和 email 认证等等。如何创建一个完全自定义的认证呢？相比一个教程，我更倾向于介绍一下工作原理，这样在自己修改或自定义的过程中更得心应手。

Authenticatable 接口

Illuminate\Contracts\Auth\Authenticatable

Authenticatable 定义了一个可以被用来认证的模型或类需要实现的接口，也就是说，如果需要用一个自定义的类来做认证，需要实现这个接口定义的方法。

PHP;"> // 获取唯一标识的，可以用来认证的字段名，比如 id，uuid public function getAuthIdentifierName(); // 获取该标示符对应的值 public function getAuthIdentifier(); // 获取认证的密码 public function getAuthPassword(); // 获取remember token public function getRememberToken(); // 设置 remember token public function setRememberToken($value); // 获取 remember token 对应的字段名，比如默认的 'remember_token' public function getRememberTokenName();

比如你的认证模型需要用 'token' 而不是 'password' 来作为密码验证，这个时候就可以修改 getAuthPassword() 方法的返回值为 'token';

Authenticatable trait

Illuminate\Auth\Authenticatable

Laravel 中定义的 Authenticatable trait，也是 Laravel auth 默认的 User 模型使用的 trait，这个 trait 定义了 User 模型默认认证标示符为 'id'，密码字段为 'password'，remember token 对应的字段为 remember_token 等等。

通过重写 User 模型的这些方法可以修改一些设置。

Guard 接口

Illuminate\Contracts\Auth\Guard

Guard 接口定义了某个实现了 Authenticatable (可认证的) 模型或类的认证方法以及一些常用的接口。

PHP;"> // 判断当前用户是否登录 public function check(); // 判断当前用户是否是游客（未登录） public function guest(); // 获取当前认证的用户 public function user(); // 获取当前认证用户的 id，严格来说不一定是 id，应该是上个模型中定义的唯一的字段名 public function id(); // 根据提供的消息认证用户 public function validate(array $credentials = []); // 设置当前用户 public function setUser(Authenticatable $user);

StatefulGuard 接口

Illuminate\Contracts\Auth\StatefulGuard

StatefulGuard 接口继承自 Guard 接口，除了 Guard 里面定义的一些基本接口外，还增加了更进一步、有状态的 Guard.

新添加的接口有这些：

PHP;"> // 尝试根据提供的凭证验证用户是否合法 public function attempt(array $credentials = [],$remember = false); // 一次性登录，不记录session or cookie public function once(array $credentials = []); // 登录用户，通常在验证成功后记录 session 和 cookie public function login(Authenticatable $user,$remember = false); // 使用用户 id 登录 public function loginUsingId($id,$remember = false); // 使用用户 ID 登录，但是不记录 session 和 cookie public function onceUsingId($id); // 通过 cookie 中的 remember token 自动登录 public function viaRemember(); // 登出 public function logout();

Laravel 中默认提供了 3 中 guard：RequestGuard，TokenGuard，SessionGuard.

RequestGuard

Illuminate\Auth\RequestGuard

RequestGuard 是一个非常简单的 guard. RequestGuard 是通过传入一个闭包来认证的。可以通过调用 Auth::viaRequest 添加一个自定义的 RequestGuard.

SessionGuard

Illuminate\Auth\SessionGuard

SessionGuard 是 Laravel web 认证默认的 guard.

TokenGuard

Illuminate\Auth\TokenGuard

TokenGuard 适用于无状态 api 认证，通过 token 认证.

UserProvider 接口

Illuminate\Contracts\Auth\UserProvider

UserProvider 接口定义了获取认证模型的方法，比如根据 id 获取模型，根据 email 获取模型等等.

PHP;"> // 通过唯一标示符获取认证模型 public function retrieveById($identifier); // 通过唯一标示符和 remember token 获取模型 public function retrieveByToken($identifier,$token); // 通过给定的认证模型更新 remember token public function updateRememberToken(Authenticatable $user,$token); // 通过给定的凭证获取用户，比如 email 或用户名等等 public function retrieveByCredentials(array $credentials); // 认证给定的用户和给定的凭证是否符合 public function validateCredentials(Authenticatable $user,array $credentials);

Laravel 中默认有两个 user provider: DatabaseUserProvider & EloquentUserProvider.

DatabaseUserProvider

Illuminate\Auth\DatabaseUserProvider

直接通过数据库表来获取认证模型.

EloquentUserProvider

Illuminate\Auth\EloquentUserProvider

通过 eloquent 模型来获取认证模型

AuthManager

Illuminate\Auth\AuthManager

Guard 用来认证一个用户是否认证成功， UserProvider 用来提供认证模型的来源，而根据项目的 config 管理 guard 以及自定义 guard 等等功能，则是通过 AuthManager 来实现。

AuthManager 应该是有点像策略模式里面的 Context 类以及工厂方法里面的工厂，一方面管理 Guard，另外一方面通过 __call 魔术方法调用具体的策略(Guard)方法。

Auth facade 对应的实现类就是 AuthManager，AuthManager 在容器中注册为单例，用来管理所有的 guard、user provider 以及 guard 的代理工作。

自定义认证

根据上面的知识，可以知道要自定义一个认证很简单。

创建认证模型

创建一个自定义的认证模型，实现 Authenticatable 接口；

创建自定义的 UserProvider

创建一个自定义的 UserProvider，实现 UserProvider 接口，可以返回上面自定义的认证模型；

创建自定义的 Guard

创建一个自定义的 Guard，实现 Guard或StatefulGuard 接口

添加 guard creator 和 user provider creator 到 AuthManager 中

在 AppServiceProvider 的 boot 方法添加如下代码：

PHP;"> Auth::extend('myguard',function(){ ... return new MyGuard(); //返回自定义 guard 实例 ... });

Auth::provider('myuserprovider',function(){
return new MyUserProvider(); // 返回自定义的 user provider
});

在 config\auth.PHP的 guards 数组中添加自定义 guard，一个自定义 guard 包括两部分： driver 和 provider.

[ 'driver' => 'myguard','provider' => 'myusers',],

在 config\auth.PHP的 providers 数组中添加自定义 user provider.

[ 'driver' => 'myuserprovider' // 里面具体的字段可以根据你创建 user provider 需要的信息自由添加，可以通过 Auth::createUserProvider('myuserprovider') 创建 ],

设置 config\auth.PHP 的 defaults.guard 为 oustn.

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对编程之家的支持。