Laravel Eloquent：获取模型查询生成的 SQL 语句 1 个改进

我们有时候想测试一段代码生产的 SQL 语句，比如: 我们想看 App\User::all(); 产生的 SQL 语句，我们简单地使用路由闭包做个实验：

Route::get('/test-sql', function() {

    DB::enableQueryLog();

    $user = App\User::all();

    return response()->json(DB::getQueryLog());
});

然后我们在浏览器打开 http://www.example.com/test-sql 即可看到 $user = User::all(); 所产生的 SQL 了。

[
    {
        query: "select * from `users` where `users`.`deleted_at` is null",
        bindings: [ ],
        time: 1.37
    }
]

如果需要经常查看 SQL 信息，推荐使用 clockwork 这个插件更友好的记录。

laravel eloquent database sql

本文为 Wiki 文章，邀您参与纠错、纰漏和优化改进本文

贡献者：

推荐文章：

更多推荐...

Laravel 11 中文文档仓库，已翻译完成！！！ 16 / 28 |

Laravel验证器最完整用法实例 31 / 14 |

PHP Annotated——2023 年 12 月 25 / 2 |

使用 Laravel 10 & Vue 3 开发了一个社区站，一起来玩下～ 17 / 39 |

历时一个月，《穿透Laravel》全书完成！ 88 / 25 |

[开源项目] 基于 laravel 开发的一个社区/社交小程序 23 / 47 |

讨论数量: 7

leoyang

1.0k 声望

    DB::enableQueryLog();

    if (class_exists(QueryExecuted::class, true)) {
        DB::listen(function ($queryExecuted) {
            $query = $queryExecuted->sql;
            $bindings = $queryExecuted->bindings;
            $spend = $queryExecuted->time;
            $db = $queryExecuted->connectionName;
            $i = 0;
            $message = sprintf(
                "query %s => %s ( %s ms )",
                $db,
                preg_replace_callback('/\?/', function ($matches) use ($bindings, &$i) {
                    if (! empty($bindings[$i])) {
                        return '\''.$bindings[$i++].'\'';
                    } else {
                        return '\''.'\'';
                    }

                }, $query),
                $spend
            );
            $tmp = ['sql' => $message, 'db' => $db, 'cost' => $spend]);
           var_dump($tmp);
        });
    } else {
        DB::listen(function ($query, $bindings, $spend, $db) {
            $i = 0;
            $message = sprintf(
                "query %s => %s ( %s ms )",
                $db,
                preg_replace_callback('/\?/', function ($matches) use ($bindings, &$i) {
                    if (! empty($bindings[$i])) {
                        return '\''.$bindings[$i++].'\'';
                    } else {
                        return '\''.'\'';
                    }

                }, $query),
                $spend
            );
           $tmp = ['sql' => $message, 'db' => $db, 'cost' => $spend]);
           var_dump($tmp);
        });
    }

5年前评论

IceBay

课程读者 124 声望

API 开发用这个包也很方便
https://github.com/overtrue/laravel-query-...

5年前评论

Tangqy

课程读者 31 声望

https://learnku.com/courses/laravel-packag...
这个比较好使用

5年前评论

Lingkong

33 声望

可以在中间件实现

class QueryLogMiddleware
{
    public function handle($request, Closure $next)
    {
        return $next($request);
    }

    /**
     * 程序发送响应之后的操作，记录慢查询日志或查询全日志
     *
     * @param Request $request
     * @param         $response
     */
    public function terminate(Request $request, $response)
    {
        $queryLogs = \DB::getQueryLog();
        if (empty($queryLogs)) {
            return;
        }

        $currentUrl = $request->fullUrl();

        $enableFullQueryLog = config('database.enableQueryLog');

        if ($enableFullQueryLog) {
            $this->writeFullQueryLog($queryLogs, $currentUrl);
        }

        $enableSlowQueryLog = config('database.enableSlowLog');

        if ($enableSlowQueryLog) {
            $this->slowQueryLog($queryLogs, $currentUrl);
        }

    }

    public function slowQueryLog(array $data, string $url)
    {
        //大于一秒
        $slow = array_filter($data, function ($value) {
            return $value['time'] > 1000;
        });
        $slow = $this->formatQueryString($slow);

        if (!empty($slow)) {
            \Log::error('found slow query', [
                'url'  => $url,
                'sqls' => $slow
            ]);
        }
        //todo DingTalk notify and throttle limit
    }

    /**
     * 写全查询log到文件
     *
     * @param array  $data
     * @param string $url
     */
    public function writeFullQueryLog(array $data, string $url)
    {
        $logs = json_encode($this->formatQueryString($data));

        $fileName = 'logs' . DIRECTORY_SEPARATOR . "query-" . date('Y-m-d') . '.log';
        $logFile = fopen(
            storage_path($fileName),
            'a+'
        );
        fwrite($logFile, date('Y-m-d H:i:s') . ': ' . $url . " | " . $logs . PHP_EOL);
        fclose($logFile);
    }

    /**
     * 拼接SQL字符串
     *
     * @param array $data
     *
     * @return array
     */
    public function formatQueryString(array $data)
    {
        return array_map(function ($value) {
            return [
                'time' => array_get($value, 'time') . 'ms',
                'sql'  => Str::replaceArray('?', array_get($value, 'bindings'), array_get($value, 'query'))
            ];
        }, $data);
    }
}

5年前评论

jltxwesley

课程读者 510 声望 / Software Engineer @ Sidekicker

补充下，如果想查看所有的 query，还可以使用监听查询事件：

DB::listen(function ($sql) { 
    var_dump($sql->sql, $sql->bindings, $query->time); 
});

5年前评论

sushengbuhuo

16 声望 / PHP工程师 @ 新浪

@leoyang QueryExecuted这个类哪个版本开始有的

还有能输出当前链接使用的ip和端口吗

5年前评论

leililei

课程读者 36 声望 / 软件开发工程师 @ 广州番禺某科技公司

使用helper str_replace_array()可以把SQL和binding结合成完整的SQL语句

5年前评论

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容，与人为善，比聪明更重要！

帮助