如何在使用 Eloquent ORM 时记录失败的数据库查询

星瑶大大_8994

星瑶大大_8994

2026-06-13

623人浏览

原创

如何在使用 Eloquent ORM 时记录失败的数据库查询

Eloquent 默认的 listen() 机制仅捕获成功执行的 SQL 查询,无法捕获抛出异常的失败查询;本文详解通过 Laravel/Illuminate 的异常处理机制、DB 事件监听与自定义异常处理器,实现对所有失败查询(如语法错误、连接超时、约束冲突等)的完整日志记录。

eloquent 默认的 `listen()` 机制仅捕获成功执行的 sql 查询,无法捕获抛出异常的失败查询;本文详解通过 laravel/illuminate 的异常处理机制、db 事件监听与自定义异常处理器,实现对所有失败查询(如语法错误、连接超时、约束冲突等)的完整日志记录。

在 Slim + Eloquent 架构中,$connection->listen() 确实只触发于查询成功完成后(即 PDO 执行无异常),因此当 SQL 语法错误、外键冲突、连接中断或超时时,异常会直接向上抛出,listen 回调根本不会执行——这正是你遇到的问题根源。

要真正捕获失败查询,需从异常源头介入。推荐采用以下双重保障方案:

✅ 方案一:全局异常处理器 + 查询上下文捕获(推荐)

在 Slim 中注册自定义异常处理器,并结合 DB::enableQueryLog()(仅开发环境)或 DB::pretend()(调试用)辅助定位,但更健壮的方式是利用 Illuminate 的 Connection 异常钩子:

laravel-specialist
laravel-specialist

精通 Laravel 10+,遵循现代 PHP 实践的 Laravel 专家。擅长优雅语法、Eloquent ORM、队列系统及企业级特性...

下载
use Illuminate\Database\Connection;
use Illuminate\Database\QueryException;
use Psr\Log\LoggerInterface;

// 在初始化 Eloquent 后,为每个连接注册异常监听
$capsule->getConnection()->getPdo()->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION);

// 拦截 QueryException(最常见失败类型)
$capsule->getConnection()->setExceptionHandler(function (QueryException $e) use ($headers, $logger) {
    $sql = $e->getSql() ?: 'Unknown query';
    $bindings = $e->getBindings() ?: [];

    $logData = [
        'page'         => $_SERVER['SERVER_NAME'] . $_SERVER['PHP_SELF'],
        'query'        => $sql,
        'bindings'     => json_encode($bindings),
        'user_id'      => $headers[HeaderKey::USER_ID] ?? null,
        'ip_address'   => $headers[HeaderKey::IP_ADDRESS] ?? null,
        'sys_key'      => $headers[HeaderKey::SYS_KEY] ?? null,
        'error_message'=> $e->getMessage(),
        'error_code'   => $e->getCode(),
        'db_name'      => $e->getDatabaseName() ?? $capsule->getConnection()->getDatabaseName(),
        'db_host'      => $capsule->getConnection()->getConfig('host'),
        'db_user'      => $capsule->getConnection()->getConfig('username'),
        'timestamp'    => date('Y-m-d H:i:s'),
    ];

    // 写入日志表(建议使用异步或队列避免阻塞主流程)
    $tableName = "`SysDbLog_" . date('Y-m-d') . "`";
    DB::connection('logdb')->insert(
        "INSERT DELAYED INTO $tableName 
         (page, query, SerializedParam, UserID, IPAddress, SysCode, ErrorMessage, ErrorCode, DBName, DBUser, DBHost, WebServer, CreatedAt) 
         VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, INET_ATON(SUBSTRING_INDEX(SUBSTRING_INDEX(USER(), '@', 2), '@', -1)), ?)",
        [
            $logData['page'],
            $logData['query'],
            json_encode($logData['bindings']),
            $logData['user_id'],
            $logData['ip_address'],
            $logData['sys_key'],
            $logData['error_message'],
            $logData['error_code'],
            $logData['db_name'],
            $logData['db_user'],
            $logData['timestamp']
        ]
    );

    // 同时写入 PSR-3 日志(便于集中监控)
    $logger->error('Eloquent Query Failed', $logData);
});

⚠️ 注意:setExceptionHandler() 是 Illuminate v9+ 提供的方法;若使用较旧版本(如 v5.8–v8),需改用 try/catch 包裹关键查询,或监听 illuminate.database.query.failed 事件(需启用事件系统)。

✅ 方案二:启用数据库查询事件(Laravel ≥ 9.26+)

若项目已集成 Laravel Event Dispatcher,可监听原生失败事件:

use Illuminate\Database\Events\QueryExecuted;
use Illuminate\Database\Events\QueryFailed;

// 注册失败事件监听器(需在服务提供者或启动脚本中)
Event::listen(QueryFailed::class, function (QueryFailed $event) use ($headers) {
    $values = [
        $_SERVER['SERVER_NAME'] . $_SERVER['PHP_SELF'],
        $event->sql,
        json_encode($event->bindings),
        $headers[HeaderKey::USER_ID] ?? null,
        $headers[HeaderKey::IP_ADDRESS] ?? null,
        $headers[HeaderKey::SYS_KEY] ?? null,
        $event->exception->getMessage(),
        $event->connection->getDatabaseName(),
        $event->connection->getConfig('username'),
        $event->connection->getConfig('host'),
        date('Y-m-d H:i:s')
    ];

    $t = "`SysDbLog_" . date('Y-m-d') . "`";
    DB::connection('logdb')->insert(
        "INSERT DELAYED INTO $t (page,query,SerializedParam,UserID,IPAddress,SysCode,ErrorMessage,DBName,DBUser,DBHost,CreatedAt) VALUES (?,?,?,?,?,?,?,?,?,?,?)",
        $values
    );
});

? 关键注意事项

  • 性能与可靠性:INSERT DELAYED 仅适用于 MyISAM 表,MySQL 8.0+ 已弃用;生产环境建议改用 INSERT IGNORE 或异步消息队列(如 Redis Queue + Worker)写日志,避免日志写入失败导致主业务中断。
  • 敏感数据脱敏:$query->bindings 可能含密码、token 等,记录前务必过滤(如正则替换 'password' => '***')。
  • 表结构兼容性:确保 SysDbLog_YYYY-MM-DD 表存在且字段类型匹配(如 ErrorMessage 建议 TEXT,CreatedAt 为 DATETIME)。
  • 连接配置复用:logdb 连接应独立配置,避免与主库共用连接池导致雪崩。

通过上述任一方案,即可全面覆盖 QueryException、PDOException、TimeoutException 等所有数据库层失败场景,真正实现“失败即可见”,大幅提升线上问题排查效率。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

laravel

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

11084

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

6441

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2155

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

4068

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4794

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3751

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

5397

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

4222

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

12122

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
如何安装 Composer
如何安装 Composer

共1课时 | 208人学习

Composer手册
Composer手册

共0课时 | 0人学习