记一次对 Laravel-permission 项目的性能优化

我最近研究分析了在 SWIS上面创建的项目的性能。令人惊讶的是，最耗费性能的方法之一是优秀的  spatie/laravel-permission 包造成的。

经过查阅更多资料和研究，发现一个可能明显改善的性能问题 。既然解决方案已明确阐述，就很容易编写代码改善，提交请求。

现在这个解决方案已被合并和发布，下面是这个性能问题的分析和如何在自己的项目避免这类问题。

TL;DR: 跳转到结论部分.

性能瓶颈

如果我们抽象的看 spatie/laravel-permission 它主要做两件事：

1. 保持一个属于某个模型的权限清单。
2. 检查某个模型是否具有权限。

第一点说是性能瓶颈有点牵强。这里的权限数据存放在数据库中，需要的时候将会被读取出来。这个过程是有点慢但也只是执行一次。结果会被缓存下来，后续的请求可以直接使用。

第二点在性能瓶颈的观点上来看确实是一个瓶颈。 这个瓶颈取决于权限的性质和项目的大小， 因为权限会被频繁的检查。 在这个检查的过程中任何的迟钝都会成为整个项目的性能瓶颈。

过滤集合类

过滤权限集合的方法被认为是造成低性能的原因。 它做了如下事情：

$permission = $permissions
    ->where('id', $id)
    ->where('guard_name', $guardName)
    ->first();

修改后：

$permission = $permissions
    ->filter(function ($permission) use ($id, $guardName) {
        return $permission->id === $id && $permission->guard_name === $guardName;
    })
    ->first();

这两个代码段实现了同一件事情，但第二个更快。

性能测试

我正在开发的应用中大约有 150 个不同的权限。 在一个普通的请求中， 大约有 50 个权限需要用  hasPermissionTo 这个方法去检查，当然，有些页面可能需要检查大约 200 个权限。

以下是用来做性能测试的一些设置。

$users = factory(User::class, 150)->make();
$searchForTheseUsers = $users->shuffle()->take(50);

# 方法 1: where
foreach($searchForTheseUsers as $user) {
    $result = $users->where('id', '=', $user->id)->first();
}

# 方法 2: 过滤，传递一个模型作为回调
foreach($searchForTheseUsers as $searchUser) {
    $result = $users->filter(function($user) use ($searchUser) {
        return $user->id === $searchUser->id;
    })->first();
}

# 方法 3: 过滤，传递属性作为回调
foreach($searchForTheseUsers as $user) {
    $searchId = $user->id;
    $result = $users->filter(function($user) use ($searchId) {
        return $user->id === $searchId;
    })->first();
}

以上三个方法都会被用来测试过滤 1 个属性，2 个属性，3 个属性，所以，用方法 1 过滤三个属性就会是这样：

foreach($searchForTheseUsers as $user) {
    $result = $users
        ->where('id', '=', $user->id)
        ->where('firstname', '=', $user->firstname)
        ->where('lastname', '=', $user->lastname)->first();
}

结果

	方法 #1	方法 #2	方法 #3
1个属性	0.190	0.139 (-27%)	0.072 (-62%)
2个属性	0.499	0.372 (-25%)	0.196 (-61%)
3个属性	0.488	0.603 (+25%)	0.198 (-59%)

结论

我们可以得出结论：对一个项目而言，重复的过滤一个大集合会引发严重性能瓶颈。

多属性的过滤明显增加计算成本。

使用 Collection::filter() 代替 Collection::where() 可以提高60%的性能。

警告：传递完整的模型给过滤器回调是很耗费性能的，最好是传递单独的属性。

致谢

感谢 Spatie 和 spatie/laravel-permissions 的贡献者创建如此优秀的包，我非常喜欢使用！感谢 Andru Beldie 指出这些性能问题，我才有机会对其进行调查和纠正。

链接

• spatie/laravel-permission package.
• Issue #550 addressing performance problem.
• Pull request #710 that fixes problems.

更多现代化 PHP 知识，请前往 Laravel / PHP 知识社区