简体中文
简体中文
在进行数据库相关的单元测试时，有时我们需要深入了解到底发生了什么操作，尤其是当测试失败且涉及复杂 SQL 操作时。PHP 的 mysqli 扩展提供了一个非常实用的调试函数 mysqli::debug()，可以将底层操作日志输出到一个文件中。本文将介绍如何在使用 PHPUnit 进行测试时，结合 mysqli::debug() 来实现数据库操作的调试功能。
mysqli::debug(string $debug_options) 是 mysqli 类中的一个方法，可以用于启用客户端的调试日志。它的参数是一个字符串，描述调试信息的配置方式，比如输出的文件路径和日志级别等。需要注意的是，它不会自动启用日志记录，还需要在 MySQL 服务器的编译选项中支持调试功能。
mysqli::debug("d:t:o,/tmp/client.trace");
其中：
d 代表调试
t 代表包含线程信息
o 表示输出到文件
/tmp/client.trace 是日志文件的路径
当你使用 PHPUnit 进行数据库相关的测试时，可以在测试的 setUp() 或 setUpBeforeClass() 方法中启用调试功能。这样，每次测试运行时都会记录调试信息，帮助你追踪数据库操作。
以下是一个实际的示例：
use PHPUnit\Framework\TestCase;
class DatabaseTest extends TestCase
{
private static $mysqli;
public static function setUpBeforeClass(): void
{
// 启用调试输出
mysqli::debug("d:t:o,/tmp/php-mysqli-debug.log");
self::$mysqli = new mysqli("localhost", "user", "password", "testdb");
if (self::$mysqli->connect_error) {
die("连接失败: " . self::$mysqli->connect_error);
}
}
public function testInsertData()
{
$stmt = self::$mysqli->prepare("INSERT INTO users (name, email) VALUES (?, ?)");
$stmt->bind_param("ss", $name, $email);
$name = "测试用户";
$email = "test@m66.net";
$this->assertTrue($stmt->execute());
}
public static function tearDownAfterClass(): void
{
self::$mysqli->close();
}
}
日志文件权限：确保 PHP 有权限写入指定的日志文件路径，例如 /tmp/php-mysqli-debug.log。
生产环境谨慎使用：mysqli::debug() 主要用于开发和调试阶段，不建议在生产环境中启用，避免泄露敏感信息。
调试文件内容较多：调试文件可能会迅速变得很大，尤其是运行大量数据库测试时，请合理规划文件路径和定期清理日志。
打开 /tmp/php-mysqli-debug.log 文件后，你将看到详细的调试信息，包括：
每个连接的建立和关闭
查询语句的执行情况
参数绑定与执行流程
线程信息等
这些信息可以帮助你更清晰地了解你的 PHP 程序是如何与 MySQL 通信的，尤其是在测试失败时定位问题非常有用。
将 mysqli::debug() 与 PHPUnit 结合使用，是一种非常实用的调试手段，特别是在开发数据库驱动、ORM、或进行集成测试时。如果你经常在进行数据库相关的测试调试，不妨尝试一下这一方法，它能帮你节省大量排查问题的时间。
如需了解更多关于 mysqli::debug() 的用法，请参考 PHP 官方文档：https://www.php.net/manual/zh/mysqli.debug.php
