美高梅游戏平台网站laravel5.3 源码分析 Passport

来源:http://www.sh-fengwen.com 作者:鲜果干果 人气:177 发布时间:2019-09-06
摘要:laravel5.3,密码模式的授权认证过程。我会通过两部分内容分享以及查看passport的认证流程分享出来 电子游戏美高梅网址,laravel中间件源码分析 在laravel5.2中,HTTP中间件为过滤访问你的

laravel5.3,密码模式的授权认证过程。我会通过两部分内容分享以及查看passport的认证流程分享出来

电子游戏美高梅网址,laravel中间件源码分析

在laravel5.2中,HTTP 中间件为过滤访问你的应用的 HTTP 请求提供了一个方便的机制。在处理逻辑之前,会通过中间件,且只有通过了中间件才会继续执行逻辑代码。它的主要作用就是过滤Http请求(php aritsan是没有中间件机制的),同时也让系统的层次(Http过滤层)更明确,使用起来也很优雅。但实现中间件的代码却很复杂,接下来就分析下有关中间件的源码(讨论是在laravel5.2上展开的)。

第一部分:根据官方文档,通过Composer安装Passport

中间件源码

中间件本身分为两种,一种是所有http的,另一种则是针对route的。一个有中间件的请求周期是:Request得先经过Http中间件,才能进行Router,再经过Requset所对应Route的Route中间件, 最后才会进入相应的Controller代码。laravel把请求分为了两种:http和console。不同的请求方式用它自己的Kernel来驱动Application。Http请求则是通过
IlluminateFoundationHttpKernel类来驱动,它定义了所有的中间件,其父类IlluminateFoundationHttpKernel::handle就是对请求进行处理的入口了

文档地址:

Http中间件

跟踪入口handle()方法,很容易发现该函数(IlluminateFoundationHttpKernel::sendRequestThroughRouter):

protected function sendRequestThroughRouter($request)
{
    $this->app->instance('request', $request);

    Facade::clearResolvedInstance('request');

    $this->bootstrap();

    return (new Pipeline($this->app))
                ->send($request)
                ->through($this->app->shouldSkipMiddleware() ? [] : $this->middleware)
                ->then($this->dispatchToRouter());
}

该函数会把Requset分发到Router(通过方法名就知道了), 主要的逻辑则是通过IlluminateRoutingPipeline美高梅游戏平台网站,完成的, 作用就是让Requset通过Http中间件的检测,然后再到达Router。这里的代码看起来很优雅,但不是很好理解。所以,了解Pipeline的运行机制就会明白中间件的使用。

第二部分 认证流程

Pipeline的运行实现

Pipleline基类是IlluminatePipelinePipeline,它的执行在then方法:

public function then(Closure $destination)
{
    $firstSlice = $this->getInitialSlice($destination);

    $pipes = array_reverse($this->pipes);

    return call_user_func(
        array_reduce($pipes, $this->getSlice(), $firstSlice), $this->passable
    );
}

了解这段代码执行的意图,必须要知道array_reduce()做了什么。 为了清楚array_reduce怎么运行的,先把array_reduce重写一次:

//将数组中的元素,依次执行$func函数,且上一次的$func的返回值作为下一次调用$func的第一个参数输入
function array_reduce_back($arr, callable $func, $firstResult = null)
{
    $result = $firstResult;

    foreach ($arr as $v) {
        $result = $func($result, $v);
    }

    return $result;
}

所以,源代码中的$funcgetSlice(),它返回的是一个回调函数:function($passable) use ($stack, $pipe){...}$stack$pipe被输入的具体值代替),也就是说作为上一次返回结果输入到下一次$func的第一个参数是上述的回调函数,如此循环,当数组遍历完成,array_reduce就返回的是一个回调函数,现在关键就是了解这个回调函数是什么样子,又如何执行?为方便讨论,可分析下面的代码:

call_user_func(
        array_reduce([1, 2, 3], $this->getSlice(), $firstSlice), $this->passable
    );

美高梅游戏平台网站 1

执行说明:
1.$result_0是初始化的值 ,为$firstSlice ,即是IlluminatePipelinePipeline::getInitialSlice的返回回调
2.每遍历一个元素,都会执行IlluminatePipelinePipeline::getSlice的回调,同时也会返回一个回调
3.$result中的具体执行代码都在getSlice()
4.最后的array_reduce返回结果是$result_3,是一个有多层闭包的回调函数
5.执行的是call_user_func($result_3, $this->passable),即执行function($this->passable) use ($result_2, 3){...}


至此已经清楚了then()是如何运行的了,要继续下去,则需再搞定回调函数到底怎么执行的.现在再跟着sendRequestThroughRouter中的Pipeline走,看它是如何执行的。

// 把具体的参数带进来
return (new Pipeline($this->app))
                ->send($request)
                ->through(['IlluminateFoundationHttpMiddlewareCheckForMaintenanceMode'])
                ->then($this->dispatchToRouter());

用上面的所分析的Pipeline执行过程,很快就会分析出最后执行的是

function($requset) use (IlluminateFoundationHttpKernel::dispatchToRouter(), 'IlluminateFoundationHttpMiddlewareCheckForMaintenanceMode') {

            if ($pipe instanceof Closure) {
                return call_user_func($pipe, $passable, $stack);
            }

            // $name和$parameters很容易得到
            // $name = 'IlluminateFoundationHttpMiddlewareCheckForMaintenanceMode';
            // $parameters = [];
            list($name, $parameters) = $this->parsePipeString($pipe);


            // 执行的就是IlluminateFoundationHttpMiddlewareCheckForMaintenanceMode::handle($request, IlluminateFoundationHttpKernel::dispatchToRouter())
            return call_user_func_array([$this->container->make($name), $this->method],
                        array_merge([$passable, $stack], $parameters));
}

逻辑处理已经到了IlluminateFoundationHttpMiddlewareCheckForMaintenanceMode::handle,其代码是:

public function handle($request, Closure $next)
{
    if ($this->app->isDownForMaintenance()) {
        throw new HttpException(503);
    }

    return $next($request);
}

这里,它处理了这个中间件所需要过滤的条件,同时执行了$next($request),即IlluminateFoundationHttpKernel::dispatchToRouter(), 这样,就把Request转到了Router中,也就完成了Http中间件的所有处理工作,而$next($request)是每个中间件都不可少的操作,因为在回调中嵌套了回调,就是靠中间件把Request传递到下一个回调中,也就会解析到下一个中间件,直到最后一个。紧跟上面的已分析的Pipeline执行过程,讲其补充完整:

6.执行$result_3中的回调,getSlice实例化中间件,执行其handle,在中间件处理中执行回调

7.回调中还嵌套回调的,每个中间件中都需有执行回调的代码$next($request) ,才能保证回调中的回调会执行,执行的顺序就是3::handel,2::handel,1::handel,$first

8.最里面一层,一定是传递给then()的参数,then执行的就是最后一步

9.执行的顺序是由数组中的最后一个,向前,到then()的参数,为了使其执行顺序是数组中的第一个到最后一个,再到then()中的参数,then()方法中就做了一个反转array_reverse


认证流程,我主要从两方面入手

Pipeline小结

现在,Pipeline的所有执行流程就都分析完了。实现代码真的很绕,但理解之后编写自定义的中间件应该就很容易了。现在再把Pipeline的使用翻译成汉语,应该是这样的

// 使用管道,发送$request,使之通过middleware ,再到$func
(new Pipeline($this->app))->send($request)->through($this->middleware)->then($func);

这样的代码不管是从语义上,还是使用上都很优雅,高!确实是高!再回到源码,Requset的流程就通过dispatchToRouter进入到了Router

首先是添加这个Passport包,在config/app.php中的providers数组中添加的LaravelPassportPassportServiceProvider::class服务,具体注册了哪些服务

Route中间件

在Router中,IlluminateRoutingRouter::dispatch就承接了来自Http中间件的Requset, Router把Request分发到了具体的Route,再进行处理,主要代码如下:

public function dispatchToRoute(Request $request)
{
    // 找到具体的路由对象,过程略
    $route = $this->findRoute($request);

    $request->setRouteResolver(function () use ($route) {
        return $route;
    });

    // 执行Request匹配到Route的事件,具体的代码在这里:IlluminateFoundationProvidersFoundationServiceProvider::configureFormRequests
    $this->events->fire(new EventsRouteMatched($route, $request));

    // 这里就运行路由中间件了
    $response = $this->runRouteWithinStack($route, $request);

    return $this->prepareResponse($request, $response);
}


protected function runRouteWithinStack(Route $route, Request $request)
{
    // 获取该路由上的中间件
    // 简单就点可这样写:
    // $middleware = App::shouldSkipMiddleware() ? [] : $this->gatherRouteMiddlewares($route);
    $shouldSkipMiddleware = $this->container->bound('middleware.disable') &&
                         $this->container->make('middleware.disable') === true;

    $middleware = $shouldSkipMiddleware ? [] : $this->gatherRouteMiddlewares($route);

    // 了解Pipeline后,这里就好理解了,应该是通过管道,发送$request,经过$middleware,再到then中的回调
    return (new Pipeline($this->container))
                    ->send($request)
                    ->through($middleware)
                    ->then(function ($request) use ($route) {
                        return $this->prepareResponse(
                            $request,
                            $route->run($request)
                        );
                    });
}

如何获取Route中间件的,就可以跟gatherRouteMiddlewares,这个代码并不难,很好跟。接下来,Request就到到达至于Controller, Request是如何到达Controller的代码就不难了,这里就不说了

然后根据认证路由,从请求路由开始,到最终实现,跟进代码阅读路程

Controller后执行中间件

成功获取Response后,在public/index.php58行执行了$kernel->terminate($request, $response);, 也就是在主要逻辑处理完成之后,再执行此代码,它实际上调用是的IlluminateFoundationHttpKernel::terminate, 跟进去就很容易发现,它处理了这此请求所涉及到的中间件,并执行了各自的terminate方法,到这里,中间件的另一个功能就展现出来了,就是主要逻辑完成之后的收尾工作.到这里为止,中间件就完成了它的使命(一个请求也就完成了).


1. Passport服务提供者:

如何使用中间件

在官方文档上讲解的很清楚注册中间件


使用这个Passport服务之前,首先需要了解服务提供者的作用,按照文档的介绍,服务提供者是整个应用的启动中心,主要是通过register方法注册一些实例到容器中,在config/app.php的providers数组中,添加

中间件小结

至此,中间件的实现逻辑与使用就清晰了.从执行的顺序来分,一个在Controller之前,一个在Controller之后,所以它一个很重要的作用就是可以让Controller专注于自己的主要逻辑的职责更明确. 奇怪的是,但前后两种中间件的执行方式却不一样, IlluminateFoundationHttpKernel::terminate,中间件的结束却没有使用Pipeline, 而是直接foreach.相同的工作却用两种代码来实现.现在看来,中间件本身并不复杂,但它带给了我两个启发,1.层次明确 2,Pipeline所带来的优雅.

下面是我学习过程中的一些资源

美高梅游戏平台网站 2在这个PassportServiceProvider类中,注册需要用的实例到容器中

此服务需要注册的事物,

美高梅游戏平台网站 3分别注册认证服务,资源服务,令牌

分别先看下这些方法都注册了哪些内容

美高梅游戏平台网站 4定义一个AuthorizationServer::class的实现

在这个实现中,跟进tap的方法是将第一个参数作为第二个回调函数的参数的参数,最后返回该回调函数的值

美高梅游戏平台网站 5

tap函数的第一个参数是$this->makeAuthorizationServer()调用的返回值

美高梅游戏平台网站 6返回一个认证服务类的实例

这个$this->app就是容器的实例,make方法就是通过传进来的接口类,得到此接口的实现类的对象。在AuthorizationServer类的构造函数中,赋值给类中的成员变量

美高梅游戏平台网站 7

回到tap方法,将得到的这个认证服务实例传到这个回调函数中

美高梅游戏平台网站 8这个$server就是第一个参数返回的认证服务AuthorizationServer类的对象

调用AuthorizationServer类中的enableGrantType方法,这个方法中我的理解就是启动各个oauth授权方式,实例化各个授权方式的类,传到这个方法中,将在实例化AuthorizationServer类的时候,赋值的那些成员变量的值,再赋值给这里的每项授权方式对象中,如图

美高梅游戏平台网站 9$grantType就是相应的授权方式的类

最后在将各个授权方式的对象,保存在enabledGrantTypes数组中,其中key就是每个对象内部的getIdentifier()方法返回的字符串。

到此,就是Passport服务提供者,注册的第一部分内容了,即认证服务相关内容

  1. 查看路由的执行过程

美高梅游戏平台网站 10

这个时候就用到了在安装Passport配置的路由项了

美高梅游戏平台网站 11在文档中可以找到此配置项

那么就看下这个routes()静态方法是如何实现的

美高梅游戏平台网站 12

这段代码,实际上就是执行了RouteRegisterar类中的all()方法

美高梅游戏平台网站 13跟进各个方法,发现都是一些路由

我用到的密码模式的路由在这个forAccessTokens()方法中

美高梅游戏平台网站 14

现在找到了路由,接下来就可以到相应的控制器中看,具体如何实现认证过程

  1. 认证过程

本文由美高梅游戏平台网站发布于鲜果干果,转载请注明出处:美高梅游戏平台网站laravel5.3 源码分析 Passport

关键词:

最火资讯