中文(繁體)
中文(繁體)
在進行數據庫相關的單元測試時，有時我們需要深入了解到底發生了什麼操作，尤其是當測試失敗且涉及復雜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
