Laravel-tap

发表于 | 更新于 | 分类于
本文字数： 8.1k | 阅读时长 ≈ 7 分钟

思考并回答以下问题：

  • tap()的实现，不再需要临时变量。怎么理解？

在本文，我们将讨论Laravel中的tap。我们将详细讨论tap帮助函数和collection中的tap方法。

Tap帮助函数

旧的实现方式

Laravel5.3提出了一个tap函数。这是一个非常奇怪的函数，受Ruby的启发，允许你去tap成链。这是tap助手函数的基本实现。

1
2
3
4
5
6
function tap($value, $callback)
{
    $callback($value);

    return $value;
}

需要传一个值和一个回调到方法中，值作为回调的参数，回调将执行，最后值被返回。让我们看看我们如何以有意义的方式使用它。例如：

1
2
3
4
5
6
7
8
<?php

$photo = App\Photo::find(1);

return tap($photo, function($photo) {
    $photo->validated = true;
    $photo->save();
});

在上面的例子中，我们传递一个参数（Photo模型）和一个回调函数，该函数简单地将validated设置为true并保存模型。这个函数然后将Photo模型实例返回给调用者。

新的实现方式

在最新版本中，更高级的tap来了。它引入了更短的使用方式。这里是tap函数的新实现。

1
2
3
4
5
6
7
8
9
10
function tap($value, $callback = null)
{
    if (is_null($callback)) {
        return new HigherOrderTapProxy($value);
    }

    $callback($value);

    return $value;
}

回调函数现在是可选的。你还可以链式使用参数中的多个方法，这里其实也就是PhotoModel中支持的方法。例如：

1
2
3
4
5
6
7
<?php

$photo = App\Photo::find(1);

return tap($photo)->update([
    'validated' => 'true',
])

我们能够将任何模型的方法通过tap链式调用。此更新方法通常返回true或false，但是这里使用了tap函数。在这种情况下，它将返回Photo模型。tap可以帮助你返回作为参数传递的对象。

它是如何工作的

tap是一个非常有用的功能，但有时它很难理解它是如何工作的。这里来解释它是如何工作的。

如果没有给出回调函数，因为它是可选的，Laravel将返回HigherOrderTapProxy的新实例。在HigherOrderTapProxy类中定义了调用魔术方法。调用魔术方法是由语言动态调用的（所谓的方法在类中没有定义）。因为除了调用魔术方法，HigherOrderTapProxy类中没有定义方法，所以每次使用tap函数任何方法调用时都会调用它。在调用魔术方法中，我们的更新方法或任何我们调用的方法将被参数调用，并且它将返回我们最初传递给tap函数的参数。

Illuminate/Support/HigherOrderTapProxy.php

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
<?php

namespace Illuminate\Support;

class HigherOrderTapProxy
{
    /**
     * The target being tapped.
     *
     * @var mixed
     */
    public $target;

    /**
     * Create a new tap proxy instance.
     *
     * @param  mixed  $target
     * @return void
     */
    public function __construct($target)
    {
        $this->target = $target;
    }

    /**
     * Dynamically pass method calls to the target.
     *
     * @param  string  $method
     * @param  array  $parameters
     * @return mixed
     */
    public function __call($method, $parameters)
    {
        $this->target->{$method}(...$parameters);

        return $this->target;
    }
}

在上面的代码中，target属性是我们在tap中传递的参数。

Laravel collection中的tap方法

Laravel还在collection类中有一个tap方法，可让你在特定的地方传入参数到tap中，并对这些结果进行处理。tap不会影响主要collection的结果。这对调试代码和查找在处理集合时出现错误的地方很有帮助。我们用一个例子来解释这个方法。初始化以下数组。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
$photos = [
    [
        'file_name' => 'wallpaper', 
        'validated' => true, 
        'extension' => 'jpg'
    ],
    [
        'file_name' => 'spring', 
        'validated' => true, 
        'extension' => 'png'
    ],
    [
        'file_name' => 'flowers', 
        'validated' => false, 
        'extension' => 'jpg'
    ],
    [
        'file_name' => 'mac', 
        'validated' => true, 
        'extension' => 'png'
    ],
    [
        'file_name' => 'books', 
        'validated' => false, 
        'extension' => 'jpg'
    ],
    [
        'file_name' => 'mobiles', 
        'validated' => false, 
        'extension' => 'jpg'
    ],
    [
        'file_name' => 'glass', 
        'validated' => false, 
        'extension' => 'png'
    ],
    [
        'file_name' => 'fruit', 
        'validated' => true, 
        'extension' => 'jpg'
    ],
];

现在让我们尝试在这个数组上使用tap方法。首先，我们必须将这个数组转换为一个集合，然后在特定点处tap这个集合。

1
2
3
4
5
6
return collect($photos)
    ->where('validated', true)
    ->tap(function ($validated) {
        return var_dump($validated->pluck('file_name'));
    });
});

上面的代码将会输出以下结果：

1
2
3
4
wallpaper
spring
mac
fruit

tap VS Pipe（管道）

在Laravel中，也有类似的方法叫管道。它们在某种意义上是相似的，因为它们都在集合管道中使用。tap和pipe之间有一个区别。tap允许你使用数据，但不会修改原始返回值。另一方面，pipe根据返回值修改数据。例如：

1
2
3
4
5
6
return collect($photos)
    ->where('validated', true)
    ->pipe(function ($validated) {
        return $validated->where('extension', 'jpg')->pluck('file_name');
    });
});

输出结果为：

1
2
wallpaper
fruit

另一方面，如果我们像这样使用上面的代码：

1
2
3
4
5
6
return collect($photos)
    ->where('validated', true)
    ->tap(function ($validated) {
        return $validated->where('extension', 'jpg')->pluck('file_name');
    });
});

它将返回验证设置为true的所有照片数组。

结果为：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
0: {
    file_name: "wallpaper",
    validated: true,
    extension: "jpg"
},
1: {
    file_name: "spring",
    validated: true,
    extension: "png"
},
3: {
    file_name: "mac",
    validated: true,
    extension: "png"
},
7: {
    file_name: "fruit",
    validated: true,
    extension: "jpg"
}

1
2
3
4
$user = User::find(1);
$data = [...];
$user->update($data);
$user->notify();

如果用tap，可以：

1
tap(User::find(1))->update($data)->notify();

写起来更简洁。

执行中间操作

从一个简单的例子开始，提取Laravel的AuthenticateSession@handle()的一些代码：

1
2
3
4
5
$response = $next($request);
 
$this->storePasswordHashInSession($request);
 
return $response;

使用tap()帮助函数：

1
2
3
return tap($next($request), function () use ($request) {
    $this->storePasswordHashInSession($request);
});

另外的一个简单的例子，让我们看看Illuminate\Cache\Repository下的pull方法，此函数将从指定键的缓存中获取值，并将其删除。pull方法的实现：

1
2
3
4
5
6
7
8
public function pull($key, $default = null)
{
   $value = $this->get($key, $default);

   $this->forget($key) // returns a boolean;

   return $value;
}

上面的例子中，$this->forget()返回一个布尔值，所以要使我们的函数返回原始值，需要将其储存到临时变量$value中。以下是tap()的实现，不再需要临时变量：

1
2
3
4
5
6
public function pull($key, $default = null)
{
   return tap($this->get($key, $default), function ($value) use ($key) {
      $this->forget($key);
   });
}

恢复状态

Eloquent的create和update方法支持[‘timestamps’=>false]选项。如果这被实现成链式方法，结果的可读性会更好。

1
2
3
4
5
6
7
8
9
10
11
12
// Method defined in App\Model that App\Message extends.
public function keepingTimestamps(callable $callback)
{
    try {
        $timestamps = $this->timestamps;
        $this->timestamps = false;
 
        return tap($this, $callback);
    } finally {
        $this->timestamps = $timestamps;
    }
}

现在Message模型可以链式使用以上的方法：

1
2
3
request()->user()->latestMessage->keepingTimestamps(function ($message) {
    $message->markRead(); // updates a 'read_at' timestamp instead
}); // returns the latestMessage

如果你写的代码有DB::transaction()相同的模式，你可以在Laravel 5.4使用tap() 帮助函数重写。

Collection

Laravel 5.4中也可以在Collection类中使用tap()方法。你可以在任何地方使用，而不需要破坏链式。对于Laravel 5.3及更早的版本，你只需要复制粘贴五行代码的方法作为Collection macro到你项目的AppServiceProvider@boot()即可。

这里有一个例子，用于Laravel网站支持英语和法语。取代月份的语言翻译文件，使用Carbon列出一年每个月份的<option>。因此这个模型的修饰方法：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
public function monthOptions()
{
    return collect(range(1, 12))
        ->keyByValue() // custom Collection macro
        ->tap(function () {
            if (App::getLocale() === 'fr') {
                setlocale(LC_TIME, 'fr_CA');
            }
        })
        ->map(function ($month) {
            return sprintf('%02d - %s', $month,
                Carbon::now()->month($month)->formatLocalized('%B'));
        })
        ->tap(function () {
            if (App::getLocale() === 'fr') {
                setlocale(LC_TIME, '');
            }
        });
}

对于更多的语言支持，设置/恢复状态将提取到其他方法，使其更加可读。

使用Collection tap()处理控制台命令进度条

这是在集合中最典型的用例。你甚至可以在handle()处理过程中保持其方法链。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
public function handle()
{
    Club::findOrFail($this->option('club'))
        ->members()
        ->subscribed()
        ->get()
        ->tap(function ($members) {
            $this->output->progressStart($members->count());
        })
        ->each(function ($member) {
            Mail::to($member)->queue(new Newsletter($member, $this->matchReport());
 
            $this->output->progressAdvance();
        })
        ->tap(function () {
            $this->output->progressFinish();
        });
}
 
public function matchReport()
{
     return once(function () {
          return MatchReport::ofRound($this->option('round'))->firstOrFail();
     });
}

0%