Laravel 管道流原理

Laravel 管道流原理

  1. Laravel 🐛
  2. 6 years ago
  3. 10 min read

Laravel管道流原理强烈依赖array_reduce函数，我们先来了解下array_reduce函数的使用。

array_reduce

array_reduce() 将回调函数 callback 迭代地作用到 array 数组中的每一个单元中，从而将数组简化为单一的值。

mixed array_reduce ( array $array , callable $callback [, mixed $initial = NULL ] )
  1. array

输入的 array。

  1. callback

mixed callback ( mixed $carry , mixed $item ) $carry包括上次迭代的值，如果本次迭代是第一次，那么这个值是 initial，item 携带了本次迭代的值

  1. initial

如果指定了可选参数 initial，该参数将在处理开始前使用，或者当处理结束，数组为空时的最后一个结果。

从文档说明可以看出，array_reduce函数是把数组的每一项，都通过给定的callback函数，来简化的。

那我们就来看看是怎么简化的。

$arr = ['AAAA', 'BBBB', 'CCCC'];

$res = array_reduce($arr, function($carry, $item){
    return $carry . $item;
});

给定的数组长度为3，故总迭代三次。

  1. 第一次迭代时 $carry = null $item = AAAA 返回AAAA
  2. 第一次迭代时 $carry = AAAA $item = BBBB 返回AAAABBBB
  3. 第一次迭代时 $carry = AAAABBBB $item = CCCC 返回AAAABBBBCCCC

这种方式将数组简化为一串字符串AAAABBBBCCCC

带初始值的情况

$arr = ['AAAA', 'BBBB', 'CCCC'];

$res = array_reduce($arr, function($carry, $item){
    return $carry . $item;
}, 'INITIAL-');
  1. 第一次迭代时（$carry = INITIAL-），（$item = AAAA） 返回INITIAL-AAAA
  2. 第一次迭代时（$carry = INITIAL-AAAA），（$item = BBBB）， 返回INITIAL-AAAABBBB
  3. 第一次迭代时（$carry = INITIAL-AAAABBBB），（$item = CCCC），返回INITIAL-AAAABBBBCCCC

这种方式将数组简化为一串字符串INITIAL-AAAABBBBCCCC

闭包

$arr = ['AAAA', 'BBBB', 'CCCC'];

//没带初始值
$res = array_reduce($arr, function($carry, $item){
    return function() use ($item){//这里只use了item
        return strtolower($item) . '-';
    };
});
  1. 第一次迭代时，$carry：null，$item = AAAA，返回一个use了$item = AAAA的闭包
  2. 第二次迭代时，$carry：use了$item = AAAA的闭包，$item = BBBB，返回一个use了$item = BBBB的闭包
  3. 第一次迭代时，$carry：use了$item = BBBB的闭包，$item = CCCC，返回一个use了$item = CCCC的闭包

这种方式将数组简化为一个闭包，即最后返回的闭包，当我们执行这个闭包时$res()得到返回值CCCC-

上面这种方式只use ($item)，每次迭代返回的闭包在下次迭代时，我们都没有用起来。只是又重新返回了一个use了当前item值的闭包。

闭包USE闭包

$arr = ['AAAA'];

$res = array_reduce($arr, function($carry, $item){
    return function () use ($carry, $item) {
        if (is_null($carry)) {
            return 'Carry IS NULL' . $item;
        }
    };
});

注意，此时的数组长度为1，并且没有指定初始值

由于数组长度为1，故只迭代一次，返回一个闭包 use（$carry = null, $item = 'AAAA'），当我们执行（$res()）这个闭包时，得到的结果为Carry IS NULLAAAA。

接下来我们重新改造下，

$arr = ['AAAA', 'BBBB'];

$res = array_reduce($arr, function($carry, $item){
    return function () use ($carry, $item) {
        if (is_null($carry)) {
            return 'Carry IS NULL' . $item;
        }
        if ($carry instanceof \Closure) {
            return $carry() . $item;
        }
    };
});

我们新增了一个条件判断，若当前迭代的值是一个闭包，返回该闭包的执行结果。

第一次迭代时，$carry的值为null，$item的值为AAAA，返回一个闭包，

//伪代码
function () use ($carry = null, $item = AAAA) {
    if (is_null($carry)) {
        return 'Carry IS NULL' . $item;
    }
    if ($carry instanceof \Closure) {
        return $carry() . $item;
    }
}

假设我们直接执行该闭包，将会返回Carry IS NULLAAAA的结果。

第二次迭代时，$carry的值为上述返回的闭包（伪代码），$item的值为BBBB，返回一个闭包，

当我们执行这个闭包时，满足$carry instanceof \Closure，得到结果Carry IS NULLAAAABBBB。

Laravel中的array_reverse

大致了解了array_reverse函数的使用后，我们来瞅瞅laravel管道流里使用array_reverse的情况。

我在Laravel中间件原理中有阐述，强烈建议先去看看Laravel中间件原理再回过头来接着看。

php内置方法array_reduce把所有要通过的中间件都通过callback方法并压缩为一个Closure。最后在执行Initial

Laravel中通过全局中间件的核心代码如下：

//Illuminate\Foundation\Http\Kernel.php
protected function sendRequestThroughRouter($request)
{
    return (new Pipeline($this->app))
        ->send($request)
        ->through($this->app->shouldSkipMiddleware() ? [] : $this->middleware)
        ->then($this->dispatchToRouter());
}
protected function dispatchToRouter()
{
    return function ($request) {
        $this->app->instance('request', $request);
        return $this->router->dispatch($request);
    };
}

正如我前面说的,我们发送一个$request对象通过middleware中间件数组，最后在执行dispatchToRouter方法。

假设有两个全局中间件，我们来看看这两个中间件是如何通过管道压缩为一个Closure的。

Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode::class,
App\Http\Middleware\AllowOrigin::class,//自定义中间件

Illuminate\Pipeline\Pipeline为laravel的管道流核心类.

在Illuminate\Pipeline\Pipeline的then方法中，$destination为上述的dispatchToRouter闭包，pipes为要通过的中间件数组，passable为Request对象。

public function then(Closure $destination)
{
    $pipeline = array_reduce(
        array_reverse($this->pipes), $this->carry(), $this->prepareDestination($destination)
    );
    return $pipeline($this->passable);
}

array_reverse函数将中间件数组的每一项都通过$this->carry()，初始值为上述dispatchToRouter方法返回的闭包。

protected function prepareDestination(Closure $destination)
{
    return function ($passable) use ($destination) {
        return $destination($passable);
    };
}
protected function carry()
{
    return function ($stack, $pipe) {
        return function ($passable) use ($stack, $pipe) {
            if ($pipe instanceof Closure) {
                return $pipe($passable, $stack);
            } elseif (! is_object($pipe)) {
                //解析中间件参数
                list($name, $parameters) = $this->parsePipeString($pipe);
                $pipe = $this->getContainer()->make($name);
                $parameters = array_merge([$passable, $stack], $parameters);
            } else {
                $parameters = [$passable, $stack];
            }
            return $pipe->{$this->method}(...$parameters);
        };
    };
}

第一次迭代时，返回一个闭包，use了$stack和$pipe，$stack的值为初始值闭包，$pipe为中间件类名，此处是App\Http\Middleware\AllowOrigin::class(注意array_reverse函数把传进来的中间件数组倒叙了)。

假设我们直接运行该闭包，由于此时$pipe是一个String类型的中间件类名，只满足! is_object($pipe)这个条件，我们将直接从容器中make一个该中间件的实列出来，在执行该中间件实列的handle方法（默认$this->method为handle）。并且将request对象和初始值作为参数，传给这个中间件。

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

在这个中间件的handle方法中，当我们直接执行return $next($request)时，相当于我们开始执行array_reduce函数的初始值闭包了，即上述的dispatchToRouter方法返回的闭包。

protected function dispatchToRouter()
{
    return function ($request) {
        $this->app->instance('request', $request);
        return $this->router->dispatch($request);
    };
}

好，假设结束。在第二次迭代时，也返回一个use了$stack和$pipe，$stack的值为我们第一次迭代时返回的闭包，$pipe为中间件类名，此处是Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode::class。

两次迭代结束，回到then方法中，我们手动执行了第二次迭代返回的闭包。

return $pipeline($this->passable);

当执行第二次迭代返回的闭包时，当前闭包use的$pipe为Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode::class，同样只满足! is_object($pipe)这个条件，我们将会从容器中make出CheckForMaintenanceMode中间件的实列，在执行该实列的handle方法，并且把第一次迭代返回的闭包作为参数传到handle方法中。

当我们在CheckForMaintenanceMode中间件的handle方法中执行return $next($request)时，此时的$next为我们第一次迭代返回的闭包，将回到我们刚才假设的流程那样。从容器中make一个App\Http\Middleware\AllowOrigin实列，在执行该实列的handle方法，并把初始值闭包作为参数传到AllowOrigin中间件的handle方法中。当我们再在AllowOrigin中间件中执行return $next($request)时，代表我们所有中间件都通过完成了，接下来开始执行dispatchToRouter。

  1. 中间件是区分先后顺序的，从这里你应该能明白为什么要把中间件用array_reverse倒叙了。
  2. 并不是所有中间件在运行前都已经实例化了的，用到的时候才去想容器取
  3. 中间件不执行$next($request)后续所有中间件无法执行。

这篇文章是专们为了上一篇Laravel中间件原理写的，因为在写Laravel中间件原理时我也不很清楚array_reduce在laravel中的运行流程。如果有什么不对的，欢迎指正。

laravel