2.6 PhalApi 打印和保存SQL语句

发布网友发布时间：2024-09-26 09:51

共1个回答

热心网友时间：2024-10-02 08:53

本文将深入探讨SQL语句的在线调试打印与文件记录，这一技能在日常开发与线上问题排查中极为重要，是项目开发中的常见需求。

PhalApi 的调试模式在初期仅有一个全局开关，实现简单，但为适应更精细的场景需求，在2.7.0版本后，新增了NotORM专用调试开关 `sys.notorm_debug` 与 SQL 日志开关 `sys.enable_sql_log`。这些开关的组合应用，能够为开发人员提供不同级别的调试与日志记录选项：

开启 `sys.debug`、`sys.notorm_debug`、`sys.enable_sql_log`：适用于后端自测与开发，全面调试模式，可直接查看接口返回的 SQL 语句与日志文件中的记录。
开启 `sys.notorm_debug`、`sys.enable_sql_log`：适用于生产环境或测试环境，客户端不显示调试信息，仅在运行时的日志文件中记录 SQL 语句。
关闭所有开关：适用于生产环境，不进行调试，也不记录 SQL 语句。

在开启调试模式后，无论接口响应正常或异常，用户可在 `debug.sqls` 字段查看本次执行的全部 SQL 语句。调试信息格式自动统计，以时间、SQL 语句及参数等信息呈现。

PhalApi 2.7.0 版本后，调试 SQL 语句升级，提供更多详细信息。用户可通过请求特定示例接口（如 `App.Examples_CURD.SqlDebug`）并开启调试模式，获取详细接口执行过程中的 SQL 语句。

SQL 语句被实时打印到控制台，便于现场查看。若需在生产环境或测试环境查看历史执行记录，可将 SQL 语句记录至日志文件。仅需开启 `sys.notorm_debug` 与 `sys.enable_sql_log`，即可实现此功能。

日志文件记录内容包括所有执行的 SQL 语句，为线上或测试环境中的问题排查提供了重要依据。在日志文件中查找特定 SQL 语句，有助于分析问题原因。

为了满足更多个性化需求，用户可自定义 SQL 记录方式。通过扩展 PhalApi 的全球追踪器 PhalApi\Helper\Tracer，实现 SQL 存储到日志文件外的其他位置，或对慢日志进行报警等功能。

实现这一功能，首先需在项目中创建自定义追踪器类文件（例如 `Commom/Tracer.php`），并在 `di.php` 文件中重新注册追踪器服务。这样，根据特定需求调整 SQL 记录与处理逻辑，为开发者提供了高度灵活性。