如何在您的应用程序中找到最慢的查询

您的网站加载慢吗？是否需要很长时间才能加载？用户是否抱怨它几乎无法使用？您应该检查您的数据库查询。接下来我将向您展示一种轻松分析所有数据库查询的巧妙方法。

当然，您的网站可能由于许多原因而运行缓慢，但最常见的原因之一是缓慢的数据库查询。

但在Laravel中，我们通常不使用SQL（大多数情况下）从数据库中获取数据，而是使用Laravel的Eloquent ORM和查询生成器，这有时会使我们难以识别导致网站变慢的查询。

DB::listen()

幸运的是，在Laravel中，我们可以定义一个回调，每当执行一个查询时就会被调用（请参阅这里）。为此，请将以下代码添加到任何服务提供者中（例如AppServiceProvider）

    public function boot()
    {
        DB::listen(function ($query) {
            // TODO: make this useful
        });
    }

正如您所看到的，我们接收了一个变量 $query，这个变量是QueryExecuted类的实例。这意味着我们可以访问有关执行查询的一些信息

        DB::listen(function ($query) {
            $query->sql; // the sql string that was executed
            $query->bindings; // the parameters passed to the sql query (this replace the '?'s in the sql string)
            $query->time; // the time it took for the query to execute;
        });

这是一些非常有用的信息，现在我们有了根据查询的$query->time属性来识别慢查询的方法。但是，这并没有告诉我们查询在哪里执行。

我如何知道查询是在哪里执行的？

尽管变量 $query 并没有提供任何关于 查询来源 的信息，但我们可以使用 PHP 内置函数 debug_backtrace() 来获取这些信息。

        DB::listen(function ($query) {
            dd(debug_backtrace());
        });

如果您在项目中运行此代码，您将在浏览器中看到类似以下内容

array:63 [▼
  0 => array:7 [▼
    "file" => "/home/cosme/Documents/projects/cosme.dev/vendor/laravel/framework/src/Illuminate/Events/Dispatcher.php"
    "line" => 404
    "function" => "App\Providers\{closure}"
    "class" => "App\Providers\AppServiceProvider"
    "object" => App\Providers\AppServiceProvider {#140 ▶}
    "type" => "->"
    "args" => array:1 [▶]
  ]
  1 => array:7 [▼
    "file" => "/home/cosme/Documents/projects/cosme.dev/vendor/laravel/framework/src/Illuminate/Events/Dispatcher.php"
    "line" => 249
    "function" => "Illuminate\Events\{closure}"
    "class" => "Illuminate\Events\Dispatcher"
    "object" => Illuminate\Events\Dispatcher {#27 ▶}
    "type" => "->"
    "args" => array:2 [▶]
  ]
  2 => array:7 [▼
    "file" => "/home/cosme/Documents/projects/cosme.dev/vendor/laravel/framework/src/Illuminate/Database/Connection.php"
    "line" => 887
    "function" => "dispatch"
    "class" => "Illuminate\Events\Dispatcher"
    "object" => Illuminate\Events\Dispatcher {#27 ▶}
    "type" => "->"
    "args" => array:1 [▶]
  ]
  ....

这是一个包含从现在起所有函数调用的数组。我将只关注每个数组中的 file 和 line 键。

如果您仔细观察，您会发现我的例子中有63个函数调用，这可以被认为是相当多的，而且这是一个简单的应用程序，在更复杂的应用程序中可能会有更多。更糟糕的是，如果您查看最上面的那些，它们都是 laravel 框架的内部函数。我们是应该查看每个函数，直到找到可能对我们有所帮助的东西吗？

查找查询位置

就像我之前说的那样，大部分都是内部框架调用，这意味着这些文件大多数都位于我们的 vendor/ 目录中。这意味着我们可以检查每个 file 并过滤掉任何具有 vendor/ 的调用，如下所示

        DB::listen(function ($query) {
            $stackTrace = collect(debug_backtrace())->filter(function ($trace) {
                return !str_contains($trace['file'], 'vendor/');
            });
            
            dd($stackTrace);
        });

在这里，我将数组转换为收集以使用 filter 方法，如果当前 $trace 的 file 中有 vendor/，就从收集中移除它。

如果您运行上述代码，您将看到如下内容

Illuminate\Support\Collection {#1237 ▼
  #items: array:5 [▼
    12 => array:7 [▼
      "file" => "/home/cosme/Documents/projects/cosme.dev/app/Models/Post.php"
      "line" => 61
      "function" => "get"
      "class" => "Illuminate\Database\Eloquent\Builder"
      "object" => Illuminate\Database\Eloquent\Builder {#310 ▶}
      "type" => "->"
      "args" => []
    ]
    16 => array:6 [▶]
    17 => array:6 [▶]
    61 => array:7 [▶]
    62 => array:4 [▶]
  ]
  #escapeWhenCastingToString: false
}

这些项很少，我们从63减少到只有5。最好的部分是，收集中的第一项正是我们触发 SQL 查询的确切位置。这意味着我们可以提取这些信息来找到最慢的查询。

整合一切

现在我们已经有了所有需要的信息，为什么不将其记录下来以便我们可以查看并找到最慢的查询呢？


    public function boot()
    {
        DB::listen(function ($query) {
            $location = collect(debug_backtrace())->filter(function ($trace) {
                return !str_contains($trace['file'], 'vendor/');
            })->first(); // grab the first element of non vendor/ calls

            $bindings = implode(", ", $query->bindings); // format the bindings as string

            Log::info("
                   ------------
                   Sql: $query->sql
                   Bindings: $bindings
                   Time: $query->time
                   File: ${location['file']}
                   Line: ${location['line']}
                   ------------
            ");
        });
    }

如果您在您的应用程序中使用此功能，您可以在日志文件中查看查询信息，如下所示

[2022-02-03 02:20:14] local.INFO:
                    ------------
                    Sql: select "title", "slug", "body" from "posts" where "published" = ? order by "id" desc   
                    Bindings: 1
                    Time: 0.18
                    File: /home/cosme/Documents/projects/cosme.dev/app/Models/Post.php
                    Line: 61
                    ----------

现在您知道了哪些查询是最慢的，并开始逐个解决，尝试使其更快，至少将其缓存起来。