Laravel框架中Guard的底层实现分析

1. 什么是Guard

在Laravel/Lumen框架中，用户的登录/注册的认证基本都已经封装好了，开箱即用。而登录/注册认证的核心就是：

1. 用户的注册信息存入数据库（登记）
2. 从数据库中读取数据和用户输入的对比（认证）

上述两步是登录/注册的基本，可以看到都会涉及到数据库的操作，这两步框架底层已经帮我们做好了，而且考虑到了很多情况，比如用户认证的数据表不是user表而是admin_user，认证字段是phone而不是email，等等一些问题都是Guard所要解决的，通过Guard可以指定使用哪个数据表什么字段等，Guard能非常灵活的构建一套自己的认证体系。

通俗地讲，就是这样：Guard就像是小区的门卫大叔，冷酷无情，不认人只认登记信息。进小区之前大叔需要先检查你的身份，验证不通过大叔就不让你进去。如果是走路/骑车进去，大叔1需要检查你的门禁卡，他拿出记录了小区所有业主门禁卡信息的本子查看你这个门禁卡信息有没有在这个本子上；如果你开车进去，大叔2就从记录了所有业主车牌号的本子中检查你的车牌号，所以新业主要小区了需要告知门卫大叔们你的门禁卡信息或者车牌号，要不然大叔2不让你进。如果是物业管理员要进小区，门卫大叔3也只认登记信息，管理员出示他的管理员门禁卡，门卫大叔就会检查记录了管理员门禁卡信息的本子。

上面讲的对应了框架中的多用户认证：

1. 走路/骑车的人 -> 门禁卡
2. 开车的人 -> 车牌号
3. 物业管理员 -> 门禁卡

门禁卡和车牌号都是不同的认证方式，而门卫大叔查看的本子就对应了不同数据库中的用户信息，这样讲是不是更容易理解了。

Lumen/Laravel中以中间件（Middleware）的方式提供了非常灵活的认证，通过简单的配置就可以切换多个认证。

注：本文所讲的都是Lumen的代码，是Laravel精简版，内部实现原理都大差不差

本文所使用的是：Laravel 7.29

2. Guard工作流程

说了这么多，附上一张手工制作的流程图：

从图中可以看到，一个Guard会涉及到三个部分，分别是：

1. Guard实现本身
2. User Provider用户提供者，指定哪个数据表以什么方式获取（eloquent/database）
3. Authenticatable接口规定那些东西可以被认证，就是实现它的接口嘛

2. 从配置说起

深入底层代码之前，先从配置文件讲起。认证的配置主要在/config/auth.php中，里面可以定义各种认证的门卫大叔（guard）：

// /config/auth.php

'guards' => [
  'user' => [
    'driver' => 'session',
    'provider' => 'users',
   ],
  'admin' => [
    'driver' => 'token',
    'provider' => 'admin_users',
  ],
],

'providers' => [
  'users' => [
    'driver' => 'eloquent',
    'model' => App\Models\User::class,
//    'table' => 'user'
  ],
  
  'admin_users' => [
    'driver' => 'eloquent',
    'model' => App\Models\AdminUser::class,
  ],
],

配置中定义了两个门卫user和admin，driver字段设置门卫的认证系统，默认提供两种sessesion和token，provider定义的就是上面说的本子，保存所有的认证用户，provider下面的drive定义认证用户如何获取，有两种方式database和eloquent方式，一般都是用第二种，model定义eloquent方式使用的数据模型，如果driver是database，就要设置table指定数据库表。如果没有代码中没有指定用哪个门卫，就会使用默认的门卫大爷：

'defaults' => [
  'guard' => 'users',
  'passwords' => 'users',
],

3. 使用Guard例子

我们以Laravel中auth中间件例子来简单说一下：

Route::get('/user/profile', 'UserController@profile')->middleware('auth');

4. 分析

当发起/user/profile这个请求时，在进入UserController::profile方法前，会调用auth中间件，auth定义在\app\Http\Kernel.php中：

// \app\Http\Kernel.php

protected $routeMiddleware = [
  'auth' => \App\Http\Middleware\Authenticate::class,
  'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
  'bindings' => \Illuminate\Routing\Middleware\SubstituteBindings::class,
  'cache.headers' => \Illuminate\Http\Middleware\SetCacheHeaders::class,
  ...
];

对应处理脚本是\App\Http\Middleware\Authenticate::class，

// \app\Http\Middleware\Authenticate.php

/**
* Handle an incoming request.
*
* @param  \Illuminate\Http\Request  $request
* @param  \Closure  $next
* @param  string[]  ...$guards
* @return mixed
*
* @throws \Illuminate\Auth\AuthenticationException
*/
public function handle($request, Closure $next, ...$guards)
{
   
  $this->authenticate($request, $guards);

  return $next($request);
}

Laravel中中间件的处理入口都是handle方法，参数中会一数组形式传过来多个使用的guard，比如这样：

Route::get('/user/profile', 'UserController@profile')->middleware('auth:session,foo,bar');

middleware()中冒号前后分别是中间件和参数。

handle方法很简单嘛，就是调用了authenticate()：

// \Illuminate\Auth\Middleware\Authen