Laravel 中间件原理

Posted 左手代码

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Laravel 中间件原理相关的知识,希望对你有一定的参考价值。

什么是中间件

对于一个Web应用来说,在架构上中间件可以分为数据库中间件,缓存中间件等;在应用层面是指在一个请求真正处理前,我们可能会对请求做各种各样的判断,然后才可以让它继续传递到更深层次中。而如果我们用 ifelse这样子来,一旦需要判断的条件越来越来,会使得代码更加难以维护,系统间的耦合会增加,而中间件就可以解决这个问题。我们可以把这些判断独立出来做成中间件,可以很方便的过滤请求。

Laravel 中的中间件

在Laravel中,中间件的实现其实是依赖于 Illuminate\Pipeline\Pipeline这个类实现的,我们先来看看触发中间件的代码。很简单,就是处理后把请求转交给一个闭包就可以继续传递了。

 
   
   
 
  1. public function handle($request, Closure $next) {

  2.    //do something for $request

  3.    return $next($request);

  4. }

中间件源码分析

上面说道,中间件是靠 Pipeline来实现的,它的调用在 Illuminate\Routing\Router

 
   
   
 
  1. return (new Pipeline($this->container))

  2.    ->send($request)

  3.    ->through($middleware)

  4.    ->then(function ($request) use ($route) {

  5.        return $this->prepareResponse(

  6.            $request,

  7.            $route->run($request)

  8.        );

  9. });

可以看到,中间件执行过程调用了三个方法。再来看看这三个方法的代码:

 

send 方法

 
   
   
 
  1. public function send($passable){

  2.    $this->passable = $passable;

  3.    return $this;

  4. }

其实 send方法没做什么事情,就是设置了需要在中间件中流水处理的对象,在这里就是HTTP请求实例。

 

through 方法

 
   
   
 
  1. public function through($pipes){

  2.    $this->pipes = is_array($pipes) ? $pipes :func_get_args();

  3.    return $this;

  4. }

through方法也很简单,就是设置一下需要经过哪些中间件处理。then方法真正难懂的来了, then方法代码很简洁,但是要理解可不容易。

 
   
   
 
  1. public function then(Closure $destination){

  2.   //then方法接受一个闭包作为参数,然后经过getInitialSlice包装,而getInitialSlice返回的其实也是一个闭包,如果还不知道什么是闭包先去看php文档

  3.   $firstSlice = $this->getInitialSlice($destination);

  4.   //反转中间件数组,主要是利用了栈的特性,用处接下来再说

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

  6.   //这个call_user_func先不要看,它其实就是执行了一个array_reduce返回的闭包

  7.   return call_user_func(

  8.       //array_reduce来用回调函数处理数组。其实arrary_reduce什么事情都没干,就是包装闭包然后移交给call_user_func来执行

  9.       array_reduce($pipes, $this->getSlice(), $firstSlice), $this->passable

  10.   );

  11. }

然后就没有然后了,这样就过完了所有中间件,是不是很优雅?

由于 aray_reduce的第二个参数需要一个函数,我们这里重点看看 getSlice()方法的源码

 
   
   
 
  1. protected function getSlice(){

  2.    return function ($stack, $pipe) {   //这里$stack

  3.        return function ($passable) use ($stack, $pipe) {

  4.            if ($pipe instanceof Closure) {

  5.                return call_user_func($pipe, $passable, $stack);

  6.            } else {

  7.                list($name, $parameters) = $this->parsePipeString($pipe);

  8.                    return call_user_func_array([$this->container->make($name),                           $this->method],

  9.                        array_merge([$passable, $stack],

  10.                        $parameters)

  11.                    );

  12.                }

  13.            };

  14.        };

  15.    }

看到可能会很头晕,闭包返回闭包的。简化一下就是 getSlice()返回一个 函数A,而 函数A又返回了函数B。为什么要返回两个函数呢?因为我们中间在传递过程中是用 $next($request)来传递对象的,而 $next($request)这样的写法就表示是执行了这个闭包,这个闭包就是 函数A,然后返回 函数B,可以给下一个中间件继续传递。

再来简化一下代码就是:

 
   
   
 
  1. //这里的$stack其实就是闭包,第一次遍历的时候会传入$firstSlice这个闭包,以后每次都会传入下面的那个function; 而$pipe就是每一个中间件

  2. array_reduce($pipes, function ($stack, $pipe) {

  3.    return function ($passable) use ($stack, $pipe) {

  4.    };

  5. }, $firstSlice);

再来看这一段代码:

 
   
   
 
  1. //判断是否为闭包,这里就是判断中间件形式是不是闭包,是的话直接执行并且传入$passable[请求实例]和$stack[传递给下一个中间件的闭包],并且返回

  2. if ($pipe instanceof Closure) {

  3.   return call_user_func($pipe, $passable, $stack);

  4. //不是闭包的时候就是形如这样Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode执行

  5. }  else {

  6.   //解析,把名称返回,这个$parameters看了许久源码还是看不懂,应该是和参数相关,不过不影响我们的分析

  7.   list($name, $parameters) = $this->parsePipeString($pipe);

  8.   //从容器中解析出中间件实例并且执行handle方法

  9.    return call_user_func_array([$this->container->make($name),$this->method],

  10.        //$passable就是请求实例,而$stack就是传递的闭包

  11.        array_merge([$passable, $stack], $parameters)

  12.    );

  13. }

再看一张图片:每一次迭代传入上一次的闭包和需要执行的中间件,由于反转了数组,基于栈先进后出的特性,所以中间件3第一个被包装,中间件1就在最外层了。要记得, arrary_reduce他不执行中间件代码,而是包装中间件。 看到这里应该明白了, array_reduce最后会返回 func3,那么 call_user_func(func3,$this->passable)实际就是

 
   
   
 
  1. return call_user_func($middleware[0]->handle, $this->passable, func2);

而我们的中间件中的 handle代码是:

 
   
   
 
  1. public function handle($request, Closure $next) {

  2.    return $next($request);

  3. }

这里就相当于 returnfunc2($request),这里的 $request就是经过上一个中间件处理过的。所以正果中间件的过程就完了,理解起来会有点绕,只要记得最后是由最外面的 call_user_func来执行中间件代码的.


以上是关于Laravel 中间件原理的主要内容,如果未能解决你的问题,请参考以下文章

laravel特殊功能代码片段集合

需要一种有效的方法来避免使用 Laravel 5 重复代码片段

Laravel:如何在控制器的几种方法中重用代码片段

Redux中间件原理

Laravel 接收非简单请求出现的 OPTIONS 请求问题

深入理解PHP原理之Opcodes