laravel5.5源码笔记（五、Pipeline管道模式）

Pipeline管道模式，也有人叫它装饰模式。应该说管道是装饰模式的一个变种，虽然思想都是一样的，但这个是闭包的版本，实现方式与传统装饰模式也不太一样。在laravel的源码中算是一个比较核心的设计模式了。
管道模式，或者说装饰模式的思想，就是在不改变原有程序的基础上，可以方便的在已有程序上添加新的功能。

在说管道模式之前让我们看一下array_reduce这个函数

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

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

array
输入的 array。

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

        item
        携带了本次迭代的值。

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

以上是php官网对这个函数的解释，看的一头雾水对不对？没关系，我们先来一个demo

//首先我们有一个数组
$a = array(1, 2, 3, 4, 5);
$x = array();

//我们输出了array_reduce的结果为15，这个函数传递了两个参数，第一个就是上面的数组a,我们重点来看第二个闭包函数
var_dump(array_reduce($a, "sum")); // int(15)

//array_reduce的第三个参数会在循环开始的时候当做闭包函数的第一个carry值传入
var_dump(array_reduce($a, "product", 10)); // int(1200), because: 10*1*2*3*4*5

//当array_reduce处理结束后，若结果为空，也会将第三个参数返回
var_dump(array_reduce($x, "sum", "No data to reduce")); // string(17) "No data to reduce"

//这个闭包函数接收了两个参数
function sum($carry, $item)
{
    echo 'before___carry:'.$carry.'<br><br>';
    echo 'before___item:'.$item.'<br><br>';

    //这个函数只是简单的对两个参数做了加法
    $carry += $item;

    echo 'after___carry:'.$carry.'<br><br>';
    echo '<br><br>';
    return $carry;
}

function product($carry, $item)
{
    echo 'before___carry:'.$carry.'<br><br>';
    echo 'before___item:'.$item.'<br><br>';

    $carry *= $item;

    echo 'after___carry:'.$carry.'<br><br>';
    echo '<br><br>';
    return $carry;
}

大家在运行过这个demo之后，便会发现，array_reduce只是一个循环函数。但是，它和foreach不一样的地方在于，它的闭包处理函数所接收的两个参数。其中的$item参数会在每次循环的时候代入数组的各项值，而$carry就比较专一了，它只接收上一次循环中自己的返回值。不过专一也只是相对的，$carray还接收array_reduce传入的第三个参数作为闭包开始循环前$carray的默认值，或是循环结束后返回值为null时的默认值。我在代码中已经把变量各时期的值给打印出来了，相信大家一看就会明白。这个函数最典型的例子就是在做累计运算的时候，我们不需要向foreach循环那样创建一个变量了。（大家都知道给变量起名字是一件很麻烦的事情）

ok，函数介绍完了，可是这和管道模式又有什么关系呢？不知道大家注意到没有，在array_reduce的闭包函数进行循环的时候，array_reduce的第三个参数从闭包的$array进入，从return返回，紧接着再次从$array中进入，而每次循环的时候，都会从$item中获取到外部进行运算。这个过程是不是很像数据在一个螺旋管道中流通，同时不断的向其中添加新的操作，并且没有改变原先的程序代码，降低了程序间的耦合度。

接下来进行管道模式

请求处理管道的思维导图

思维导图看的还不够清晰？ok，接着举例子，看demo

从图中我们可以知道类Request都具有相同的接口，那么我们可以约定一个接口规范

interface RequestInterface
{
    // 我们之前讲过装饰者模式，这里是通过闭包函数实现
    // 通过之后实现类及调用就可以看出
    public static function handle(Closure $next);
}

接口有了那么我们就遵循接口开始实现

class Request1 implements RequestInterface
{
    public static function handle(Closure $next)
    {
        echo "Request1 Begin." . "<br />";
        $next();
        echo "Request1 End." . "<br />";
    }
}

class Request2 implements RequestInterface
{
    public static function handle(Closure $next)
    {
        echo "Request2 Begin." . "<br />";
        $next();
        echo "Request2 End." . "<br />";
    }
}

class Request3 implements RequestInterface
{
    public static function handle(Closure $next)
    {
        echo "Request3 Begin." . "<br />";
        $next();
        echo "Request3 End." . "<br />";
    }
}

class Request4 implements RequestInterface
{
    public static function handle(Closure $next)
    {
        echo "Request4 Begin." . "<br />";
        $next();
        echo "Request4 End." . "<br />";
    }
}

四种请求处理过程我们均已实现，为了简化都是打印一句话，可以在浏览器上直观显示流程；
我们还需要一个客户端来发出请求

class Client
{
    // 这里包含了所有的请求
    private $pipes = [
        'Request1',
        'Request2',
        'Request3',
        'Request4',
    ];

    // 这里就是思维导图中默认返回的匿名回调函数
    private function defaultClosure()
    {
        return function () {
            echo '请求处理中...' . "<br />";
        };
    }

    // 这里就是整个请求处理管道的关键
    private function getSlice()
    {
        return function ($stack, $pipe)
        {
            return function () use ($stack, $pipe)
            {
                return $pipe::handle($stack);
            };
        };
    }

    // 这里是负责发起请求处理
    public function then()
    {
        call_user_func(array_reduce($this->pipes, $this->getSlice(), $this->defaultClosure()));
    }
}

当我们调用时：

$worker = new Client();
$worker->then();

浏览器就会显示：

那么我来解释一下整个流程吧，在代码注释说了getSlice是关键，那么我们来解读一下代码

解析代码

client的then方法，call_user_func是执行一个函数的api，它的参数是一个闭包函数。而这个参数则是我们文章一开始提到的array_reduce这个循环的最终返回值。

我们都还记得这个函数一共有三个参数：

第一个参数代表从外界加入到管道中的附加操作

第二个参数则是执行加工的工厂

第三个参数则是进入管道的程序数据源

先看第三个参数数据源

    // 这里就是思维导图中默认返回的匿名回调函数
    private function defaultClosure()
    {
        //这个return出去的闭包就是我们的数据源
        return function () {
            echo '请求处理中...' . "<br />";
        };
    }

 然后对程序进行装饰的装饰品数组

// 这里包含了所有的请求
    private $pipes = [
        'Request1',
        'Request2',
        'Request3',
        'Request4',
    ];

这里虽然只是个数组，但它在刚刚的循环闭包中被当做对象名来使用，通过名称调度不同的类

然后是循环闭包

    // 这里就是整个请求处理管道的关键
    private function getSlice()
    {
        //这个函数我们的闭包循环函数
        return function ($stack, $pipe)
        {
            //而这里便是我们最开始例子中的return返回值，只不过刚开始的时候我们返回的是一个数字变量，这里变成了另一个闭包
            return function () use ($stack, $pipe)
            {
                return $pipe::handle($stack);
            };
        };
    }

这里的循环闭包返回值也是一个闭包，在不断的循环中，闭包函数就像洋葱一样，一层一层不断包裹。

如此类推，最终array_reduce返回一个匿名函数，这就像上面思维导图最终所描述的一样

function (){
    return Request4::handle(function (){
        return Request3::handle(function (){
            return Request2::handle(function (){
                return Reuqest1::handle(function (){
                    echo '请求处理中...' . "<br />";
                });
            });
        });
    });
}

所以当调用call_user_func时就是执行array_reduce返回的匿名函数，我们从各个请求处理类的handle方法也得知，会直接调用传入的匿名函数，注意顺序即可理解浏览器的输出。

与装饰者模式的关系

这里没有用到类来对实例对象进行包装，而是通过闭包函数完成，每一次处理在上一次处理之上进行包装，最后获得响应，就像流水线一样，一个请求进来通过一道道工序加工（包装）最后生成响应。

理解了这几个demo，那么laravel里中间件最重点的部分你就已经理解了。

最后，本文内容并非全部原创，部分图片与代码来源：http://blog.chenjunwu.cn/2017/05/02/Request-pipeline