在laravel框架中快速定位慢查询的流程步骤

Laravel  /  管理员 发布于 3年前   1039

你的网站慢吗？ 加载需要很长时间吗？ 用户是否抱怨它几乎无法使用？ 

您应该检查您的数据库查询。 

我将向您展示一种轻松分析所有数据库查询的简洁方法。

当然，您的网站速度慢的原因有很多，但最常见的原因之一是数据库查询速度慢。

但是在 laravel 中，我们（大多数时候）不使用 SQL 从数据库中获取数据，我们使用 laravel 雄辩的 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 变量没有给我们任何关于 $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 [▶]
  ]
  ....

这是一个数组，其中包含请求中到目前为止的每个函数调用。 

我将只关注每个数组中的文件和行键。

如果你仔细看，你会发现在我的例子中有 63 个函数调用，可以考虑很多，这是一个简单的应用程序，在更复杂的应用程序中，可能会更多。

 更糟糕的是，如果您查看顶部的那些，它们都是 laravel 框架的内部函数。 

我们是否应该逐一查看，直到找到可能对我们有帮助的东西？

查找查询位置

正如我之前所说，它们中的大多数都是内部框架调用，这意味着这些文件中的大多数都在我们的 vendor/ 目录中。

 这意味着我们可以检查每个文件并过滤掉任何具有 vendor/ 的调用，如下所示：

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

在这里，我将数组转换为集合以使用过滤器方法，如果当前 $trace 的文件具有 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
                    ----------

现在您知道哪些查询是最慢的，并开始一一处理它们，尝试使它们更快，或者至少缓存它们。

扩展调试

这对于调试非常有用，但这种技术可以以多种方式使用。

您可以创建显示一周中最慢查询的每周报告。

如果查询超过时间阈值，您可能会收到松弛警报

您可以创建一个仪表板，您和您的团队可以在其中查看执行的每个查询

天空才是极限。

转：

https://dev.to/cosmeoes/how-to-find-the-slowest-query-in-your-application-4igb